SuprimeCamTranslator

class astro_metadata_translator.SuprimeCamTranslator(header, filename=None)

Bases: astro_metadata_translator.SubaruTranslator

Metadata translator for HSC standard headers.

Attributes Summary

default_resource_package
default_resource_root Default resource path root to use to locate header correction files.
default_search_path
name Name of this translation class
supported_instrument Supports the SuprimeCam instrument.
translators

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() Cards used during metadata extraction.
defined_in_this_class(name) Report if the specified class attribute is defined specifically in this class.
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.
quantity_from_card(keywords, unit[, …]) Calculate a Astropy Quantity from a header card and a unit.
resource_root() Package resource to use to locate correction resources within an installed package.
search_paths() Search paths to use when searching for header fix up correction files.
to_altaz_begin()
to_boresight_airmass() Airmass of the boresight of the telescope.
to_boresight_rotation_angle()
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()
to_datetime_end()
to_detector_exposure_id()
to_detector_group() Collection name of which this detector is a part.
to_detector_name()
to_detector_num() Unique (for instrument) integer identifier for the sensor.
to_detector_serial() Serial number/string associated with this detector.
to_detector_unique_name() Return a unique name for the detector.
to_exposure_id() Calculate unique exposure integer 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() Returns the location of the Subaru telescope on Mauna Kea.
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()
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()
to_visit_id() Calculate the unique integer ID for this visit.
validate_value(value, default[, minimum, …]) Validate the supplied value, returning a new value if out of range

Attributes Documentation

default_resource_package = 'astro_metadata_translator'
default_resource_root = 'corrections/SuprimeCam'

Default resource path root to use to locate header correction files.

default_search_path = None
name = 'SuprimeCam'

Name of this translation class

supported_instrument = 'SuprimeCam'

Supports the SuprimeCam 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'>, '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?

Parameters:
keywords : iterable of str

Keywords to test.

Returns:
all_ok : bool

True if all supplied keys are present and defined.

classmethod can_translate(header, filename=None)

Indicate whether this translation class can translate the supplied header.

Parameters:
header : dict-like

Header to convert to standardized form.

filename : str, optional

Name of file being translated.

Returns:
can : bool

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

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.

Returns:
can : bool

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

Notes

Intended to be used from within can_translate implementations for specific translators. Is not intended to be called directly from determine_translator.

cards_used()

Cards used during metadata extraction.

Returns:
used : frozenset of str

Cards used when extracting metadata.

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.

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. Returns None if the attribute is not defined anywhere in the class hierarchy (which can happen if translators have typos in their mapping tables).

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 determine_translator(header, filename=None)

Determine a translation class by examining the header

Parameters:
header : dict-like

Representation of a header.

filename : str, optional

Name of file being translated.

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.

is_key_ok(keyword)

Return True if the value associated with the named keyword is present in this header and defined.

Parameters:
keyword : str

Keyword to check against header.

Returns:
is_ok : bool

True if the header is present and not-None. False otherwise.

static is_keyword_defined(header, keyword)

Return True if the value associated with the named keyword is present in the supplied header and defined.

Parameters:
header : dict-lik

Header to use as reference.

keyword : str

Keyword to check against header.

Returns:
is_defined : bool

True if the header is present and not-None. False otherwise.

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

Returns:
q : astropy.units.Quantity

Quantity representing the header value.

Raises:
KeyError

The supplied header key is not present.

resource_root()

Package resource to use to locate correction resources within an installed package.

Returns:
resource_package : str

Package resource name. None if no package resource are to be used.

resource_root : str

The name of the resource root. None if no package resources are to be used.

search_paths()

Search paths to use when searching for header fix up correction files.

Returns:
paths : list

Directory paths to search. Can be an empty list if no special directories are defined.

Notes

Uses the classes default_search_path property if defined.

to_altaz_begin()
to_boresight_airmass()

Airmass of the boresight of the telescope.

Returns:
translation : float

Translated value derived from the header.

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()

Duration of the exposure with shutter closed (seconds).

Returns:
translation : astropy.units.Quantity

Translated value derived from the header.

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

to_detector_name()
to_detector_num()

Unique (for instrument) integer identifier for the sensor.

Returns:
translation : int

Translated value derived from the header.

to_detector_serial()

Serial number/string associated with this detector.

Returns:
translation : str

Translated value derived from the header.

to_detector_unique_name()

Return a unique name for the detector.

Base class implementation attempts to combine detector_name with detector_group. Group is only used if not None.

Can be over-ridden by specialist translator class.

Returns:
name : str

detector_group``_``detector_name if detector_group is defined, else the detector_name is assumed to be unique. If neither return a valid value an exception is raised.

Raises:
NotImplementedError

Raised if neither detector_name nor detector_group is defined.

to_exposure_id()

Calculate unique exposure integer for this observation

Returns:
visit : int

Integer uniquely identifying this exposure.

to_exposure_time()

Duration of the exposure with shutter open (seconds).

Returns:
translation : astropy.units.Quantity

Translated value derived from the header.

to_instrument()

The instrument used to observe the exposure.

Returns:
translation : str

Translated value derived from the header.

to_location()

Returns the location of the Subaru telescope on Mauna Kea.

Hardcodes the location and does not look at any headers.

Returns:
location : astropy.coordinates.EarthLocation

An object representing the location of the telescope.

to_object()

Object of interest or field name.

Returns:
translation : str

Translated value derived from the header.

to_observation_id()

Label uniquely identifying this observation (can be related to ‘exposure_id’).

Returns:
translation : str

Translated value derived from the header.

to_observation_type()

Calculate the observation type.

Returns:
typ : str

Observation type. Normalized to standard set.

to_physical_filter()
to_pressure()

Atmospheric pressure outside the dome.

Returns:
translation : astropy.units.Quantity

Translated value derived from the header.

to_relative_humidity()

Relative humidity outside the dome.

Returns:
translation : float

Translated value derived from the header.

to_science_program()

Observing program (survey or proposal) identifier.

Returns:
translation : str

Translated value derived from the header.

to_telescope()

Full name of the telescope.

Returns:
translation : str

Translated value derived from the header.

to_temperature()

Temperature outside the dome.

Returns:
translation : astropy.units.Quantity

Translated value derived from the header.

to_tracking_radec()
to_visit_id()

Calculate the unique integer ID for this visit.

Assumed to be identical to the exposure ID in this implementation.

Returns:
exp : int

Unique visit identifier.

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.