imagine.fields.hamx package

Submodules

imagine.fields.hamx.breg_lsa module

class imagine.fields.hamx.breg_lsa.BregLSA(*args, **kwargs)

Bases: imagine.fields.base_fields.DummyField

This dummy field instructs the Hammurabi simulator class to use the HammurabiX’s builtin regular magnetic field WMAP-3yr LSA.

FIELD_CHECKLIST = {'b0': (['magneticfield', 'regular', 'lsa', 'b0'], 'value'), 'chi0': (['magneticfield', 'regular', 'lsa', 'chi0'], 'value'), 'psi0': (['magneticfield', 'regular', 'lsa', 'psi0'], 'value'), 'psi1': (['magneticfield', 'regular', 'lsa', 'psi1'], 'value')}

NAME = 'breg_lsa'

SIMULATOR_CONTROLLIST = {'cue': (['magneticfield', 'regular'], {'cue': '1'}), 'type': (['magneticfield', 'regular'], {'type': 'lsa'})}

class imagine.fields.hamx.breg_lsa.BregLSAFactory(field_class=None, active_parameters=(), default_parameters={}, priors={}, grid=None, boxsize=None, resolution=None, field_kwargs={})

Bases: imagine.fields.field_factory.FieldFactory

Field factory that produces the dummy field BregLSA (see its docs for details).

FIELD_CLASS

alias of BregLSA

DEFAULT_PARAMETERS = {'b0': 6.0, 'chi0': 25.0, 'psi0': 27.0, 'psi1': 0.9}

PRIORS = {'b0': <imagine.priors.basic_priors.FlatPrior object>, 'chi0': <imagine.priors.basic_priors.FlatPrior object>, 'psi0': <imagine.priors.basic_priors.FlatPrior object>, 'psi1': <imagine.priors.basic_priors.FlatPrior object>}

imagine.fields.hamx.brnd_es module

class imagine.fields.hamx.brnd_es.BrndES(*args, grid_nx=None, grid_ny=None, grid_nz=None, **kwargs)

Bases: imagine.fields.base_fields.DummyField

This dummy field instructs the Hammurabi simulator class to use the HammurabiX’s builtin random magnetic field ES random GMF

set_grid_size(nx=None, ny=None, nz=None)

Changes the size of the grid used for the evaluation of the random field

FIELD_CHECKLIST = None

NAME = 'brnd_ES'

SIMULATOR_CONTROLLIST = None

field_checklist

Hammurabi XML locations of physical parameters

simulator_controllist

Hammurabi XML locations of logical parameters

class imagine.fields.hamx.brnd_es.BrndESFactory(*args, grid_nx=None, grid_ny=None, grid_nz=None, **kwargs)

Bases: imagine.fields.field_factory.FieldFactory

Field factory that produces the dummy field BrndES (see its docs for details).

FIELD_CLASS

alias of BrndES

DEFAULT_PARAMETERS = {'a0': 1.7, 'a1': 0, 'k0': 10, 'k1': 0.1, 'r0': 8, 'rho': 0.5, 'rms': 2, 'z0': 1}

PRIORS = {'a0': <imagine.priors.basic_priors.FlatPrior object>, 'a1': <imagine.priors.basic_priors.FlatPrior object>, 'k0': <imagine.priors.basic_priors.FlatPrior object>, 'k1': <imagine.priors.basic_priors.FlatPrior object>, 'r0': <imagine.priors.basic_priors.FlatPrior object>, 'rho': <imagine.priors.basic_priors.FlatPrior object>, 'rms': <imagine.priors.basic_priors.FlatPrior object>, 'z0': <imagine.priors.basic_priors.FlatPrior object>}

imagine.fields.hamx.cre_analytic module

class imagine.fields.hamx.cre_analytic.CREAna(*args, **kwargs)

Bases: imagine.fields.base_fields.DummyField

This dummy field instructs the Hammurabi simulator class to use the HammurabiX’s builtin analytic cosmic ray electron distribution

