DecamTranslator

class astro_metadata_translator.DecamTranslator(header: Mapping[str, Any], filename: str | None = None)

Bases: FitsTranslator

Metadata translator for DECam standard headers.

Attributes Summary

all_properties	All the valid properties for this translator including extensions.
default_resource_package	Module name to use to locate the correction resources.
default_resource_root	Default resource path root to use to locate header correction files.
default_search_path	Default search path to use to locate header correction files.
detector_names
extensions	Extension properties (str: PropertyDefinition)
name	Name of this translation class
supported_instrument	Supports the DECam instrument.
translators	All registered metadata translation classes.

Methods Summary

are_keys_ok(keywords)	Are the supplied keys all present and defined?.
can_translate(header[, filename])	Indicate whether this translation class can translate the supplied header.
can_translate_with_options(header, options)	Determine if a header can be translated with different criteria.
cards_used()	Cards used during metadata extraction.
defined_in_this_class(name)	Report if the specified class attribute is defined specifically in this class.
determine_translatable_headers(filename[, ...])	Given a file return all the headers usable for metadata translation.
determine_translator(header[, filename])	Determine a translation class by examining the header.
fix_header(header, instrument, obsid[, filename])	Fix DECam headers.
is_key_ok(keyword)	Return True if the value associated with the named keyword is present in this header and defined.
is_keyword_defined(header, keyword)	Return True if the value associated with the named keyword is present in the supplied header and defined.
observing_date_to_observing_day(...)	Return the YYYYMMDD integer corresponding to the observing day.
observing_date_to_offset(observing_date)	Return the offset to use when calculating the observing day.
quantity_from_card(keywords, unit[, ...])	Calculate a Astropy Quantity from a header card and a unit.
resource_root()	Return package resource to use to locate correction resources within an installed package.
search_paths()	Search paths to use when searching for header fix up correction files.
to_altaz_begin()	Return value of altaz_begin from headers.
to_altaz_end()	Return the AltAz for the end of the observation.
to_boresight_airmass()	Airmass of the boresight of the telescope.
to_boresight_rotation_angle()	Angle of the instrument in boresight_rotation_coord frame.
to_boresight_rotation_coord()	Coordinate frame of the instrument rotation angle (options: sky, unknown).
to_can_see_sky()	Return whether the observation can see the sky or not.
to_dark_time()	Duration of the exposure with shutter closed (seconds).
to_datetime_begin()	Calculate start time of observation.
to_datetime_end()	Calculate end time of observation.
to_detector_exposure_id()	Return value of detector_exposure_id from headers.
to_detector_group()	Return value of detector_group from headers.
to_detector_name()	Return value of detector_name from headers.
to_detector_num()	Unique (for instrument) integer identifier for the sensor.
to_detector_serial()	Serial number/string associated with this detector.
to_detector_unique_name()	Unique name of the detector within the focal plane, generally combining detector_group with detector_name.
to_exposure_group()	Return the group label associated with this exposure.
to_exposure_id()	Calculate exposure ID.
to_exposure_time()	Actual duration of the exposure (seconds).
to_exposure_time_requested()	Requested duration of the exposure (seconds).
to_focus_z()	Return a default defocal distance of 0.0 mm if there is no keyword for defocal distance in the header.
to_group_counter_end()	Return the observation counter of the observation that ends this group.
to_group_counter_start()	Return the observation counter of the observation that began this group.
to_has_simulated_content()	Return a boolean indicating whether any part of the observation was simulated.
to_instrument()	The instrument used to observe the exposure.
to_location()	Calculate the observatory location.
to_object()	Object of interest or field name.
to_observation_counter()	Return the lifetime exposure number.
to_observation_id()	Label uniquely identifying this observation (can be related to 'exposure_id').
to_observation_reason()	Return the reason this observation was taken.
to_observation_type()	Calculate the observation type.
to_observing_day()	Return the YYYYMMDD integer corresponding to the observing day.
to_observing_day_offset()	Return the offset required to calculate observing day.
to_physical_filter()	Calculate physical filter.
to_pressure()	Atmospheric pressure outside the dome.
to_relative_humidity()	Relative humidity outside the dome.
to_science_program()	Observing program (survey or proposal) identifier.
to_telescope()	Full name of the telescope.
to_temperature()	Temperature outside the dome.
to_tracking_radec()	Return value of tracking_radec from headers.
to_visit_id()	Return value of visit_id from headers.
translator_version()	Return the version string for this translator class.
validate_value(value, default[, minimum, ...])	Validate the supplied value, returning a new value if out of range.

