coolest.template.standard

coolest.template.standard#

Classes#

COOLEST

Main component of COOLEST. This object stores all relevant quantities

Module Contents#

class COOLEST(mode: str, coordinates_origin: coolest.template.classes.coordinates.CoordinatesOrigin, lensing_entities: coolest.template.classes.lensing_entity_list.LensingEntityList, observation: coolest.template.classes.observation.Observation, instrument: coolest.template.classes.instrument.Instrument, cosmology: coolest.template.classes.cosmology.Cosmology = None, likelihoods: coolest.template.classes.likelihood_list.DataLikelihoodList = None, metadata: dict = None)[source]#

Main component of COOLEST. This object stores all relevant quantities to a given lens model, as a hierarchy of python objects whose attributes describe the Observation, Instrument, Coordinates, Lens models, etc.

Parameters:

  • mode (str) –

    Mode of the stored lens model described in the COOLEST object. Should be one of the following:

    • ’MOCK’: the object describes a mock observation of a lens;

    • ’MAP’: the object describes a maximum a posteriori point estimates

    (best-fit values) lens model, possibly including statistics regarding the posterior distribution of lens model parameters;

    • ’DOC’: the object contains all description of profiles and parameters,

    (only relevant for generating documentation products).

    The mode affects which attributes a stored in the JSON representation of the COOLEST object.

  • coordinates_origin (CoordinatesOrigin) – Instance of a CoordinatesOrigin object.

  • lensing_entities (LensingEntityList) – Instance of a LensingEntityList object.

  • observation (Observation) – Instance of a Observation object.

  • instrument (Instrument) – Instance of a Instrument object.

  • cosmology (Cosmology, optional) – Instance of a Cosmology object, by default None

  • metadata (dict, optional) – Any additional data to be stored in the COOLEST format, by default None

Raises:

ValueError – If the provided mode is not supported.

mode[source]#
coordinates_origin[source]#
lensing_entities[source]#
observation[source]#
instrument[source]#
cosmology = None[source]#
likelihoods = None[source]#
standard = 'COOLEST'[source]#
meta = None[source]#
property exclude_keys[source]#
Contents