LsstTS8Translator

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

Bases: LsstBaseTranslator

Metadata translator for LSST Test Stand 8 data.

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

Methods Summary

can_translate(header[, filename])	Indicate whether this translation class can translate the supplied header.
compute_detector_exposure_id(exposure_id, ...)	Compute the detector exposure ID from detector number and exposure ID.
fix_header(header, instrument, obsid[, filename])	Fix TS8 headers.
max_exposure_id()	The maximum exposure ID expected from this instrument.
to_altaz_begin()	Telescope boresight azimuth and elevation at start of 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()	True if the observation is looking at sky, False if it is definitely not looking at the sky.
to_detector_group()	Returns the name of the raft.
to_detector_name()	Return value of detector_name from headers.
to_detector_serial()	Returns the serial number of the detector.
to_exposure_id()	Generate a unique exposure ID number
to_exposure_time()	Actual duration of the exposure (seconds).
to_instrument()	The instrument used to observe the exposure.
to_location()	Location of the observatory.
to_object()	Object of interest or field name.
to_observation_id()	Return value of observation_id from headers.
to_physical_filter()	Return the filter name.
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()	Requested RA/Dec to track.
to_visit_id()	Generate a unique exposure ID number

Attributes Documentation

all_properties: dict[str, PropertyDefinition] = {'altaz_begin': <astro_metadata_translator.properties.PropertyDefinition object>, 'altaz_end': <astro_metadata_translator.properties.PropertyDefinition object>, 'boresight_airmass': <astro_metadata_translator.properties.PropertyDefinition object>, 'boresight_rotation_angle': <astro_metadata_translator.properties.PropertyDefinition object>, 'boresight_rotation_coord': <astro_metadata_translator.properties.PropertyDefinition object>, 'can_see_sky': <astro_metadata_translator.properties.PropertyDefinition object>, 'dark_time': <astro_metadata_translator.properties.PropertyDefinition object>, 'datetime_begin': <astro_metadata_translator.properties.PropertyDefinition object>, 'datetime_end': <astro_metadata_translator.properties.PropertyDefinition object>, 'detector_exposure_id': <astro_metadata_translator.properties.PropertyDefinition object>, 'detector_group': <astro_metadata_translator.properties.PropertyDefinition object>, 'detector_name': <astro_metadata_translator.properties.PropertyDefinition object>, 'detector_num': <astro_metadata_translator.properties.PropertyDefinition object>, 'detector_serial': <astro_metadata_translator.properties.PropertyDefinition object>, 'detector_unique_name': <astro_metadata_translator.properties.PropertyDefinition object>, 'exposure_group': <astro_metadata_translator.properties.PropertyDefinition object>, 'exposure_id': <astro_metadata_translator.properties.PropertyDefinition object>, 'exposure_time': <astro_metadata_translator.properties.PropertyDefinition object>, 'exposure_time_requested': <astro_metadata_translator.properties.PropertyDefinition object>, 'focus_z': <astro_metadata_translator.properties.PropertyDefinition object>, 'group_counter_end': <astro_metadata_translator.properties.PropertyDefinition object>, 'group_counter_start': <astro_metadata_translator.properties.PropertyDefinition object>, 'has_simulated_content': <astro_metadata_translator.properties.PropertyDefinition object>, 'instrument': <astro_metadata_translator.properties.PropertyDefinition object>, 'location': <astro_metadata_translator.properties.PropertyDefinition object>, 'object': <astro_metadata_translator.properties.PropertyDefinition object>, 'observation_counter': <astro_metadata_translator.properties.PropertyDefinition object>, 'observation_id': <astro_metadata_translator.properties.PropertyDefinition object>, 'observation_reason': <astro_metadata_translator.properties.PropertyDefinition object>, 'observation_type': <astro_metadata_translator.properties.PropertyDefinition object>, 'observing_day': <astro_metadata_translator.properties.PropertyDefinition object>, 'observing_day_offset': <astro_metadata_translator.properties.PropertyDefinition object>, 'physical_filter': <astro_metadata_translator.properties.PropertyDefinition object>, 'pressure': <astro_metadata_translator.properties.PropertyDefinition object>, 'relative_humidity': <astro_metadata_translator.properties.PropertyDefinition object>, 'science_program': <astro_metadata_translator.properties.PropertyDefinition object>, 'telescope': <astro_metadata_translator.properties.PropertyDefinition object>, 'temperature': <astro_metadata_translator.properties.PropertyDefinition object>, 'tracking_radec': <astro_metadata_translator.properties.PropertyDefinition object>, 'visit_id': <astro_metadata_translator.properties.PropertyDefinition object>}

