HscTranslator

class astro_metadata_translator.HscTranslator(header)

Bases: astro_metadata_translator.SuprimeCamTranslator

Metadata translator for HSC standard headers.

Attributes Summary

name	Name of this translation class
supported_instrument	Supports the HSC 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(keywords, unit[, …])	Calculate a Astropy Quantity from a header card and a unit.
to_altaz_begin()
to_boresight_airmass()
to_boresight_rotation_angle()
to_boresight_rotation_coord()	Coordinate frame of the instrument rotation angle (options: sky, unknown).
to_dark_time()
to_datetime_begin()
to_datetime_end()
to_detector_exposure_id()
to_detector_name()
to_detector_num()
to_exposure_id()
to_exposure_time()
to_instrument()	The instrument used to observe the exposure.
to_location()
to_object()
to_observation_id()
to_observation_type()
to_physical_filter()
to_pressure()
to_relative_humidity()
to_science_program()
to_telescope()
to_temperature()
to_tracking_radec()
to_visit_id()
validate_value(value, default[, minimum, …])	Validate the supplied value, returning a new value if out of range

Attributes Documentation

name = 'HSC'

Name of this translation class

supported_instrument = 'HSC'

Supports the HSC 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.

There is no INSTRUME header in early HSC files, so this method looks for HSC mentions in other headers. In more recent files the instrument is called “Hyper Suprime-Cam”.

Parameters:

header : dict-like

Header to convert to standardized form.

Returns:

can : bool

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

cards_used()

Cards used during metadata extraction.

Returns:

used : frozenset of str

Cards used when extracting metadata.

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.

quantity_from_card(keywords, unit, default=None, minimum=None, maximum=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

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.

Raises:

KeyError

The supplied header key is not present.

to_altaz_begin()

to_boresight_airmass()

to_boresight_rotation_angle()

to_boresight_rotation_coord()

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

Returns:

translation : str

Translated property.

to_dark_time()

to_datetime_begin()

to_datetime_end()

to_detector_exposure_id()

to_detector_name()

to_detector_num()

to_exposure_id()

to_exposure_time()

to_instrument()

The instrument used to observe the exposure.

Returns:

translation : str

Translated property.

to_location()

to_object()

to_observation_id()

to_observation_type()

to_physical_filter()

to_pressure()

to_relative_humidity()

to_science_program()

to_telescope()

to_temperature()

to_tracking_radec()

to_visit_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.

Returns:

value : float

Either the supplied value, or a default value.