StubTranslator¶

class astro_metadata_translator.StubTranslator(header, filename=None)¶

Bases: astro_metadata_translator.MetadataTranslator

Translator where all the translations are stubbed out and issue warnings.

This translator can be used as a base class whilst developing a new translator. It allows testing to proceed without being required to fully define all translation methods. Once complete the class should be removed from the inheritance tree.

Attributes Summary

`default_search_path`
`supported_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.
`search_paths`()	Search paths to use when searching for header fix up correction files.
`to_altaz_begin`()	Unimplemented forwarding translator for altaz_begin.
`to_boresight_airmass`()	Unimplemented forwarding translator for boresight_airmass.
`to_boresight_rotation_angle`()	Unimplemented forwarding translator for boresight_rotation_angle.
`to_boresight_rotation_coord`()	Unimplemented forwarding translator for boresight_rotation_coord.
`to_dark_time`()	Unimplemented forwarding translator for dark_time.
`to_datetime_begin`()	Unimplemented forwarding translator for datetime_begin.
`to_datetime_end`()	Unimplemented forwarding translator for datetime_end.
`to_detector_exposure_id`()	Unimplemented forwarding translator for detector_exposure_id.
`to_detector_group`()	Unimplemented forwarding translator for detector_group.
`to_detector_name`()	Unimplemented forwarding translator for detector_name.
`to_detector_num`()	Unimplemented forwarding translator for detector_num.
`to_detector_serial`()	Unimplemented forwarding translator for detector_serial.
`to_detector_unique_name`()	Unimplemented forwarding translator for detector_unique_name.
`to_exposure_id`()	Unimplemented forwarding translator for exposure_id.
`to_exposure_time`()	Unimplemented forwarding translator for exposure_time.
`to_instrument`()	Unimplemented forwarding translator for instrument.
`to_location`()	Unimplemented forwarding translator for location.
`to_object`()	Unimplemented forwarding translator for object.
`to_observation_id`()	Unimplemented forwarding translator for observation_id.
`to_observation_type`()	Unimplemented forwarding translator for observation_type.
`to_physical_filter`()	Unimplemented forwarding translator for physical_filter.
`to_pressure`()	Unimplemented forwarding translator for pressure.
`to_relative_humidity`()	Unimplemented forwarding translator for relative_humidity.
`to_science_program`()	Unimplemented forwarding translator for science_program.
`to_telescope`()	Unimplemented forwarding translator for telescope.
`to_temperature`()	Unimplemented forwarding translator for temperature.
`to_tracking_radec`()	Unimplemented forwarding translator for tracking_radec.
`to_visit_id`()	Unimplemented forwarding translator for visit_id.
`validate_value`(value, default[, minimum, …])	Validate the supplied value, returning a new value if out of range

Attributes Documentation

default_search_path = None¶

supported_instrument = None¶

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

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.

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

Unimplemented forwarding translator for altaz_begin.

Telescope boresight azimuth and elevation at start of observation.