FIELD_CHECKLIST = {'E0': (['cre', 'analytic', 'E0'], 'value'), 'alpha': (['cre', 'analytic', 'alpha'], 'value'), 'beta': (['cre', 'analytic', 'beta'], 'value'), 'j0': (['cre', 'analytic', 'j0'], 'value'), 'r0': (['cre', 'analytic', 'r0'], 'value'), 'theta': (['cre', 'analytic', 'theta'], 'value'), 'z0': (['cre', 'analytic', 'z0'], 'value')}

NAME = 'cre_ana'

SIMULATOR_CONTROLLIST = {'cue': (['cre'], {'cue': '1'}), 'type': (['cre'], {'type': 'analytic'})}

class imagine.fields.hamx.cre_analytic.CREAnaFactory(field_class=None, active_parameters=(), default_parameters={}, priors={}, grid=None, boxsize=None, resolution=None, field_kwargs={})

Bases: imagine.fields.field_factory.FieldFactory

Field factory that produces the dummy field CREAna (see its docs for details).

FIELD_CLASS

alias of CREAna

DEFAULT_PARAMETERS = {'E0': 20.6, 'alpha': 3, 'beta': 0, 'j0': 0.0217, 'r0': 5, 'theta': 0, 'z0': 1}

PRIORS = {'E0': <imagine.priors.basic_priors.FlatPrior object>, 'alpha': <imagine.priors.basic_priors.FlatPrior object>, 'beta': <imagine.priors.basic_priors.FlatPrior object>, 'j0': <imagine.priors.basic_priors.FlatPrior object>, 'r0': <imagine.priors.basic_priors.FlatPrior object>, 'theta': <imagine.priors.basic_priors.FlatPrior object>, 'z0': <imagine.priors.basic_priors.FlatPrior object>}

imagine.fields.hamx.tereg_ymw16 module

class imagine.fields.hamx.tereg_ymw16.TEregYMW16(*args, **kwargs)

Bases: imagine.fields.base_fields.DummyField

This dummy field instructs the Hammurabi simulator class to use the HammurabiX’s thermal electron density model YMW16

FIELD_CHECKLIST = {}

NAME = 'tereg_ymw16'

SIMULATOR_CONTROLLIST = {'cue': (['thermalelectron', 'regular'], {'cue': '1'}), 'type': (['thermalelectron', 'regular'], {'type': 'ymw16'})}

class imagine.fields.hamx.tereg_ymw16.TEregYMW16Factory(field_class=None, active_parameters=(), default_parameters={}, priors={}, grid=None, boxsize=None, resolution=None, field_kwargs={})

Bases: imagine.fields.field_factory.FieldFactory

Field factory that produces the dummy field TEregYMW16 (see its docs for details).

FIELD_CLASS

alias of TEregYMW16

DEFAULT_PARAMETERS = {}

PRIORS = {}

Module contents

class imagine.fields.hamx.BregLSA(*args, **kwargs)

Bases: imagine.fields.base_fields.DummyField

This dummy field instructs the Hammurabi simulator class to use the HammurabiX’s builtin regular magnetic field WMAP-3yr LSA.

FIELD_CHECKLIST = {'b0': (['magneticfield', 'regular', 'lsa', 'b0'], 'value'), 'chi0': (['magneticfield', 'regular', 'lsa', 'chi0'], 'value'), 'psi0': (['magneticfield', 'regular', 'lsa', 'psi0'], 'value'), 'psi1': (['magneticfield', 'regular', 'lsa', 'psi1'], 'value')}

NAME = 'breg_lsa'

SIMULATOR_CONTROLLIST = {'cue': (['magneticfield', 'regular'], {'cue': '1'}), 'type': (['magneticfield', 'regular'], {'type': 'lsa'})}

class imagine.fields.hamx.BregLSAFactory(field_class=None, active_parameters=(), default_parameters={}, priors={}, grid=None, boxsize=None, resolution=None, field_kwargs={})

