LatissTranslator¶
- class lsst.obs.lsst.translators.LatissTranslator(header: Mapping[str, Any], filename: str | None = None)¶
Bases:
LsstBaseTranslator
Metadata translator for LSST LATISS data from AuxTel.
For lab measurements many values are masked out.
Attributes Summary
Fixed name of detector group.
Maximum number of detectors to use when calculating the detector_exposure_id.
Fixed name of single sensor.
All the valid properties for this translator including extensions.
Path to policy file relative to obs_lsst root.
Module name to use to locate the correction resources.
Default package resource path root to use to locate header correction files within the
default_resource_package
package.Default search path to use to locate header correction files.
Mapping of detector name to detector number and serial.
Mapping of detector serial number to raft, number, and name.
Extension properties (
str
:PropertyDefinition
)Name of this translation class
Supports the LATISS instrument.
All registered metadata translation classes.
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)Determine if a header can be translated with different criteria.
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_translatable_headers
(filename[, ...])Given a file return all the headers usable for metadata translation.
determine_translator
(header[, filename])Determine a translation class by examining the header.
fix_header
(header, instrument, obsid[, filename])Fix an incorrect LATISS 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.Determine if this is an on-sky observation.
The maximum detector exposure ID expected to be generated by this instrument.
The maximum exposure ID expected from this instrument.
Return the YYYYMMDD integer corresponding to the observing day.
observing_date_to_offset
(observing_date)Return the offset to use when calculating the observing day.
quantity_from_card
(keywords, unit[, ...])Calculate a Astropy Quantity from a header card and a unit.
Return 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.
Return value of altaz_begin from headers.
Calculate airmass at boresight at start of observation.
Angle of the instrument in boresight_rotation_coord frame.
Boresight rotation angle.
Return whether the observation can see the sky or not.
Calculate the dark time.
Calculate start time of observation.
Calculate end time of observation.
Return value of detector_exposure_id from headers.
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).
Unique (for instrument) integer identifier for the sensor.
Serial number/string associated with this detector.
Return a unique name for the detector.
Calculate the exposure group string.
Generate a unique exposure ID number
Return value of exposure_time from headers.
Return the defocal distance of the camera in units of mm.
Return the observation counter of the observation that ends this group.
Return the observation counter of the observation that began this group.
Return a boolean indicating whether any part of the observation was simulated.
The instrument used to observe the exposure.
Calculate the observatory location.
Object of interest or field name.
Return the sequence number within the observing day.
Label uniquely identifying this observation (can be related to 'exposure_id').
Return the reason this observation was taken.
Determine the observation type.
Return the day of observation as YYYYMMDD integer.
Return the offset required to calculate observing day.
Calculate the physical filter name.
Return value of pressure from headers.
Return value of relative_humidity from headers.
Observing program (survey or proposal) identifier.
Full name of the telescope.
Return value of temperature from headers.
Return value of tracking_radec from headers.
Calculate the visit associated with this exposure.
Return the version string for this translator class.
unpack_exposure_id
(exposure_id)Unpack an exposure ID into dayobs, seqnum, and controller.
validate_value
(value, default[, minimum, ...])Validate the supplied value, returning a new value if out of range.
Attributes Documentation
- DETECTOR_GROUP_NAME = 'RXX'¶
Fixed name of detector group.
- DETECTOR_MAX = 0¶
Maximum number of detectors to use when calculating the detector_exposure_id.
- DETECTOR_NAME = 'S00'¶
Fixed name of single sensor.
- 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>), '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='Duration of the exposure with shutter open (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 = None¶
Path to policy file relative to obs_lsst root.
- default_resource_package = 'astro_metadata_translator'¶
Module name to use to locate the correction resources.
- default_resource_root: str | None = None¶
Default package resource path root to use to locate header correction files within the
default_resource_package
package.
- default_search_path: Sequence[str] | None = None¶
Default search path to use to locate header correction files.
- detectorMapping = None¶
Mapping of detector name to detector number and serial.
- detectorSerials = None¶
Mapping of detector serial number to raft, number, and name.
- extensions: dict[str, PropertyDefinition] = {}¶
Extension properties (
str
:PropertyDefinition
)Some instruments have important properties beyond the standard set; this is the place to declare that they exist, and they will be treated in the same way as the standard set, except that their names will everywhere be prefixed with
ext_
.Each property is indexed by name (
str
), with a correspondingPropertyDefinition
.
- translators: dict[str, type[MetadataTranslator]] = {'DECam': <class 'astro_metadata_translator.translators.decam.DecamTranslator'>, 'HSC': <class 'astro_metadata_translator.translators.hsc.HscTranslator'>, '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'>, 'LSSTCam-PhoSim': <class 'lsst.obs.lsst.translators.phosim.LsstCamPhoSimTranslator'>, 'LSSTCam-imSim': <class 'lsst.obs.lsst.translators.imsim.LsstCamImSimTranslator'>, 'LSSTComCam': <class 'lsst.obs.lsst.translators.comCam.LsstComCamTranslator'>, 'LSSTComCamSim': <class 'lsst.obs.lsst.translators.comCamSim.LsstComCamSimTranslator'>, 'LSST_LATISS': <class 'lsst.obs.lsst.translators.latiss.LatissTranslator'>, 'MegaPrime': <class 'astro_metadata_translator.translators.megaprime.MegaPrimeTranslator'>, 'SDSS': <class 'astro_metadata_translator.translators.sdss.SdssTranslator'>, 'SuprimeCam': <class 'astro_metadata_translator.translators.suprimecam.SuprimeCamTranslator'>}¶
All registered metadata translation classes.
Methods Documentation
- classmethod can_translate(header, filename=None)¶
Indicate whether this translation class can translate the supplied header.
- classmethod can_translate_with_options(header: Mapping[str, Any], options: dict[str, Any], filename: str | None = None) bool ¶
Determine if a header can be translated with different criteria.
- 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
.
- 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.
- 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
orint
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. If it is “H” a 2000 is added to the year component. This sequence continues with “P” and “Q” controllers.
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: str) bool | None ¶
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_translatable_headers(filename: str, primary: MutableMapping[str, Any] | None = None) Iterator[MutableMapping[str, Any]] ¶
Given a file return all the headers usable for metadata translation.
This method can optionally be given a header from the file. This header will generally be the primary header or a merge of the first two headers.
In the base class implementation it is assumed that this supplied header is the only useful header for metadata translation and it will be returned unchanged if given. This can avoid unnecessarily re-opening the file and re-reading the header when the content is already known.
If no header is supplied, a header will be read from the supplied file using
read_basic_metadata_from_file
, allowing it to merge the primary and secondary header of a multi-extension FITS file. Subclasses can read the header from the data file using whatever technique is best for that instrument.Subclasses can return multiple headers and ignore the externally supplied header. They can also merge it with another header and return a new derived header if that is required by the particular data file. There is no requirement for the supplied header to be used.
- Parameters:
- filename
str
Path to a file in a format understood by this translator.
- primary
dict
-like, optional The primary header obtained by the caller. This is sometimes already known, for example if a system is trying to bootstrap without already knowing what data is in the file. For many instruments where the primary header is the only relevant header, the primary header will be returned with no further action.
- filename
- Yields:
- headersiterator of
dict
-like A header usable for metadata translation. For this base implementation it will be either the supplied primary header or a header read from the file. This implementation will only ever yield a single header.
- headersiterator of
Notes
Each translator class can have code specifically tailored to its own file format. It is important not to call this method with an incorrect translator class. The normal paradigm is for the caller to have read the first header and then called
determine_translator()
on the result to work out which translator class to then call to obtain the real headers to be used for translation.
- classmethod determine_translator(header: Mapping[str, Any], filename: str | None = None) type[astro_metadata_translator.translator.MetadataTranslator] ¶
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.
- classmethod fix_header(header, instrument, obsid, filename=None)¶
Fix an incorrect LATISS header.
- Parameters:
- header
dict
The header to update. Updates are in place.
- instrument
str
The name of the instrument.
- obsid
str
Unique observation identifier associated with this header. Will always be provided.
- filename
str
, optional Filename associated with this header. May not be set since headers can be fixed independently of any filename being known.
- header
- Returns:
Notes
This method does not apply per-obsid corrections. The following corrections are applied:
On June 24th 2019 the detector was changed from ITL-3800C-098 to ITL-3800C-068. The header is intended to be correct in the future.
In late 2019 the DATE-OBS and MJD-OBS headers were reporting 1970 dates. To correct, the DATE/MJD headers are copied in to replace them and the -END headers are cleared.
Until November 2019 the IMGTYPE was set in the GROUPID header. The value is moved to IMGTYPE.
SHUTTIME is always forced to be
None
.
Corrections are reported as debug level log messages.
See
fix_header
for details of the general process.
- is_key_ok(keyword: str | None) bool ¶
Return
True
if the value associated with the named keyword is present in this header and defined.
- static is_keyword_defined(header: Mapping[str, Any], keyword: str | None) bool ¶
Return
True
if the value associated with the named keyword is present in the supplied header and defined.
- is_on_sky()¶
Determine if this is an on-sky observation.
- Returns:
- is_on_sky
bool
Returns True if this is a observation on sky on the summit.
- is_on_sky
- 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
- classmethod observing_date_to_observing_day(observing_date: Time, offset: TimeDelta | int | None) int ¶
Return the YYYYMMDD integer corresponding to the observing day.
The offset is subtracted from the time of observation before calculating the year, month and day.
- Parameters:
- observing_date
astropy.time.Time
The observation date.
- offset
astropy.time.TimeDelta
|numbers.Real
| None The offset to subtract from the observing date when calculating the observing day. If a plain number is given it is taken to be in units of seconds. If
None
no offset is applied.
- observing_date
- Returns:
- day
int
The observing day as an integer of form YYYYMMDD.
- day
Notes
For example, if the offset is +12 hours both 2023-07-06T13:00 and 2023-07-07T11:00 will return an observing day of 20230706 because the observing day goes from 2023-07-06T12:00 to 2023-07-07T12:00.
- classmethod observing_date_to_offset(observing_date: Time) TimeDelta | None ¶
Return the offset to use when calculating the observing day.
- Parameters:
- observing_date
astropy.time.Time
The date of the observation. Unused.
- observing_date
- Returns:
- offset
astropy.time.TimeDelta
The offset to apply. The default implementation returns a fixed number but subclasses can return a different value depending on whether the instrument is in the instrument lab or on the mountain.
- offset
- quantity_from_card(keywords: str | Sequence[str], unit: Unit, default: float | None = None, minimum: float | None = None, maximum: float | None = None, checker: Callable | None = None) Quantity ¶
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
Callable
, 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() tuple[str | None, str | None] ¶
Return 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() Any ¶
Return value of altaz_begin from headers.
Telescope boresight azimuth and elevation at start of observation.
- Returns:
- altaz_begin
astropy.coordinates.AltAz
The translated property.
- altaz_begin
- to_boresight_airmass() Any ¶
Calculate airmass at boresight at start of observation.
Notes
Early data are missing AMSTART header so we fall back to calculating it from ELSTART.
- to_boresight_rotation_angle() Any ¶
Angle of the instrument in boresight_rotation_coord frame.
- Returns:
- translation
astropy.coordinates.Angle
Translated value derived from the header.
- translation
- to_boresight_rotation_coord() Any ¶
Boresight rotation angle.
Only relevant for science observations.
- to_can_see_sky() Any ¶
Return whether the observation can see the sky or not.
- Returns:
Notes
The base class translator uses a simple heuristic of returning
True
if the observation type is “science” or “object” andFalse
if the observation type is “bias” or “dark”. For all other cases it will returnNone
.
- to_dark_time() Any ¶
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() Any ¶
Calculate start time of observation.
Uses FITS standard
MJD-BEG
orDATE-BEG
, in conjunction with theTIMESYS
header. Will fallback to usingMJD-OBS
orDATE-OBS
if the-BEG
variants are not found.- Returns:
- start_time
astropy.time.Time
orNone
Time corresponding to the start of the observation. Returns
None
if no date can be found.
- start_time
- to_datetime_end() Any ¶
Calculate end time of observation.
Uses FITS standard
MJD-END
orDATE-END
, in conjunction with theTIMESYS
header.- Returns:
- start_time
astropy.time.Time
Time corresponding to the end of the observation.
- start_time
- to_detector_exposure_id() Any ¶
Return value of detector_exposure_id from headers.
Unique integer identifier for this detector in this exposure.
- Returns:
- detector_exposure_id
int
The translated property.
- detector_exposure_id
- to_detector_group() Any ¶
Collection name of which this detector is a part. Can be None if there are no detector groupings.
- Returns:
- translation
str
Translated property.
- translation
- to_detector_name() Any ¶
Name of the detector within the instrument (might not be unique if there are detector groups).
- Returns:
- translation
str
Translated property.
- translation
- to_detector_num() Any ¶
Unique (for instrument) integer identifier for the sensor.
- Returns:
- translation
int
Translated property.
- translation
- to_detector_serial() Any ¶
Serial number/string associated with this detector.
- Returns:
- translation
str
Translated value derived from the header.
- translation
- to_detector_unique_name() Any ¶
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_group() Any ¶
Calculate the exposure group string.
For LSSTCam and LATISS this is read from the
GROUPID
header. If that header is missing the exposure_id is returned instead as a string.
- to_exposure_id() Any ¶
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() Any ¶
Return value of exposure_time from headers.
Duration of the exposure with shutter open (seconds).
- Returns:
- exposure_time
astropy.units.Quantity
The translated property.
- exposure_time
- to_focus_z() Any ¶
Return the defocal distance of the camera in units of mm. If there is no
FOCUSZ
value in the header it will return the default 0.0mm value.- Returns:
- focus_z:
astropy.units.Quantity
The defocal distance from header in mm or the 0.0mm default
- focus_z:
- to_group_counter_end() Any ¶
Return the observation counter of the observation that ends this group.
The definition of the relevant group is up to the metadata translator. It can be the last observation in the exposure_group or the last observation in the visit, but must be derivable from the metadata of this observation. It is of course possible that the last observation in the group does not exist if a sequence of observations was not completed.
- Returns:
- counter
int
The observation counter for the end of the relevant group. Default implementation always returns the observation counter of this observation.
- counter
- to_group_counter_start() Any ¶
Return the observation counter of the observation that began this group.
The definition of the relevant group is up to the metadata translator. It can be the first observation in the exposure_group or the first observation in the visit, but must be derivable from the metadata of this observation.
- Returns:
- counter
int
The observation counter for the start of the relevant group. Default implementation always returns the observation counter of this observation.
- counter
- to_has_simulated_content() Any ¶
Return a boolean indicating whether any part of the observation was simulated.
- to_instrument() Any ¶
The instrument used to observe the exposure.
- Returns:
- translation
str
Translated property.
- translation
- to_location() Any ¶
Calculate the observatory location.
Uses FITS standard
OBSGEO-
headers.- Returns:
- location
astropy.coordinates.EarthLocation
An object representing the location of the telescope.
- location
- to_object() Any ¶
Object of interest or field name.
- Returns:
- translation
str
Translated value derived from the header.
- translation
- to_observation_counter() Any ¶
Return the sequence number within the observing day.
- Returns:
- counter
int
The sequence number for this day.
- counter
- to_observation_id() Any ¶
Label uniquely identifying this observation (can be related to ‘exposure_id’).
- Returns:
- translation
str
Translated value derived from the header.
- translation
- to_observation_reason() Any ¶
Return the reason this observation was taken.
Base class implementation returns the
science
if theobservation_type
is science, elseunknown
. A subclass may do something different.- Returns:
- name
str
The reason for this observation.
- name
- to_observation_type() Any ¶
Determine the observation type.
In the absence of an
IMGTYPE
header, assumes lab data is always a dark if exposure time is non-zero, else bias.- Returns:
- obstype
str
Observation type.
- obstype
- to_observing_day() Any ¶
Return the day of observation as YYYYMMDD integer.
For LSSTCam and other compliant instruments this is the value of the DAYOBS header.
- Returns:
- obs_day
int
The day of observation.
- obs_day
- to_observing_day_offset() Any ¶
Return the offset required to calculate observing day.
Base class implementation returns
None
.- Returns:
- offset
astropy.time.TimeDelta
orNone
The offset to apply. Returns
None
if the offset is not defined.
- offset
Notes
This offset must be subtracted from a time of observation to calculate the observing day. This offset must be added to the YYYYMMDDT00:00 observing day to calculate the time span coverage of the observing day.
- to_physical_filter() Any ¶
Calculate the physical filter name.
- Returns:
- filter
str
Name of filter. A combination of FILTER and GRATING headers joined by a “~”. The filter and grating are always combined. The filter or grating part will be “none” if no value is specified. Uses “empty” if any of the filters or gratings indicate an “empty_N” name. “unknown” indicates that the filter is not defined anywhere but we think it should be. “none” indicates that the filter was not defined but the observation is a dark or bias.
- filter
- to_pressure() Any ¶
Return value of pressure from headers.
Atmospheric pressure outside the dome.
- Returns:
- pressure
astropy.units.Quantity
The translated property.
- pressure
- to_relative_humidity() Any ¶
Return value of relative_humidity from headers.
Relative humidity outside the dome.
- Returns:
- relative_humidity
float
The translated property.
- relative_humidity
- to_science_program() Any ¶
Observing program (survey or proposal) identifier.
- Returns:
- translation
str
Translated value derived from the header.
- translation
- to_temperature() Any ¶
Return value of temperature from headers.
Temperature outside the dome.
- Returns:
- temperature
astropy.units.Quantity
The translated property.
- temperature
- to_tracking_radec() Any ¶
Return value of tracking_radec from headers.
Requested RA/Dec to track.
- Returns:
- tracking_radec
astropy.coordinates.SkyCoord
The translated property.
- tracking_radec
- to_visit_id() Any ¶
Calculate the visit associated with this exposure.
Notes
For LATISS and LSSTCam the default visit is derived from the exposure group. For other instruments we return the exposure_id.
- classmethod translator_version() str ¶
Return the version string for this translator class.
- Returns:
- version
str
String identifying the version of this translator.
- version
Notes
Assumes that the version is available from the
__version__
variable in the parent module. If this is not the case a translator should subclass this method.
- static unpack_exposure_id(exposure_id)¶
Unpack an exposure ID into dayobs, seqnum, and controller.
- Parameters:
- exposure_id
int
Integer exposure ID produced by
compute_exposure_id
.
- exposure_id
- Returns:
- dayobs
str
Day of observation as a YYYYMMDD string.
- seqnum
int
Sequence number.
- controller
str
Controller code. Will be
O
(but should be ignored) for IDs produced by callingcompute_exposure_id
withcontroller=None
.
- dayobs
- static validate_value(value: float, default: float, minimum: float | None = None, maximum: float | None = None) float ¶
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