LsstComCamTranslator¶
-
class
lsst.obs.lsst.translators.
LsstComCamTranslator
(header, filename=None)¶ Bases:
lsst.obs.lsst.translators.LsstCamTranslator
Metadata translation for the LSST Commissioning Camera.
Attributes Summary
Name of this translation class
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)Helper method for
can_translate
allowing options.Cards used during metadata extraction.
compute_detector_exposure_id
(exposure_id, …)Compute the detector exposure ID from detector number and exposure ID.
Helper method to return the detector information from the serial.
Helper method to return the detector number from the name.
compute_exposure_id
(dayobs, seqnum[, controller])Helper method to calculate the exposure_id.
defined_in_this_class
(name)Report if the specified class attribute is defined specifically in this class.
Returns the mapping of full name to detector ID and serial.
Obtain the mapping of detector serial to detector group, name, and number.
determine_translator
(header[, filename])Determine a translation class by examining the header
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.The maximum detector exposure ID expected to be generated by this instrument.
The maximum exposure ID expected from this instrument.
quantity_from_card
(keywords, unit[, …])Calculate a Astropy Quantity from a header card and a unit.
Package resource to use to locate correction resources within an installed package.
Search paths to use for LSST data when looking for header correction files.
Telescope boresight azimuth and elevation at start of observation.
Airmass of the boresight of the telescope.
Angle of the instrument in boresight_rotation_coord frame.
Coordinate frame of the instrument rotation angle (options: sky, unknown).
Calculate the dark time.
Collection name of which this detector is a part.
Name of the detector within the instrument (might not be unique if there are detector groups).
Serial number/string associated with this detector.
Return a unique name for the detector.
Generate a unique exposure ID number
Duration of the exposure with shutter open (seconds).
The instrument used to observe the exposure.
Object of interest or field name.
Label uniquely identifying this observation (can be related to ‘exposure_id’).
Calculate the physical filter name.
Atmospheric pressure outside the dome.
Relative humidity outside the dome.
Observing program (survey or proposal) identifier.
Full name of the telescope.
Temperature outside the dome.
Requested RA/Dec to track.
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_MAX
= 999¶
-
cameraPolicyFile
= 'policy/comCam.yaml'¶
-
default_resource_package
= 'astro_metadata_translator'¶
-
default_resource_root
= None¶
-
default_search_path
= None¶
-
detectorMapping
= None¶
-
detectorSerials
= None¶
-
name
= 'LSST-ComCam'¶ Name of this translation class
-
supported_instrument
= 'lsstCam'¶
-
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-ComCam': <class 'lsst.obs.lsst.translators.comCam.LsstComCamTranslator'>, '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'>, 'LSSTCam': <class 'lsst.obs.lsst.translators.lsstCam.LsstCamTranslator'>, 'LSST_LATISS': <class 'lsst.obs.lsst.translators.latiss.LsstLatissTranslator'>, 'MegaPrime': <class 'astro_metadata_translator.translators.megaprime.MegaPrimeTranslator'>, 'PhoSim': <class 'lsst.obs.lsst.translators.phosim.PhosimTranslator'>, 'SDSS': <class 'astro_metadata_translator.translators.sdss.SdssTranslator'>, 'SuprimeCam': <class 'astro_metadata_translator.translators.suprimecam.SuprimeCamTranslator'>}¶
Methods Documentation
-
are_keys_ok
(keywords)¶ Are the supplied keys all present and defined?
-
classmethod
can_translate
(header, filename=None)¶ Indicate whether this translation class can translate the supplied header.
Looks for “COMCAM” instrument in case-insensitive manner but must be on LSST telescope. This avoids confusion with other telescopes using commissioning cameras.
-
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.
- header
- Returns
Notes
Intended to be used from within
can_translate
implementations for specific translators. Is not intended to be called directly fromdetermine_translator
.
-
cards_used
()¶ Cards used during metadata extraction.
-
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.
-
classmethod
compute_detector_info_from_serial
(detector_serial)¶ Helper method to return the detector information from the serial.
-
classmethod
compute_detector_num_from_name
(detector_group, detector_name)¶ Helper method to return the detector number from the name.
-
static
compute_exposure_id
(dayobs, seqnum, controller=None)¶ Helper method to calculate the exposure_id.
- Parameters
- dayobs
str
Day of observation in either YYYYMMDD or YYYY-MM-DD format. If the string looks like ISO format it will be truncated before the
T
before being handled.- seqnum
int
orstr
Sequence number.
- controller
str
, optional Controller to use. If this is “O”, no change is made to the exposure ID. If it is “C” a 1000 is added to the year component of the exposure ID.
None
indicates that the controller is not relevant to the exposure ID calculation (generally this is the case for test stand data).
- dayobs
- Returns
- exposure_id
int
Exposure ID in form YYYYMMDDnnnnn form.
- exposure_id
-
classmethod
defined_in_this_class
(name)¶ Report if the specified class attribute is defined specifically in this class.
- Parameters
- name
str
Name of the attribute to test.
- name
- Returns
- in_class
bool
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. ReturnsNone
if the attribute is not defined anywhere in the class hierarchy (which can happen if translators have typos in their mapping tables).
- in_class
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
detector_mapping
()¶ Returns the mapping of full name to detector ID and serial.
- Returns
- Raises
- ValueError
Raised if no camera policy file has been registered with this translation class.
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.
-
classmethod
determine_translator
(header, filename=None)¶ Determine a translation class by examining the header
- Parameters
- Returns
- translator
MetadataTranslator
Translation class that knows how to extract metadata from the supplied header.
- translator
- Raises
- ValueError
None of the registered translation classes understood the supplied header.
-
is_key_ok
(keyword)¶ Return
True
if the value associated with the named keyword is present in this header and defined.
-
static
is_keyword_defined
(header, keyword)¶ Return
True
if the value associated with the named keyword is present in the supplied header and defined.
-
classmethod
max_detector_exposure_id
()¶ The maximum detector exposure ID expected to be generated by this instrument.
- Returns
- max_id
int
The maximum value.
- max_id
-
classmethod
max_exposure_id
()¶ The maximum exposure ID expected from this instrument.
- Returns
- max_exposure_id
int
The maximum value.
- max_exposure_id
-
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
orlist
ofstr
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
.
- keywords
- Returns
- q
astropy.units.Quantity
Quantity representing the header value.
- q
- Raises
- KeyError
The supplied header key is not present.
-
resource_root
()¶ Package resource to use to locate correction resources within an installed package.
-
search_paths
()¶ Search paths to use for LSST data when looking for header correction files.
- Returns
- path
list
List with a single element containing the full path to the
corrections
directory within theobs_lsst
package.
- path
-
to_altaz_begin
()¶ Telescope boresight azimuth and elevation at start of observation.
- Returns
- translation
astropy.coordinates.AltAz
Translated property.
- translation
-
to_boresight_airmass
()¶ Airmass of the boresight of the telescope.
- Returns
- translation
float
Translated property.
- translation
-
to_boresight_rotation_angle
()¶ Angle of the instrument in boresight_rotation_coord frame.
- Returns
- translation
astropy.coordinates.Angle
Translated property.
- translation
-
to_boresight_rotation_coord
()¶ Coordinate frame of the instrument rotation angle (options: sky, unknown).
- Returns
- translation
str
Translated property.
- translation
-
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.
- dark
-
to_datetime_begin
()¶
-
to_datetime_end
()¶
-
to_detector_exposure_id
()¶
-
to_detector_group
()¶ Collection name of which this detector is a part. Can be None if there are no detector groupings.
- Returns
- translation
str
Translated value derived from the header.
- translation
-
to_detector_name
()¶ Name of the detector within the instrument (might not be unique if there are detector groups).
- Returns
- translation
str
Translated value derived from the header.
- translation
-
to_detector_num
()¶
-
to_detector_serial
()¶ Serial number/string associated with this detector.
- Returns
- translation
str
Translated value derived from the header.
- translation
-
to_detector_unique_name
()¶ Return a unique name for the detector.
Base class implementation attempts to combine
detector_name
withdetector_group
. Group is only used if notNone
.Can be over-ridden by specialist translator class.
- Returns
- name
str
detector_group``_``detector_name
ifdetector_group
is defined, else thedetector_name
is assumed to be unique. If neither return a valid value an exception is raised.
- name
- Raises
- NotImplementedError
Raised if neither detector_name nor detector_group is defined.
-
to_exposure_id
()¶ Generate a unique exposure ID number
This is a combination of DAYOBS and SEQNUM, and optionally CONTRLLR.
- Returns
- exposure_id
int
Unique exposure number.
- exposure_id
-
to_exposure_time
()¶ Duration of the exposure with shutter open (seconds).
- Returns
- translation
astropy.units.Quantity
Translated value derived from the header.
- translation
-
to_instrument
()¶ The instrument used to observe the exposure.
- Returns
- translation
str
Translated property.
- translation
-
to_location
()¶
-
to_observation_id
()¶ Label uniquely identifying this observation (can be related to ‘exposure_id’).
- Returns
- translation
str
Translated value derived from the header.
- translation
-
to_observation_type
()¶
-
to_physical_filter
()¶ Calculate the physical filter name.
- Returns
- filter
str
Name of filter. Can be a combination of FILTER, FILTER1 and FILTER2 headers joined by a “+”. Returns “NONE” if no filter is declared.
- filter
-
to_pressure
()¶ Atmospheric pressure outside the dome.
- Returns
- translation
astropy.units.Quantity
Translated property.
- translation
-
to_relative_humidity
()¶ Relative humidity outside the dome.
- Returns
- translation
float
Translated property.
- translation
-
to_science_program
()¶ Observing program (survey or proposal) identifier.
- Returns
- translation
str
Translated value derived from the header.
- translation
-
to_temperature
()¶ Temperature outside the dome.
- Returns
- translation
astropy.units.Quantity
Translated property.
- translation
-
to_tracking_radec
()¶ Requested RA/Dec to track.
- Returns
- translation
astropy.coordinates.SkyCoord
Translated property.
- translation
-
to_visit_id
()¶ Generate a unique exposure ID number
This is a combination of DAYOBS and SEQNUM, and optionally CONTRLLR.
- Returns
- exposure_id
int
Unique exposure number.
- exposure_id
-
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.
- value
- Returns
- value
float
Either the supplied value, or a default value.
- value
-