Attributes Documentation

all_properties: dict[str, PropertyDefinition] = {'altaz_begin': PropertyDefinition(doc='Telescope boresight azimuth and elevation at start of observation.', str_type='astropy.coordinates.AltAz', py_type=<class 'astropy.coordinates.builtin_frames.altaz.AltAz'>, to_simple=<function altaz_to_simple>, from_simple=<function simple_to_altaz>), 'altaz_end': PropertyDefinition(doc='Telescope boresight azimuth and elevation at end of observation.', str_type='astropy.coordinates.AltAz', py_type=<class 'astropy.coordinates.builtin_frames.altaz.AltAz'>, to_simple=<function altaz_to_simple>, from_simple=<function simple_to_altaz>), 'boresight_airmass': PropertyDefinition(doc='Airmass of the boresight of the telescope.', str_type='float', py_type=<class 'float'>, to_simple=None, from_simple=None), 'boresight_rotation_angle': PropertyDefinition(doc='Angle of the instrument in boresight_rotation_coord frame.', str_type='astropy.coordinates.Angle', py_type=<class 'astropy.coordinates.angles.core.Angle'>, to_simple=<function angle_to_simple>, from_simple=<function simple_to_angle>), 'boresight_rotation_coord': PropertyDefinition(doc='Coordinate frame of the instrument rotation angle (options: sky, unknown).', str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'can_see_sky': PropertyDefinition(doc='True if the observation is looking at sky, False if it is definitely not looking at the sky. None indicates that it is not known whether sky could be seen.', str_type='bool', py_type=<class 'bool'>, to_simple=None, from_simple=None), 'dark_time': PropertyDefinition(doc='Duration of the exposure with shutter closed (seconds).', str_type='astropy.units.Quantity', py_type=<class 'astropy.units.quantity.Quantity'>, to_simple=<function exptime_to_simple>, from_simple=<function simple_to_exptime>), 'datetime_begin': PropertyDefinition(doc='Time of the start of the observation.', str_type='astropy.time.Time', py_type=<class 'astropy.time.core.Time'>, to_simple=<function datetime_to_simple>, from_simple=<function simple_to_datetime>), 'datetime_end': PropertyDefinition(doc='Time of the end of the observation.', str_type='astropy.time.Time', py_type=<class 'astropy.time.core.Time'>, to_simple=<function datetime_to_simple>, from_simple=<function simple_to_datetime>), 'detector_exposure_id': PropertyDefinition(doc='Unique integer identifier for this detector in this exposure.', str_type='int', py_type=<class 'int'>, to_simple=None, from_simple=None), 'detector_group': PropertyDefinition(doc='Collection name of which this detector is a part. Can be None if there are no detector groupings.', str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'detector_name': PropertyDefinition(doc='Name of the detector within the instrument (might not be unique if there are detector groups).', str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'detector_num': PropertyDefinition(doc='Unique (for instrument) integer identifier for the sensor.', str_type='int', py_type=<class 'int'>, to_simple=None, from_simple=None), 'detector_serial': PropertyDefinition(doc='Serial number/string associated with this detector.', str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'detector_unique_name': PropertyDefinition(doc='Unique name of the detector within the focal plane, generally combining detector_group with detector_name.', str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'exposure_group': PropertyDefinition(doc="Label to use to associate this exposure with others (can be related to 'exposure_id').", str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'exposure_id': PropertyDefinition(doc='Unique (with instrument) integer identifier for this observation.', str_type='int', py_type=<class 'int'>, to_simple=None, from_simple=None), 'exposure_time': PropertyDefinition(doc='Actual duration of the exposure (seconds).', str_type='astropy.units.Quantity', py_type=<class 'astropy.units.quantity.Quantity'>, to_simple=<function exptime_to_simple>, from_simple=<function simple_to_exptime>), 'exposure_time_requested': PropertyDefinition(doc='Requested duration of the exposure (seconds).', str_type='astropy.units.Quantity', py_type=<class 'astropy.units.quantity.Quantity'>, to_simple=<function exptime_to_simple>, from_simple=<function simple_to_exptime>), 'focus_z': PropertyDefinition(doc='Defocal distance.', str_type='astropy.units.Quantity', py_type=<class 'astropy.units.quantity.Quantity'>, to_simple=<function focusz_to_simple>, from_simple=<function simple_to_focusz>), 'group_counter_end': PropertyDefinition(doc='Observation counter for the end of the exposure group. Depending on the instrument the relevant group may be visit_id or exposure_group.', str_type='int', py_type=<class 'int'>, to_simple=None, from_simple=None), 'group_counter_start': PropertyDefinition(doc='Observation counter for the start of the exposure group.Depending on the instrument the relevant group may be visit_id or exposure_group.', str_type='int', py_type=<class 'int'>, to_simple=None, from_simple=None), 'has_simulated_content': PropertyDefinition(doc='Boolean indicating whether any part of this observation was simulated.', str_type='bool', py_type=<class 'bool'>, to_simple=None, from_simple=None), 'instrument': PropertyDefinition(doc='The instrument used to observe the exposure.', str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'location': PropertyDefinition(doc='Location of the observatory.', str_type='astropy.coordinates.EarthLocation', py_type=<class 'astropy.coordinates.earth.EarthLocation'>, to_simple=<function earthlocation_to_simple>, from_simple=<function simple_to_earthlocation>), 'object': PropertyDefinition(doc='Object of interest or field name.', str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'observation_counter': PropertyDefinition(doc='Counter of this observation. Can be counter within observing_day or a global counter. Likely to be observatory specific.', str_type='int', py_type=<class 'int'>, to_simple=None, from_simple=None), 'observation_id': PropertyDefinition(doc="Label uniquely identifying this observation (can be related to 'exposure_id').", str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'observation_reason': PropertyDefinition(doc="Reason this observation was taken, or its purpose ('science' and 'calibration' are common values)", str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'observation_type': PropertyDefinition(doc='Type of observation (currently: science, dark, flat, bias, focus).', str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'observing_day': PropertyDefinition(doc='Integer in YYYYMMDD format corresponding to the day of observation.', str_type='int', py_type=<class 'int'>, to_simple=None, from_simple=None), 'observing_day_offset': PropertyDefinition(doc='Offset to subtract from an observation date when calculating the observing day. Conversely, the offset to add to an observing day when calculating the time span of a day.', str_type='astropy.time.TimeDelta', py_type=<class 'astropy.time.core.TimeDelta'>, to_simple=<function timedelta_to_simple>, from_simple=<function simple_to_timedelta>), 'physical_filter': PropertyDefinition(doc='The bandpass filter used for this observation.', str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'pressure': PropertyDefinition(doc='Atmospheric pressure outside the dome.', str_type='astropy.units.Quantity', py_type=<class 'astropy.units.quantity.Quantity'>, to_simple=<function pressure_to_simple>, from_simple=<function simple_to_pressure>), 'relative_humidity': PropertyDefinition(doc='Relative humidity outside the dome.', str_type='float', py_type=<class 'float'>, to_simple=None, from_simple=None), 'science_program': PropertyDefinition(doc='Observing program (survey or proposal) identifier.', str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'telescope': PropertyDefinition(doc='Full name of the telescope.', str_type='str', py_type=<class 'str'>, to_simple=None, from_simple=None), 'temperature': PropertyDefinition(doc='Temperature outside the dome.', str_type='astropy.units.Quantity', py_type=<class 'astropy.units.quantity.Quantity'>, to_simple=<function temperature_to_simple>, from_simple=<function simple_to_temperature>), 'tracking_radec': PropertyDefinition(doc='Requested RA/Dec to track.', str_type='astropy.coordinates.SkyCoord', py_type=<class 'astropy.coordinates.sky_coordinate.SkyCoord'>, to_simple=<function skycoord_to_simple>, from_simple=<function simple_to_skycoord>), 'visit_id': PropertyDefinition(doc='ID of the Visit this Exposure is associated with.\n\nScience observations should essentially always be\nassociated with a visit, but calibration observations\nmay not be.', str_type='int', py_type=<class 'int'>, to_simple=None, from_simple=None)}

All the valid properties for this translator including extensions.

default_resource_package = 'astro_metadata_translator'

Module name to use to locate the correction resources.

default_resource_root: str | None = 'corrections/DECam'

Default resource path root to use to locate header correction files.

default_search_path: Sequence[str] | None = None

Default search path to use to locate header correction files.

detector_names = {1: 'S29', 2: 'S30', 3: 'S31', 4: 'S25', 5: 'S26', 6: 'S27', 7: 'S28', 8: 'S20', 9: 'S21', 10: 'S22', 11: 'S23', 12: 'S24', 13: 'S14', 14: 'S15', 15: 'S16', 16: 'S17', 17: 'S18', 18: 'S19', 19: 'S8', 20: 'S9', 21: 'S10', 22: 'S11', 23: 'S12', 24: 'S13', 25: 'S1', 26: 'S2', 27: 'S3', 28: 'S4', 29: 'S5', 30: 'S6', 31: 'S7', 32: 'N1', 33: 'N2', 34: 'N3', 35: 'N4', 36: 'N5', 37: 'N6', 38: 'N7', 39: 'N8', 40: 'N9', 41: 'N10', 42: 'N11', 43: 'N12', 44: 'N13', 45: 'N14', 46: 'N15', 47: 'N16', 48: 'N17', 49: 'N18', 50: 'N19', 51: 'N20', 52: 'N21', 53: 'N22', 54: 'N23', 55: 'N24', 56: 'N25', 57: 'N26', 58: 'N27', 59: 'N28', 60: 'N29', 62: 'N31'}

extensions: dict[str, PropertyDefinition] = {}

Extension properties (str: PropertyDefinition)

Some instruments have important properties beyond the standard set; this is the place to declare that they exist, and they will be treated in the same way as the standard set, except that their names will everywhere be prefixed with ext_.

Each property is indexed by name (str), with a corresponding PropertyDefinition.

name: str | None = 'DECam'

Name of this translation class

supported_instrument: str | None = 'DECam'

Supports the DECam instrument.

translators: dict[str, type[MetadataTranslator]] = {'DECam': <class 'astro_metadata_translator.translators.decam.DecamTranslator'>, 'HSC': <class 'astro_metadata_translator.translators.hsc.HscTranslator'>, 'MegaPrime': <class 'astro_metadata_translator.translators.megaprime.MegaPrimeTranslator'>, 'SDSS': <class 'astro_metadata_translator.translators.sdss.SdssTranslator'>, 'SuprimeCam': <class 'astro_metadata_translator.translators.suprimecam.SuprimeCamTranslator'>}

All registered metadata translation classes.

Methods Documentation

are_keys_ok(keywords: Iterable[str]) → bool

Are the supplied keys all present and defined?.

Parameters:

keywordsiterable of str

Keywords to test.

Returns:

all_okbool

True if all supplied keys are present and defined.

classmethod can_translate(header: Mapping[str, Any], filename: str | None = None) → bool

Indicate whether this translation class can translate the supplied header.

Checks the INSTRUME and FILTER headers.

Parameters:

headerdict-like

Header to convert to standardized form.

filenamestr, optional

Name of file being translated.

Returns:

canbool

True if the header is recognized by this class. False otherwise.

classmethod can_translate_with_options(header: Mapping[str, Any], options: dict[str, Any], filename: str | None = None) → bool

Determine if a header can be translated with different criteria.

Parameters:

headerdict-like

Header to convert to standardized form.

optionsdict

Headers to try to determine whether this header can be translated by this class. If a card is found it will be compared with the expected value and will return that comparison. Each card will be tried in turn until one is found.

filenamestr, optional

Name of file being translated.

Returns:

canbool

True if the header is recognized by this class. False otherwise.

Notes

Intended to be used from within can_translate implementations for specific translators. Is not intended to be called directly from determine_translator.

cards_used() → frozenset[str]

Cards used during metadata extraction.

Returns:

usedfrozenset of str

Cards used when extracting metadata.

classmethod defined_in_this_class(name: str) → bool | None

Report if the specified class attribute is defined specifically in this class.

Parameters:

namestr

Name of the attribute to test.

Returns:

in_classbool

True if there is a attribute of that name defined in this specific subclass. False if the method is not defined in this specific subclass but is defined in a parent class. Returns None if the attribute is not defined anywhere in the class hierarchy (which can happen if translators have typos in their mapping tables).

Notes

Retrieves the attribute associated with the given name. Then looks in all the parent classes to determine whether that attribute comes from a parent class or from the current class. Attributes are compared using id().

classmethod determine_translatable_headers(filename: ResourcePathExpression, primary: MutableMapping[str, Any] | None = None) → Iterator[MutableMapping[str, Any]]

Given a file return all the headers usable for metadata translation.

DECam files are multi-extension FITS with a primary header and each detector stored in a subsequent extension. DECam uses INHERIT=T and each detector header will be merged with the primary header.

Guide headers are not returned.

Parameters:

filenamestr or lsst.resources.ResourcePathExpression

Path to a file in a format understood by this translator.

primarydict-like, optional

The primary header obtained by the caller. This is sometimes already known, for example if a system is trying to bootstrap without already knowing what data is in the file. Will be merged with detector headers if supplied, else will be read from the file.

Yields:

headersiterator of dict-like

Each detector header in turn. The supplied header will be merged with the contents of each detector header.

Notes

This translator class is specifically tailored to raw DECam data and is not designed to work with general FITS files. The normal paradigm is for the caller to have read the first header and then called determine_translator() on the result to work out which translator class to then call to obtain the real headers to be used for translation.

classmethod determine_translator(header: Mapping[str, Any], filename: str | None = None) → type[astro_metadata_translator.translator.MetadataTranslator]

Determine a translation class by examining the header.

Parameters:

headerdict-like

Representation of a header.

filenamestr, optional

Name of file being translated.

Returns:

translatorMetadataTranslator

Translation class that knows how to extract metadata from the supplied header.

Raises:

ValueError

None of the registered translation classes understood the supplied header.

classmethod fix_header(header: MutableMapping[str, Any], instrument: str, obsid: str, filename: str | None = None) → bool

Fix DECam headers.

Parameters:

headerdict

The header to update. Updates are in place.

instrumentstr

The name of the instrument.

obsidstr

Unique observation identifier associated with this header. Will always be provided.

filenamestr, optional

Filename associated with this header. May not be set since headers can be fixed independently of any filename being known.

Returns:

modified = bool

Returns True if the header was updated.

Notes

Fixes the following issues:

• If OBSTYPE contains “zero” or “bias”, update the FILTER keyword to “solid plate 0.0 0.0”.

Corrections are reported as debug level log messages.

is_key_ok(keyword: str | None) → bool

Return True if the value associated with the named keyword is present in this header and defined.

Parameters:

keywordstr

Keyword to check against header.

Returns:

is_okbool

True if the header is present and not-None. False otherwise.

static is_keyword_defined(header: Mapping[str, Any], keyword: str | None) → bool

Return True if the value associated with the named keyword is present in the supplied header and defined.

Parameters:

headerdict-lik

Header to use as reference.

keywordstr

Keyword to check against header.

Returns:

is_definedbool

True if the header is present and not-None. False otherwise.

classmethod observing_date_to_observing_day(observing_date: Time, offset: TimeDelta | int | None) → int

Return the YYYYMMDD integer corresponding to the observing day.

The offset is subtracted from the time of observation before calculating the year, month and day.

Parameters:

observing_dateastropy.time.Time

The observation date.

offsetastropy.time.TimeDelta | numbers.Real | None

The offset to subtract from the observing date when calculating the observing day. If a plain number is given it is taken to be in units of seconds. If None no offset is applied.

Returns:

dayint

The observing day as an integer of form YYYYMMDD.

Notes

For example, if the offset is +12 hours both 2023-07-06T13:00 and 2023-07-07T11:00 will return an observing day of 20230706 because the observing day goes from 2023-07-06T12:00 to 2023-07-07T12:00.

classmethod observing_date_to_offset(observing_date: Time) → TimeDelta | None

Return the offset to use when calculating the observing day.

Parameters:

observing_dateastropy.time.Time

The date of the observation. Unused.

Returns:

offsetastropy.time.TimeDelta

The offset to apply. The offset is always 12 hours. DECam has no defined observing day concept in its headers. To ensure that observations from a single night all have the same observing_day, adopt the same offset used by the Vera Rubin Observatory of 12 hours.

quantity_from_card(keywords: str | Sequence[str], unit: Unit, default: float | None = None, minimum: float | None = None, maximum: float | None = None, checker: Callable | None = None) → Quantity

Calculate a Astropy Quantity from a header card and a unit.

Parameters:

keywordsstr or list of str

Keyword to use from header. If a list each keyword will be tried in turn until one matches.

unitastropy.units.UnitBase

Unit of the item in the header.

defaultfloat, optional

Default value to use if the header value is invalid. Assumed to be in the same units as the value expected in the header. If None, no default value is used.

minimumfloat, optional

Minimum possible valid value, optional. If the calculated value is below this value, the default value will be used.

maximumfloat, optional

Maximum possible valid value, optional. If the calculated value is above this value, the default value will be used.

checkerCallable, optional

Callback function to be used by the translator method in case the keyword is not present. Function will be executed as if it is a method of the translator class. Running without raising an exception will allow the default to be used. Should usually raise KeyError.

Returns:

qastropy.units.Quantity

Quantity representing the header value.

Raises:

KeyError

The supplied header key is not present.

resource_root() → tuple[str | None, str | None]

Return package resource to use to locate correction resources within an installed package.

Returns:

resource_packagestr

Package resource name. None if no package resource are to be used.

resource_rootstr

The name of the resource root. None if no package resources are to be used.

search_paths() → list[str]

Search paths to use when searching for header fix up correction files.

Returns:

pathslist

Directory paths to search. Can be an empty list if no special directories are defined.

Notes

Uses the classes default_search_path property if defined.

to_altaz_begin() → Any

Return value of altaz_begin from headers.

Telescope boresight azimuth and elevation at start of observation.

Returns:

altaz_beginastropy.coordinates.AltAz

The translated property.

to_altaz_end() → Any

Return the AltAz for the end of the observation.

Base class implementation returns None. Subclasses should override if the value is known.

Returns:

altazastropy.coordinates.AltAz or None

The AltAz for the end of the observation.

to_boresight_airmass() → Any

Airmass of the boresight of the telescope.

Returns:

translationfloat

Translated value derived from the header.

to_boresight_rotation_angle() → Any

Angle of the instrument in boresight_rotation_coord frame.

Returns:

translationastropy.coordinates.angles.core.Angle

Translated property.

to_boresight_rotation_coord() → Any

Coordinate frame of the instrument rotation angle (options: sky, unknown).

Returns:

translationstr

Translated property.

to_can_see_sky() → Any

Return whether the observation can see the sky or not.

Returns:

can_see_skybool or None

True if the detector is receiving photons from the sky. False if the sky is not visible to the detector. None if the metadata translator does not know one way or the other.

Notes

The base class translator uses a simple heuristic of returning True if the observation type is “science” or “object” and False if the observation type is “bias” or “dark”. For all other cases it will return None.

to_dark_time() → Any

Duration of the exposure with shutter closed (seconds).

Returns:

translationastropy.units.Quantity

Translated value derived from the header.

to_datetime_begin() → Any

Calculate start time of observation.

Uses FITS standard MJD-BEG or DATE-BEG, in conjunction with the TIMESYS header. Will fallback to using MJD-OBS or DATE-OBS if the -BEG variants are not found.

Returns:

start_timeastropy.time.Time or None

Time corresponding to the start of the observation. Returns None if no date can be found.

to_datetime_end() → Any

Calculate end time of observation.

Uses FITS standard MJD-END or DATE-END, in conjunction with the TIMESYS header.

Returns:

start_timeastropy.time.Time

Time corresponding to the end of the observation.

to_detector_exposure_id() → Any

Return value of detector_exposure_id from headers.

Unique integer identifier for this detector in this exposure.

Returns:

detector_exposure_idint

The translated property.

to_detector_group() → Any

Return value of detector_group from headers.

Collection name of which this detector is a part. Can be None if there are no detector groupings.

Returns:

detector_groupstr

The translated property.

to_detector_name() → Any

Return value of detector_name from headers.

Name of the detector within the instrument (might not be unique if there are detector groups).

Returns:

detector_namestr

The translated property.

to_detector_num() → Any

Unique (for instrument) integer identifier for the sensor.

Returns:

translationint

Translated value derived from the header.

to_detector_serial() → Any

Serial number/string associated with this detector.

Returns:

translationstr

Translated value derived from the header.

to_detector_unique_name() → Any

Unique name of the detector within the focal plane, generally combining detector_group with detector_name.

Returns:

translationstr

Translated value derived from the header.

to_exposure_group() → Any

Return the group label associated with this exposure.

Base class implementation returns the exposure_id in string form. A subclass may do something different.

Returns:

namestr

The exposure_id converted to a string.

to_exposure_id() → Any

Calculate exposure ID.

Returns:

idint

ID of exposure.

to_exposure_time() → Any

Actual duration of the exposure (seconds).

Returns:

translationastropy.units.Quantity

Translated value derived from the header.

to_exposure_time_requested() → Any

Requested duration of the exposure (seconds).

Returns:

translationastropy.units.Quantity

Translated value derived from the header.

to_focus_z() → Any

Return a default defocal distance of 0.0 mm if there is no keyword for defocal distance in the header. The default keyword for defocal distance is FOCUSZ.

Returns:

focus_z: astropy.units.Quantity

The defocal distance from header or the 0.0mm default.

to_group_counter_end() → Any

Return the observation counter of the observation that ends this group.

The definition of the relevant group is up to the metadata translator. It can be the last observation in the exposure_group or the last observation in the visit, but must be derivable from the metadata of this observation. It is of course possible that the last observation in the group does not exist if a sequence of observations was not completed.

Returns:

counterint

The observation counter for the end of the relevant group. Default implementation always returns the observation counter of this observation.

to_group_counter_start() → Any

Return the observation counter of the observation that began this group.

The definition of the relevant group is up to the metadata translator. It can be the first observation in the exposure_group or the first observation in the visit, but must be derivable from the metadata of this observation.

Returns:

counterint

The observation counter for the start of the relevant group. Default implementation always returns the observation counter of this observation.

to_has_simulated_content() → Any

Return a boolean indicating whether any part of the observation was simulated.

Returns:

is_simulatedbool

True if this exposure has simulated content. This can be if some parts of the metadata or data were simulated. Default implementation always returns False.

to_instrument() → Any

The instrument used to observe the exposure.

Returns:

translationstr

Translated value derived from the header.

to_location() → Any

Calculate the observatory location.

Returns:

locationastropy.coordinates.EarthLocation

An object representing the location of the telescope.

to_object() → Any

Object of interest or field name.

Returns:

translationstr

Translated value derived from the header.

to_observation_counter() → Any

Return the lifetime exposure number.

Returns:

sequenceint

The observation counter.

to_observation_id() → Any

Label uniquely identifying this observation (can be related to ‘exposure_id’).

Returns:

translationstr

Translated value derived from the header.

to_observation_reason() → Any

Return the reason this observation was taken.

Base class implementation returns the science if the observation_type is science, else unknown. A subclass may do something different.

Returns:

namestr

The reason for this observation.

to_observation_type() → Any

Calculate the observation type.

Returns:

typstr

Observation type. Normalized to standard set.

to_observing_day() → Any

Return the YYYYMMDD integer corresponding to the observing day.

Base class implementation uses the TAI date of the start of the observation corrected by the observing day offset. If that offset is None no offset will be applied.

The offset is subtracted from the time of observation before calculating the year, month and day.

Returns:

dayint

The observing day as an integer of form YYYYMMDD. If the header is broken and is unable to obtain a date of observation, 0 is returned and the assumption is made that the problem will be caught elsewhere.

Notes

For example, if the offset is +12 hours both 2023-07-06T13:00 and 2023-07-07T11:00 will return an observing day of 20230706 because the observing day goes from 2023-07-06T12:00 to 2023-07-07T12:00.

to_observing_day_offset() → Any

Return the offset required to calculate observing day.

Base class implementation returns None.

Returns:

offsetastropy.time.TimeDelta or None

The offset to apply. Returns None if the offset is not defined.

Notes

This offset must be subtracted from a time of observation to calculate the observing day. This offset must be added to the YYYYMMDDT00:00 observing day to calculate the time span coverage of the observing day.

to_physical_filter() → Any

Calculate physical filter.

Return None if the keyword FILTER does not exist in the header, which can happen for some valid Community Pipeline products.

Returns:

filterstr

The full filter name.

to_pressure() → Any

Atmospheric pressure outside the dome.

Returns:

translationastropy.units.Quantity

Translated value derived from the header.

to_relative_humidity() → Any

Relative humidity outside the dome.

Returns:

translationfloat

Translated value derived from the header.

to_science_program() → Any

Observing program (survey or proposal) identifier.

Returns:

translationstr

Translated value derived from the header.

to_telescope() → Any

Full name of the telescope.

Returns:

translationstr

Translated value derived from the header.

to_temperature() → Any

Temperature outside the dome.

Returns:

translationastropy.units.Quantity

Translated value derived from the header.

to_tracking_radec() → Any

Return value of tracking_radec from headers.

Requested RA/Dec to track.

Returns:

tracking_radecastropy.coordinates.SkyCoord

The translated property.

to_visit_id() → Any

Return value of visit_id from headers.

ID of the Visit this Exposure is associated with.

Science observations should essentially always be associated with a visit, but calibration observations may not be.

Returns:

visit_idint

The translated property.

classmethod translator_version() → str

Return the version string for this translator class.

Returns:

versionstr

String identifying the version of this translator.

Notes

Assumes that the version is available from the __version__ variable in the parent module. If this is not the case a translator should subclass this method.

static validate_value(value: float, default: float, minimum: float | None = None, maximum: float | None = None) → float

Validate the supplied value, returning a new value if out of range.

Parameters:

valuefloat

Value to be validated.

defaultfloat

Default value to use if supplied value is invalid or out of range. Assumed to be in the same units as the value expected in the header.

minimumfloat

Minimum possible valid value, optional. If the calculated value is below this value, the default value will be used.

maximumfloat

Maximum possible valid value, optional. If the calculated value is above this value, the default value will be used.

Returns:

valuefloat

Either the supplied value, or a default value.