LsstTS3Translator

class lsst.obs.lsst.translators.LsstTS3Translator(header, filename=None)

Bases: lsst.obs.lsst.translators.lsstsim.LsstSimTranslator

Metadata translator for LSST BNL Test Stand 3 data.

Attributes Summary

DETECTOR_NAME	Fixed name of single sensor.
cameraPolicyFile
detectorMapping
detectorSerials
name	Name of this translation class
supported_instrument
translators

Methods Summary

can_translate(header[, filename])	Indicate whether this translation class can translate the supplied header.
can_translate_with_options(header, options)	Helper method for can_translate allowing options.
cards_used()	Cards used during metadata extraction.
compute_detector_exposure_id(exposure_id, …)	Compute the detector exposure ID from detector number and exposure ID.
compute_detector_info_from_serial(…)	Helper method to return the detector information from the serial.
compute_detector_num_from_name(…)	Helper method to return the detector number from the name.
compute_exposure_id(dateobs[, seqnum])	Helper method to calculate the TS3 exposure_id.
detector_mapping()	Returns the mapping of full name to detector ID and serial.
detector_serials()	Obtain the mapping of detector serial to detector group, name, and number.
determine_translator(header[, filename])	Determine a translation class by examining the header
quantity_from_card(keywords, unit[, …])	Calculate a Astropy Quantity from a header card and a unit.
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_dark_time()	Calculate the dark time.
to_datetime_begin()
to_datetime_end()
to_detector_exposure_id()
to_detector_group()
to_detector_name()	Name of the detector within the instrument (might not be unique).
to_detector_num()
to_detector_serial()	Serial number/string associated with this detector.
to_exposure_id()	Generate a unique exposure ID number
to_exposure_time()	Duration of the exposure with shutter open (seconds).
to_instrument()	Calculate the instrument name.
to_location()	Location of the observatory.
to_object()	Object of interest or field name.
to_observation_id()
to_observation_type()
to_physical_filter()	The bandpass filter used for this observation.
to_pressure()	Atmospheric pressure outside the dome.
to_relative_humidity()	Relative humidity outside the dome.
to_science_program()	Calculate the science program information.
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
validate_value(value, default[, minimum, …])	Validate the supplied value, returning a new value if out of range

Attributes Documentation

DETECTOR_NAME = 'S00'

Fixed name of single sensor.

cameraPolicyFile = 'policy/ts3.yaml'

detectorMapping = None

detectorSerials = None

name = 'LSST-TS3'

Name of this translation class

supported_instrument = None

translators = {'DECam': <class 'astro_metadata_translator.translators.decam.DecamTranslator'>, 'HSC': <class 'astro_metadata_translator.translators.hsc.HscTranslator'>, 'ImSim': <class 'lsst.obs.lsst.translators.imsim.ImsimTranslator'>, 'LSST-TS3': <class 'lsst.obs.lsst.translators.ts3.LsstTS3Translator'>, 'LSST-TS8': <class 'lsst.obs.lsst.translators.ts8.LsstTS8Translator'>, 'LSST-UCDCam': <class 'lsst.obs.lsst.translators.lsst_ucdcam.LsstUCDCamTranslator'>, 'LSSTAuxTel': <class 'lsst.obs.lsst.translators.auxTel.LsstAuxTelTranslator'>, 'MegaPrime': <class 'astro_metadata_translator.translators.megaprime.MegaPrimeTranslator'>, 'PhoSim': <class 'lsst.obs.lsst.translators.phosim.PhosimTranslator'>, 'SuprimeCam': <class 'astro_metadata_translator.translators.suprimecam.SuprimeCamTranslator'>}

Methods Documentation

classmethod can_translate(header, filename=None)

Indicate whether this translation class can translate the supplied header.

There is no usable INSTRUME header in TS3 data. Instead we use the TSTAND header.

Parameters:

header : dict-like

Header to convert to standardized form.

filename : str, optional

Name of file being translated.

Returns:

can : bool

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

classmethod can_translate_with_options(header, options, filename=None)

Helper method for can_translate allowing options.

Parameters:

header : dict-like

Header to convert to standardized form.

options : dict

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.

filename : str, optional

Name of file being translated.

Returns:

can : bool

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

Cards used during metadata extraction.

Returns:

used : frozenset of str

Cards used when extracting metadata.

static 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_id : int

Unique exposure ID.

detector_num : int

Detector number.

Returns:

detector_exposure_id : int

The calculated ID.

classmethod compute_detector_info_from_serial(detector_serial)

Helper method to return the detector information from the serial.

Parameters:

detector_serial : str

Detector serial ID.