Bases: imagine.fields.field_factory.FieldFactory

Field factory that produces the dummy field BregLSA (see its docs for details).

FIELD_CLASS

alias of BregLSA

DEFAULT_PARAMETERS = {'b0': 6.0, 'chi0': 25.0, 'psi0': 27.0, 'psi1': 0.9}

PRIORS = {'b0': <imagine.priors.basic_priors.FlatPrior object>, 'chi0': <imagine.priors.basic_priors.FlatPrior object>, 'psi0': <imagine.priors.basic_priors.FlatPrior object>, 'psi1': <imagine.priors.basic_priors.FlatPrior object>}

class imagine.fields.hamx.BregJF12(*args, **kwargs)

Bases: imagine.fields.base_fields.DummyField

This dummy field instructs the Hammurabi simulator class to use the HammurabiX’s builtin regular magnetic field for the Jansson & Farrar model, https://ui.adsabs.harvard.edu/abs/2012ApJ…757…14J/abstract

FIELD_CHECKLIST = {'B0_X': (['magneticfield', 'regular', 'jf12', 'B0_X'], 'value'), 'Bn': (['magneticfield', 'regular', 'jf12', 'Bn'], 'value'), 'Bs': (['magneticfield', 'regular', 'jf12', 'Bs'], 'value'), 'Xtheta': (['magneticfield', 'regular', 'jf12', 'Xtheta'], 'value'), 'b_arm1': (['magneticfield', 'regular', 'jf12', 'b_arm1'], 'value'), 'b_arm2': (['magneticfield', 'regular', 'jf12', 'b_arm2'], 'value'), 'b_arm3': (['magneticfield', 'regular', 'jf12', 'b_arm3'], 'value'), 'b_arm4': (['magneticfield', 'regular', 'jf12', 'b_arm4'], 'value'), 'b_arm5': (['magneticfield', 'regular', 'jf12', 'b_arm5'], 'value'), 'b_arm6': (['magneticfield', 'regular', 'jf12', 'b_arm6'], 'value'), 'b_arm7': (['magneticfield', 'regular', 'jf12', 'b_arm7'], 'value'), 'b_ring': (['magneticfield', 'regular', 'jf12', 'b_ring'], 'value'), 'h_disk': (['magneticfield', 'regular', 'jf12', 'h_disk'], 'value'), 'r0_X': (['magneticfield', 'regular', 'jf12', 'r0_X'], 'value'), 'rn': (['magneticfield', 'regular', 'jf12', 'rn'], 'value'), 'rpc_X': (['magneticfield', 'regular', 'jf12', 'rpc_X'], 'value'), 'rs': (['magneticfield', 'regular', 'jf12', 'rs'], 'value'), 'w_disk': (['magneticfield', 'regular', 'jf12', 'w_disk'], 'value'), 'wh': (['magneticfield', 'regular', 'jf12', 'wh'], 'value'), 'z0': (['magneticfield', 'regular', 'jf12', 'z0'], 'value')}

NAME = 'breg_jf12'

SIMULATOR_CONTROLLIST = {'cue': (['magneticfield', 'regular'], {'cue': '1'}), 'type': (['magneticfield', 'regular'], {'type': 'jf12'})}

class imagine.fields.hamx.BregJF12Factory(field_class=None, active_parameters=(), default_parameters={}, priors={}, grid=None, boxsize=None, resolution=None, field_kwargs={})

Bases: imagine.fields.field_factory.FieldFactory

Field factory that produces the dummy field BregJF12 (see its docs for details).

FIELD_CLASS

alias of BregJF12

