Coverage for python/astro_metadata_translator/properties.py : 100%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
# This file is part of astro_metadata_translator. # # Developed for the LSST Data Management System. # This product includes software developed by the LSST Project # (http://www.lsst.org). # See the LICENSE file at the top-level directory of this distribution # for details of code ownership. # # Use of this source code is governed by a 3-clause BSD-style # license that can be found in the LICENSE file.
Defines all properties in one place so that both `ObservationInfo` and `MetadataTranslator` can use them. In particular, the translator base class can use knowledge of these properties to predefine translation stubs with documentation attached, and `ObservationInfo` can automatically define the getter methods.
"""
# Dict of properties to tuple where tuple is: # - description of property # - Python type of property as a string (suitable for docstrings) "instrument": ("The instrument used to observe the exposure.", "str", str), "location": ("Location of the observatory.", "astropy.coordinates.EarthLocation", astropy.coordinates.EarthLocation), "exposure_id": ("Unique (with instrument) integer identifier for this observation.", "int", int), "visit_id": ("""ID of the Visit this Exposure is associated with.
Science observations should essentially always be associated with a visit, but calibration observations may not be.""", "int", int), "physical_filter": ("The bandpass filter used for this observation.", "str", str), "datetime_begin": ("Time of the start of the observation.", "astropy.time.Time", astropy.time.Time), "datetime_end": ("Time of the end of the observation.", "astropy.time.Time", astropy.time.Time), "exposure_time": ("Duration of the exposure with shutter open (seconds).", "astropy.units.Quantity", astropy.units.Quantity), "dark_time": ("Duration of the exposure with shutter closed (seconds).", "astropy.units.Quantity", astropy.units.Quantity), "boresight_airmass": ("Airmass of the boresight of the telescope.", "float", float), "boresight_rotation_angle": ("Angle of the instrument in boresight_rotation_coord frame.", "astropy.coordinates.Angle", astropy.coordinates.Angle), "boresight_rotation_coord": ("Coordinate frame of the instrument rotation angle" " (options: sky, unknown).", "str", str), "detector_num": ("Unique (for instrument) integer identifier for the sensor.", "int", int), "detector_name": ("Name of the detector within the instrument (might not be unique" " if there are detector groups).", "str", str), "detector_unique_name": ("Unique name of the detector within the focal plane, generally" " combining detector_group with detector_name.", "str", str), "detector_serial": ("Serial number/string associated with this detector.", "str", str), "detector_group": ("Collection name of which this detector is a part. " "Can be None if there are no detector groupings.", "str", str), "detector_exposure_id": ("Unique integer identifier for this detector in this exposure.", "int", int), "object": ("Object of interest or field name.", "str", str), "temperature": ("Temperature outside the dome.", "astropy.units.Quantity", astropy.units.Quantity), "pressure": ("Atmospheric pressure outside the dome.", "astropy.units.Quantity", astropy.units.Quantity), "relative_humidity": ("Relative humidity outside the dome.", "float", float), "tracking_radec": ("Requested RA/Dec to track.", "astropy.coordinates.SkyCoord", astropy.coordinates.SkyCoord), "altaz_begin": ("Telescope boresight azimuth and elevation at start of observation.", "astropy.coordinates.AltAz", astropy.coordinates.AltAz), "science_program": ("Observing program (survey or proposal) identifier.", "str", str), "observation_type": ("Type of observation (currently: science, dark, flat, bias, focus).", "str", str), "observation_id": ("Label uniquely identifying this observation " "(can be related to 'exposure_id').", "str", str)} |