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.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.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 = {}