imagine.fields.hamx package¶
Submodules¶
imagine.fields.hamx.breg_lsa module¶
-
class
imagine.fields.hamx.breg_lsa.
BregLSA
(*args, **kwargs)[source]¶ 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.-
NAME
= 'breg_lsa'¶
-
field_checklist
¶ Hammurabi XML locations of physical parameters
-
simulator_controllist
¶ Hammurabi XML locations of logical parameters
-
-
class
imagine.fields.hamx.breg_lsa.
BregLSAFactory
(*, grid=None, boxsize=None, resolution=None, active_parameters=(), field_kwargs={})[source]¶ Bases:
imagine.fields.field_factory.FieldFactory
Field factory that produces the dummy field
BregLSA
(see its docs for details).-
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)[source]¶ 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)[source]¶ Changes the size of the grid used for the evaluation of the random field
-
NAME
= 'breg_wmap'¶
-
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)[source]¶ Bases:
imagine.fields.field_factory.FieldFactory
Field factory that produces the dummy field
BrndES
(see its docs for details).-
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)[source]¶ 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-
NAME
= 'cre_ana'¶
-
field_checklist
¶ Hammurabi XML locations of physical parameters
-
simulator_controllist
¶ Hammurabi XML locations of logical parameters
-
-
class
imagine.fields.hamx.cre_analytic.
CREAnaFactory
(*, grid=None, boxsize=None, resolution=None, active_parameters=(), field_kwargs={})[source]¶ Bases:
imagine.fields.field_factory.FieldFactory
Field factory that produces the dummy field
CREAna
(see its docs for details).-
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)[source]¶ Bases:
imagine.fields.base_fields.DummyField
This dummy field instructs the
Hammurabi
simulator class to use the HammurabiX’s thermal electron density model YMW16-
NAME
= 'tereg_ymw16'¶
-
field_checklist
¶ Hammurabi XML locations of physical parameters
-
simulator_controllist
¶ Hammurabi XML locations of logical parameters
-
-
class
imagine.fields.hamx.tereg_ymw16.
TEregYMW16Factory
(*, grid=None, boxsize=None, resolution=None, active_parameters=(), field_kwargs={})[source]¶ 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)[source]¶ 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.-
NAME
= 'breg_lsa'¶
-
field_checklist
¶ Hammurabi XML locations of physical parameters
-
simulator_controllist
¶ Hammurabi XML locations of logical parameters
-
-
class
imagine.fields.hamx.
BregLSAFactory
(*, grid=None, boxsize=None, resolution=None, active_parameters=(), field_kwargs={})[source]¶ Bases:
imagine.fields.field_factory.FieldFactory
Field factory that produces the dummy field
BregLSA
(see its docs for details).-
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.
BrndES
(*args, grid_nx=None, grid_ny=None, grid_nz=None, **kwargs)[source]¶ 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)[source]¶ Changes the size of the grid used for the evaluation of the random field
-
NAME
= 'breg_wmap'¶
-
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)[source]¶ Bases:
imagine.fields.field_factory.FieldFactory
Field factory that produces the dummy field
BrndES
(see its docs for details).-
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.
CREAna
(*args, **kwargs)[source]¶ 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-
NAME
= 'cre_ana'¶
-
field_checklist
¶ Hammurabi XML locations of physical parameters
-
simulator_controllist
¶ Hammurabi XML locations of logical parameters
-
-
class
imagine.fields.hamx.
CREAnaFactory
(*, grid=None, boxsize=None, resolution=None, active_parameters=(), field_kwargs={})[source]¶ Bases:
imagine.fields.field_factory.FieldFactory
Field factory that produces the dummy field
CREAna
(see its docs for details).-
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)[source]¶ Bases:
imagine.fields.base_fields.DummyField
This dummy field instructs the
Hammurabi
simulator class to use the HammurabiX’s thermal electron density model YMW16-
NAME
= 'tereg_ymw16'¶
-
field_checklist
¶ Hammurabi XML locations of physical parameters
-
simulator_controllist
¶ Hammurabi XML locations of logical parameters
-
-
class
imagine.fields.hamx.
TEregYMW16Factory
(*, grid=None, boxsize=None, resolution=None, active_parameters=(), field_kwargs={})[source]¶ 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
= {}¶
-