DEFAULT_PARAMETERS = {'B0_X': 4.6, 'Bn': 1.4, 'Bs': -1.1, 'Xtheta': 49, 'b_arm1': 0.1, 'b_arm2': 3.0, 'b_arm3': -0.9, 'b_arm4': -0.8, 'b_arm5': -2.0, 'b_arm6': -4.2, 'b_arm7': 0.0, 'b_ring': 0.1, 'h_disk': 0.4, 'r0_X': 2.9, 'rn': 9.22, 'rpc_X': 4.8, 'rs': 16.7, 'w_disk': 0.27, 'wh': 0.2, 'z0': 5.3}

PRIORS = {'B0_X': <imagine.priors.basic_priors.FlatPrior object>, 'Bn': <imagine.priors.basic_priors.FlatPrior object>, 'Bs': <imagine.priors.basic_priors.FlatPrior object>, 'Xtheta': <imagine.priors.basic_priors.FlatPrior object>, 'b_arm1': <imagine.priors.basic_priors.FlatPrior object>, 'b_arm2': <imagine.priors.basic_priors.FlatPrior object>, 'b_arm3': <imagine.priors.basic_priors.FlatPrior object>, 'b_arm4': <imagine.priors.basic_priors.FlatPrior object>, 'b_arm5': <imagine.priors.basic_priors.FlatPrior object>, 'b_arm6': <imagine.priors.basic_priors.FlatPrior object>, 'b_arm7': <imagine.priors.basic_priors.FlatPrior object>, 'b_ring': <imagine.priors.basic_priors.FlatPrior object>, 'h_disk': <imagine.priors.basic_priors.FlatPrior object>, 'r0_X': <imagine.priors.basic_priors.FlatPrior object>, 'rn': <imagine.priors.basic_priors.FlatPrior object>, 'rpc_X': <imagine.priors.basic_priors.FlatPrior object>, 'rs': <imagine.priors.basic_priors.FlatPrior object>, 'w_disk': <imagine.priors.basic_priors.FlatPrior object>, 'wh': <imagine.priors.basic_priors.FlatPrior object>, 'z0': <imagine.priors.basic_priors.FlatPrior object>}

class imagine.fields.hamx.BrndES(*args, grid_nx=None, grid_ny=None, grid_nz=None, **kwargs)

Bases: imagine.fields.base_fields.DummyField

This dummy field instructs the Hammurabi simulator class to use the HammurabiX’s builtin random magnetic field ES random GMF

set_grid_size(nx=None, ny=None, nz=None)

Changes the size of the grid used for the evaluation of the random field

FIELD_CHECKLIST = None

NAME = 'brnd_ES'

SIMULATOR_CONTROLLIST = None

field_checklist

Hammurabi XML locations of physical parameters

simulator_controllist

Hammurabi XML locations of logical parameters

class imagine.fields.hamx.BrndESFactory(*args, grid_nx=None, grid_ny=None, grid_nz=None, **kwargs)

Bases: imagine.fields.field_factory.FieldFactory

Field factory that produces the dummy field BrndES (see its docs for details).

FIELD_CLASS

alias of BrndES

DEFAULT_PARAMETERS = {'a0': 1.7, 'a1': 0, 'k0': 10, 'k1': 0.1, 'r0': 8, 'rho': 0.5, 'rms': 2, 'z0': 1}

PRIORS = {'a0': <imagine.priors.basic_priors.FlatPrior object>, 'a1': <imagine.priors.basic_priors.FlatPrior object>, 'k0': <imagine.priors.basic_priors.FlatPrior object>, 'k1': <imagine.priors.basic_priors.FlatPrior object>, 'r0': <imagine.priors.basic_priors.FlatPrior object>, 'rho': <imagine.priors.basic_priors.FlatPrior object>, 'rms': <imagine.priors.basic_priors.FlatPrior object>, 'z0': <imagine.priors.basic_priors.FlatPrior object>}

class imagine.fields.hamx.BrndJF12(*args, **kwargs)

Bases: imagine.fields.base_fields.DummyField

This dummy field instructs the Hammurabi simulator class to use the HammurabiX’s builtin random magnetic field for the Jansson & Farrar model, https://ui.adsabs.harvard.edu/abs/2012ApJ…761L..11J/abstract