All the valid properties for this translator including extensions.

cameraPolicyFile = 'policy/ts8.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 = 'LSST-TS8'

Name of this translation class

Methods Documentation

classmethod can_translate(header, filename=None)

Indicate whether this translation class can translate the supplied header.

There is no INSTRUME header in TS8 data. Instead we use the TSTAND header. We also look at the file name to see if it starts with “ts8-“.

Older data has no TSTAND header so we must use a combination of 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 compute_detector_exposure_id(exposure_id, detector_num)

Compute the detector exposure ID from detector number and exposure ID.

This is a helper method to allow code working outside the translator infrastructure to use the same algorithm.

Parameters

exposure_idint

Unique exposure ID.

detector_numint

Detector number.

Returns

detector_exposure_idint

The calculated ID.

classmethod fix_header(header, instrument, obsid, filename=None)

Fix TS8 headers.

Notes

See fix_header for details of the general process.

classmethod max_exposure_id()

The maximum exposure ID expected from this instrument.

The TS8 implementation is non-standard because TS8 data can create two different forms of exposure_id based on the date but we need the largest form to be the one returned.

Returns

max_exposure_idint

The maximum value.

to_altaz_begin() → AltAz

Telescope boresight azimuth and elevation at start of observation.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

astropy.coordinates.builtin_frames.altaz.AltAz

to_boresight_airmass() → float

Airmass of the boresight of the telescope.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

float

to_boresight_rotation_angle() → Angle

Angle of the instrument in boresight_rotation_coord frame.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

astropy.coordinates.angles.core.Angle

to_boresight_rotation_coord() → str

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

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

str

to_can_see_sky() → bool

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.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

bool

to_detector_group()

Returns the name of the raft.

Extracted from RAFTNAME header.

Raftname should be of the form: ‘LCA-11021_RTM-011-Dev’ and the resulting name will have the form “RTM-NNN”.

Returns

namestr

Name of raft.

to_detector_name()

Return value of detector_name from headers.

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

Returns:

The translated property.

Return type:

str

to_detector_serial()

Returns the serial number of the detector.

Returns

serialstr

LSST assigned serial number.

Notes

This is the LSST assigned serial number (LSST_NUM), and not the manufacturer’s serial number (CCD_SERN).

to_exposure_id()

Generate a unique exposure ID number

Modern TS8 data conforms to standard LSSTCam OBSID, using the “C” controller variant (all TS8 uses “C” controller). Due to existing ingests, data taken before 2023-05-25 must use the old style timestamp ID.

For older data SEQNUM is not unique for a given day in TS8 data so instead we convert the ISO date of observation directly to an integer.

Returns

exposure_idint

Unique exposure number.

to_exposure_time() → Quantity

Actual duration of the exposure (seconds).

Returns:

Translated value derived directly from a single header.

Return type:

astropy.units.quantity.Quantity

to_instrument() → str

The instrument used to observe the exposure.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

str

to_location() → EarthLocation

Location of the observatory.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

astropy.coordinates.earth.EarthLocation

to_object() → str

Object of interest or field name.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

str

to_observation_id()

Return value of observation_id from headers.

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

Returns:

The translated property.

Return type:

str

to_physical_filter()

Return the filter name.

Uses the FILTPOS header for older TS8 data. Newer data can use the base class implementation.

Returns

filterstr

The filter name. Returns “NONE” if no filter can be determined.

Notes

The FILTPOS handling is retained for backwards compatibility.

to_pressure() → Quantity

Atmospheric pressure outside the dome.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

astropy.units.quantity.Quantity

to_relative_humidity() → float

Relative humidity outside the dome.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

float

to_science_program() → str

Observing program (survey or proposal) identifier.

Returns:

Translated value derived directly from a single header.

Return type:

str

to_telescope() → str

Full name of the telescope.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

str

to_temperature() → Quantity

Temperature outside the dome.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

astropy.units.quantity.Quantity

to_tracking_radec() → SkyCoord

Requested RA/Dec to track.

Returns:

Translated property that is fixed to a single value by the translator.

Return type:

astropy.coordinates.sky_coordinate.SkyCoord

to_visit_id()

Generate a unique exposure ID number

Modern TS8 data conforms to standard LSSTCam OBSID, using the “C” controller variant (all TS8 uses “C” controller). Due to existing ingests, data taken before 2023-05-25 must use the old style timestamp ID.

For older data SEQNUM is not unique for a given day in TS8 data so instead we convert the ISO date of observation directly to an integer.

Returns

exposure_idint

Unique exposure number.