MegaPrimeTranslator¶
-
class
astro_metadata_translator.
MegaPrimeTranslator
(header)¶ Bases:
astro_metadata_translator.FitsTranslator
Metadata translator for CFHT MegaPrime standard headers.
Attributes Summary
name
Name of this translation class supported_instrument
Supports the MegaPrime instrument. translators
Methods Summary
can_translate
(header)Indicate whether this translation class can translate the supplied header. cards_used
()Cards used during metadata extraction. determine_translator
(header)Determine a translation class by examining the header quantity_from_card
(keyword, unit[, default, …])Calculate a Astropy Quantity from a header card and a unit. to_altaz_begin
()Return value of altaz_begin from headers. 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
()Duration of the exposure with shutter closed (seconds). to_datetime_begin
()Calculate start time of observation. to_datetime_end
()Calculate end time of observation. to_detector_exposure_id
()Return value of detector_exposure_id from headers. to_detector_name
()Name of the detector within the instrument (might not be unique). to_detector_num
()Return value of detector_num from headers. to_exposure_id
()Unique (with instrument) integer identifier for this observation. to_exposure_time
()Duration of the exposure with shutter open (seconds). to_instrument
()The instrument used to observe the exposure. to_location
()Calculate the observatory location. to_object
()Object of interest or field name. to_observation_id
()Label uniquely identifying this observation (can be related to ‘exposure_id’). to_observation_type
()Calculate the 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
()Observing program (survey or proposal) identifier. to_telescope
()Full name of the telescope. to_temperature
()Temperature outside the dome. to_tracking_radec
()Return value of tracking_radec from headers. to_visit_id
()ID of the Visit this Exposure is associated with. validate_value
(value, default[, minimum, …])Validate the supplied value, returning a new value if out of range Attributes Documentation
-
name
= 'MegaPrime'¶ Name of this translation class
-
supported_instrument
= 'MegaPrime'¶ Supports the MegaPrime instrument.
-
translators
= {'DECam': <class 'astro_metadata_translator.translators.decam.DecamTranslator'>, 'HSC': <class 'astro_metadata_translator.translators.hsc.HscTranslator'>, 'MegaPrime': <class 'astro_metadata_translator.translators.megaprime.MegaPrimeTranslator'>, 'SuprimeCam': <class 'astro_metadata_translator.translators.suprimecam.SuprimeCamTranslator'>}¶
Methods Documentation
-
classmethod
can_translate
(header)¶ Indicate whether this translation class can translate the supplied header.
Checks the instrument value and compares with the supported instruments in the class
Parameters: - header :
dict
-like Header to convert to standardized form.
Returns: - header :
-
cards_used
()¶ Cards used during metadata extraction.
Returns:
-
classmethod
determine_translator
(header)¶ Determine a translation class by examining the header
Parameters: - header :
dict
-like Representation of a header.
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.
- header :
-
quantity_from_card
(keyword, unit, default=None, minimum=None, maximum=None)¶ Calculate a Astropy Quantity from a header card and a unit.
Parameters: - keyword :
str
Keyword to use from header.
- 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
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: - q :
astropy.units.Quantity
Quantity representing the header value.
- keyword :
-
to_altaz_begin
()¶ 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
()¶ Airmass of the boresight of the telescope.
Returns: - translation :
float
Translated value derived from the header.
- 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
()¶ Duration of the exposure with shutter closed (seconds).
Returns: - translation :
astropy.units.Quantity
Translated value derived from the header.
- translation :
-
to_datetime_begin
()¶ Calculate start time of observation.
Uses FITS standard
DATE-OBS
andTIMESYS
headers.Returns: - start_time :
astropy.time.Time
Time corresponding to the start of the observation.
- start_time :
-
to_datetime_end
()¶ Calculate end time of observation.
Uses FITS standard
DATE-END
andTIMESYS
headers.Returns: - start_time :
astropy.time.Time
Time corresponding to the end of the observation.
- start_time :
-
to_detector_exposure_id
()¶ 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_name
()¶ Name of the detector within the instrument (might not be unique).
Returns: - translation :
str
Translated value derived from the header.
- translation :
-
to_detector_num
()¶ Return value of detector_num from headers.
Unique (for instrument) integer identifier for the sensor.
Returns: - detector_num :
int
The translated property.
- detector_num :
-
to_exposure_id
()¶ Unique (with instrument) integer identifier for this observation.
Returns: - translation :
int
Translated value derived from the header.
- translation :
-
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 value derived from the header.
- translation :
-
to_location
()¶ Calculate the observatory location.
Returns: - location :
astropy.coordinates.EarthLocation
An object representing the location of the telescope.
- location :
-
to_object
()¶ Object of interest or field name.
Returns: - translation :
str
Translated value derived from the header.
- translation :
-
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
()¶ Calculate the observation type.
Returns: - typ :
str
Observation type. Normalized to standard set.
- typ :
-
to_physical_filter
()¶ The bandpass filter used for this observation.
Returns: - translation :
str
Translated value derived from the header.
- translation :
-
to_pressure
()¶ Atmospheric pressure outside the dome.
Returns: - translation :
astropy.units.Quantity
Translated value derived from the header.
- translation :
-
to_relative_humidity
()¶ Relative humidity outside the dome.
Returns: - translation :
float
Translated value derived from the header.
- translation :
-
to_science_program
()¶ Observing program (survey or proposal) identifier.
Returns: - translation :
str
Translated value derived from the header.
- translation :
-
to_telescope
()¶ Full name of the telescope.
Returns: - translation :
str
Translated value derived from the header.
- translation :
-
to_temperature
()¶ Temperature outside the dome.
Returns: - translation :
astropy.units.Quantity
Translated value derived from the header.
- translation :
-
to_tracking_radec
()¶ 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
()¶ 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.
Returns: - translation :
int
Translated value derived from the header.
- translation :
-
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.
- value :
-