FIELD_CHECKLIST = {'a0': (['magneticfield', 'random', 'global', 'jf12', 'a0'], 'value'), 'a1': (['magneticfield', 'random', 'global', 'jf12', 'a1'], 'value'), 'b0_1': (['magneticfield', 'random', 'global', 'jf12', 'b0_1'], 'value'), 'b0_2': (['magneticfield', 'random', 'global', 'jf12', 'b0_2'], 'value'), 'b0_3': (['magneticfield', 'random', 'global', 'jf12', 'b0_3'], 'value'), 'b0_4': (['magneticfield', 'random', 'global', 'jf12', 'b0_4'], 'value'), 'b0_5': (['magneticfield', 'random', 'global', 'jf12', 'b0_5'], 'value'), 'b0_6': (['magneticfield', 'random', 'global', 'jf12', 'b0_6'], 'value'), 'b0_7': (['magneticfield', 'random', 'global', 'jf12', 'b0_7'], 'value'), 'b0_8': (['magneticfield', 'random', 'global', 'jf12', 'b0_8'], 'value'), 'b0_halo': (['magneticfield', 'random', 'global', 'jf12', 'b0_halo'], 'value'), 'b0_int': (['magneticfield', 'random', 'global', 'jf12', 'b0_int'], 'value'), 'k0': (['magneticfield', 'random', 'global', 'jf12', 'k0'], 'value'), 'k1': (['magneticfield', 'random', 'global', 'jf12', 'k1'], 'value'), 'r0_halo': (['magneticfield', 'random', 'global', 'jf12', 'r0_halo'], 'value'), 'random_seed': (['magneticfield', 'random'], 'seed'), 'rho': (['magneticfield', 'random', 'global', 'jf12', 'rho'], 'value'), 'rms': (['magneticfield', 'random', 'global', 'jf12', 'rms'], 'value'), 'z0_halo': (['magneticfield', 'random', 'global', 'jf12', 'z0_halo'], 'value'), 'z0_spiral': (['magneticfield', 'random', 'global', 'jf12', 'z0_spiral'], 'value')}

NAME = 'brnd_jf12'

SIMULATOR_CONTROLLIST = {'cue': (['magneticfield', 'random'], {'cue': '1'}), 'method': (['magneticfield', 'random', 'global'], {'type': 'jf12'}), 'type': (['magneticfield', 'random'], {'type': 'global'})}

class imagine.fields.hamx.BrndJF12Factory(field_class=None, active_parameters=(), default_parameters={}, priors={}, grid=None, boxsize=None, resolution=None, field_kwargs={})

Bases: imagine.fields.field_factory.FieldFactory

Field factory that produces the dummy field BrndJF12 (see its docs for details).

FIELD_CLASS

alias of BrndJF12

DEFAULT_PARAMETERS = {'a0': 1.7, 'a1': 0.0, 'b0_1': 10.81, 'b0_2': 6.96, 'b0_3': 9.59, 'b0_4': 6.96, 'b0_5': 1.96, 'b0_6': 16.34, 'b0_7': 37.29, 'b0_8': 10.35, 'b0_halo': 4.68, 'b0_int': 7.63, 'k0': 10.0, 'k1': 0.1, 'r0_halo': 10.97, 'rho': 1.0, 'rms': 1.0, 'z0_halo': 2.84, 'z0_spiral': 0.61}