Returns:

info : tuple of (str, str, int)

Detector group, name, and number.

classmethod compute_detector_num_from_name(detector_group, detector_name)

Helper method to return the detector number from the name.

Parameters:

detector_group : str

Name of the detector grouping. This is generally the raft name.

detector_name : str

Detector name.

Returns:

num : int

Detector number.

static compute_exposure_id(dateobs, seqnum=0)

Helper method to calculate the TS3 exposure_id.

Parameters:

dateobs : str

Date of observation in FITS ISO format.

seqnum : int, unused

Sequence number. Ignored.

Returns:

exposure_id : int

Exposure ID.

classmethod detector_mapping()

Returns the mapping of full name to detector ID and serial.

Returns:

mapping : dict of str:tuple

Returns the mapping of full detector name (group+detector) to detector number and serial.

Notes

Will construct the mapping if none has previously been constructed.

classmethod detector_serials()

Obtain the mapping of detector serial to detector group, name, and number.

Returns:

info : dict of tuple of (str, str, int)

A dict with the serial numbers as keys and values of detector group, name, and number.

classmethod determine_translator(header, filename=None)

Determine a translation class by examining the header

Parameters:

header : dict-like

Representation of a header.

filename : str, optional

Name of file being translated.

Returns:

translator : MetadataTranslator

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

Raises:

ValueError

None of the registered translation classes understood the supplied header.

quantity_from_card(keywords, unit, default=None, minimum=None, maximum=None, checker=None)

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

Parameters:

keywords : str or list of str

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

unit : astropy.units.UnitBase

Unit of the item in the header.

default : float, 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.

minimum : float, optional

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

maximum : float, optional

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

checker : function, 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:

q : astropy.units.Quantity

Quantity representing the header value.

Raises:

KeyError

The supplied header key is not present.

to_altaz_begin()

Telescope boresight azimuth and elevation at start of observation.

Returns:

translation : astropy.coordinates.AltAz

Translated property.

to_boresight_airmass()

Airmass of the boresight of the telescope.

Returns:

translation : float

Translated property.

to_boresight_rotation_angle()

Angle of the instrument in boresight_rotation_coord frame.

Returns:

translation : astropy.coordinates.Angle

Translated property.

to_boresight_rotation_coord()

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

Returns:

translation : str

Translated property.

to_dark_time()

Calculate the dark time.

If a DARKTIME header is not found, the value is assumed to be identical to the exposure time.

Returns:

dark : astropy.units.Quantity

The dark time in seconds.

to_datetime_begin()

to_datetime_end()

to_detector_exposure_id()

to_detector_group()

to_detector_name()

Name of the detector within the instrument (might not be unique).

Returns:

translation : str

Translated property.

to_detector_num()

to_detector_serial()

Serial number/string associated with this detector.

Returns:

translation : str

Translated value derived from the header.

to_exposure_id()

Generate a unique exposure ID number

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

Returns:

exposure_id : int

Unique exposure number.

to_exposure_time()

Duration of the exposure with shutter open (seconds).

Returns:

translation : astropy.units.Quantity

Translated value derived from the header.

to_instrument()

Calculate the instrument name.

Returns:

instrume : str

Name of the test stand.

to_location()

Location of the observatory.

Returns:

translation : astropy.coordinates.EarthLocation

Translated property.

to_object()

Object of interest or field name.

Returns:

translation : str

Translated property.

to_observation_id()

to_observation_type()

to_physical_filter()

The bandpass filter used for this observation.

Returns:

translation : str

Translated value derived from the header.

to_pressure()

Atmospheric pressure outside the dome.

Returns:

translation : astropy.units.Quantity

Translated property.

to_relative_humidity()

Relative humidity outside the dome.

Returns:

translation : float

Translated property.

to_science_program()

Calculate the science program information.

There is no header recording this in TS3 data so instead return the observing day in YYYY-MM-DD format.

Returns:

run : str

Observing day in YYYY-MM-DD format.

to_telescope()

Full name of the telescope.

Returns:

translation : str

Translated property.

to_temperature()

Temperature outside the dome.

Returns:

translation : astropy.units.Quantity

Translated property.

to_tracking_radec()

Requested RA/Dec to track.

Returns:

translation : astropy.coordinates.SkyCoord

Translated property.

to_visit_id()

Generate a unique exposure ID number

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

Returns:

exposure_id : int

Unique exposure number.

static validate_value(value, default, minimum=None, maximum=None)

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

Parameters:

value : float

Value to be validated.

default : float

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.

minimum : float

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

maximum : float

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

Returns:

value : float

Either the supplied value, or a default value.