LsstCamTranslator

class lsst.obs.lsst.translators.LsstCamTranslator(header: Mapping[str, Any], filename: str | None = None)

Bases: LsstBaseTranslator

Metadata translation for the main LSST Camera.

Attributes Summary

all_properties	All the valid properties for this translator including extensions.
cameraPolicyFile	Path to policy file relative to obs_lsst root.
detectorMapping	Mapping of detector name to detector number and serial.
detectorSerials	Mapping of detector serial number to raft, number, and name.
name	Name of this translation class
supported_instrument	Supports the lsstCam instrument.

Methods Summary

can_translate(header[, filename])	Indicate whether this translation class can translate the supplied header.
fix_header(header, instrument, obsid[, filename])	Fix LSSTCam headers.
observing_date_to_offset(observing_date)	Return the offset to use when calculating the observing day.
to_boresight_rotation_angle()	Angle of the instrument in boresight_rotation_coord frame.
to_can_see_sky()	Return whether the observation can see the sky or not.
to_detector_group()	Collection name of which this detector is a part.
to_detector_name()	Name of the detector within the instrument (might not be unique if there are detector groups).
to_detector_serial()	Serial number/string associated with this detector.
to_exposure_time()	Return value of exposure_time from headers.
to_exposure_time_requested()	Requested duration of the exposure (seconds).
to_instrument()	The instrument used to observe the exposure.
to_object()	Object of interest or field name.
to_observation_id()	Label uniquely identifying this observation (can be related to 'exposure_id').
to_physical_filter()	Calculate the physical filter name.
to_science_program()	Observing program (survey or proposal) identifier.
to_telescope()	Full name of the telescope.

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.

cameraPolicyFile = 'policy/lsstCam.yaml'

Path to policy file relative to obs_lsst root.

detectorMapping = None

Mapping of detector name to detector number and serial.

detectorSerials = None

Mapping of detector serial number to raft, number, and name.

name: str | None = 'LSSTCam'

Name of this translation class

supported_instrument: str | None = 'LSSTCam'

Supports the lsstCam instrument.

Methods Documentation

classmethod can_translate(header, filename=None)

Indicate whether this translation class can translate the supplied header.

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 fix_header(header, instrument, obsid, filename=None)

Fix LSSTCam headers.

Notes

See fix_header for details of the general process.

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. During lab testing the offset is Pacific Time which can mean UTC-7 or UTC-8 depending on daylight savings. In Chile the offset is always UTC-12.

to_boresight_rotation_angle() → Any

Angle of the instrument in boresight_rotation_coord frame.

Returns

translationastropy.coordinates.Angle

Translated value derived from the header.

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_detector_group() → Any

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

Returns

translationstr

Translated value derived from the header.

to_detector_name() → Any

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

Returns

translationstr

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_exposure_time() → Any

Return value of exposure_time from headers.

Actual duration of the exposure (seconds).

Returns

exposure_timeastropy.units.Quantity

The translated property.

to_exposure_time_requested() → Any

Requested duration of the exposure (seconds).

Returns

translationastropy.units.Quantity

Translated value derived from the header.

to_instrument() → Any

The instrument used to observe the exposure.

Returns

translationstr

Translated property.

to_object() → Any

Object of interest or field name.

Returns

translationstr

Translated value derived from the header.

to_observation_id() → Any

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

Returns

translationstr

Translated value derived from the header.

to_physical_filter() → Any

Calculate the physical filter name.

Returns

filterstr

Name of filter. Can be a combination of FILTER, FILTER1, and FILTER2 headers joined by a “~”. Trailing “~empty” components are stripped. Returns “unknown” if no filter is declared.

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 property.