PRIORS = {'a0': <imagine.priors.basic_priors.FlatPrior object>, 'a1': <imagine.priors.basic_priors.FlatPrior object>, 'b0_1': <imagine.priors.basic_priors.FlatPrior object>, 'b0_2': <imagine.priors.basic_priors.FlatPrior object>, 'b0_3': <imagine.priors.basic_priors.FlatPrior object>, 'b0_4': <imagine.priors.basic_priors.FlatPrior object>, 'b0_5': <imagine.priors.basic_priors.FlatPrior object>, 'b0_6': <imagine.priors.basic_priors.FlatPrior object>, 'b0_7': <imagine.priors.basic_priors.FlatPrior object>, 'b0_8': <imagine.priors.basic_priors.FlatPrior object>, 'b0_halo': <imagine.priors.basic_priors.FlatPrior object>, 'b0_int': <imagine.priors.basic_priors.FlatPrior object>, 'k0': <imagine.priors.basic_priors.FlatPrior object>, 'k1': <imagine.priors.basic_priors.FlatPrior object>, 'r0_halo': <imagine.priors.basic_priors.FlatPrior object>, 'rho': <imagine.priors.basic_priors.FlatPrior object>, 'rms': <imagine.priors.basic_priors.FlatPrior object>, 'z0_halo': <imagine.priors.basic_priors.FlatPrior object>, 'z0_spiral': <imagine.priors.basic_priors.FlatPrior object>}

class imagine.fields.hamx.CREAna(*args, **kwargs)

Bases: imagine.fields.base_fields.DummyField

This dummy field instructs the Hammurabi simulator class to use the HammurabiX’s builtin analytic cosmic ray electron distribution

FIELD_CHECKLIST = {'E0': (['cre', 'analytic', 'E0'], 'value'), 'alpha': (['cre', 'analytic', 'alpha'], 'value'), 'beta': (['cre', 'analytic', 'beta'], 'value'), 'j0': (['cre', 'analytic', 'j0'], 'value'), 'r0': (['cre', 'analytic', 'r0'], 'value'), 'theta': (['cre', 'analytic', 'theta'], 'value'), 'z0': (['cre', 'analytic', 'z0'], 'value')}

NAME = 'cre_ana'

SIMULATOR_CONTROLLIST = {'cue': (['cre'], {'cue': '1'}), 'type': (['cre'], {'type': 'analytic'})}

class imagine.fields.hamx.CREAnaFactory(field_class=None, active_parameters=(), default_parameters={}, priors={}, grid=None, boxsize=None, resolution=None, field_kwargs={})

Bases: imagine.fields.field_factory.FieldFactory

Field factory that produces the dummy field CREAna (see its docs for details).

FIELD_CLASS

alias of CREAna

DEFAULT_PARAMETERS = {'E0': 20.6, 'alpha': 3, 'beta': 0, 'j0': 0.0217, 'r0': 5, 'theta': 0, 'z0': 1}

PRIORS = {'E0': <imagine.priors.basic_priors.FlatPrior object>, 'alpha': <imagine.priors.basic_priors.FlatPrior object>, 'beta': <imagine.priors.basic_priors.FlatPrior object>, 'j0': <imagine.priors.basic_priors.FlatPrior object>, 'r0': <imagine.priors.basic_priors.FlatPrior object>, 'theta': <imagine.priors.basic_priors.FlatPrior object>, 'z0': <imagine.priors.basic_priors.FlatPrior object>}

class imagine.fields.hamx.TEregYMW16(*args, **kwargs)

Bases: imagine.fields.base_fields.DummyField

This dummy field instructs the Hammurabi simulator class to use the HammurabiX’s thermal electron density model YMW16

FIELD_CHECKLIST = {}

NAME = 'tereg_ymw16'

SIMULATOR_CONTROLLIST = {'cue': (['thermalelectron', 'regular'], {'cue': '1'}), 'type': (['thermalelectron', 'regular'], {'type': 'ymw16'})}

class imagine.fields.hamx.TEregYMW16Factory(field_class=None, active_parameters=(), default_parameters={}, priors={}, grid=None, boxsize=None, resolution=None, field_kwargs={})

Bases: imagine.fields.field_factory.FieldFactory

Field factory that produces the dummy field TEregYMW16 (see its docs for details).

FIELD_CLASS

alias of TEregYMW16

DEFAULT_PARAMETERS = {}

PRIORS = {}