LsstComCamSimTranslator

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

Bases: LsstCamTranslator

Metadata translation for the LSST Commissioning 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

Methods Summary

can_translate(header[, filename])	Indicate whether this translation class can translate the supplied header.
fix_header(header, instrument, obsid[, filename])	Fix Simulated ComCam headers.
observing_date_to_offset(observing_date)	Return the offset to use when calculating the observing day.
to_altaz_begin()	Return value of altaz_begin from headers.
to_altaz_end()	Return the AltAz for the end of the observation.
to_has_simulated_content()	Boolean indicating whether any part of this observation was simulated.
to_instrument()	The instrument used to observe the exposure.

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/comCamSim.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 = 'LSSTComCamSim'

Name of this translation class

Methods Documentation

classmethod can_translate(header, filename=None)

Indicate whether this translation class can translate the supplied header.

Looks for “COMCAMSIM” instrument in case-insensitive manner but must be on LSST telescope. This avoids confusion with other telescopes using commissioning cameras.

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 Simulated ComCam headers.

Notes

Content will be added as needed.

Corrections are reported as debug level log messages.

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_altaz_begin()

Return value of altaz_begin from headers.

Telescope boresight azimuth and elevation at start of observation.

Returns:

The translated property.

Return type:

astropy.coordinates.builtin_frames.altaz.AltAz

to_altaz_end()

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_has_simulated_content() → bool

Boolean indicating whether any part of this observation was simulated.

Returns:

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

Return type:

bool

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