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_resource_package
default_resource_root
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.
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() 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_resource_package = 'astro_metadata_translator'
default_resource_root = None
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'>, '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()

Unimplemented forwarding translator for altaz_begin.

Telescope boresight azimuth and elevation at start of observation.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
altaz_begin : None or astropy.coordinates.AltAz

Always returns None.

to_boresight_airmass()

Unimplemented forwarding translator for boresight_airmass.

Airmass of the boresight of the telescope.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
boresight_airmass : None or float

Always returns None.

to_boresight_rotation_angle()

Unimplemented forwarding translator for boresight_rotation_angle.

Angle of the instrument in boresight_rotation_coord frame.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
boresight_rotation_angle : None or astropy.coordinates.Angle

Always returns None.

to_boresight_rotation_coord()

Unimplemented forwarding translator for boresight_rotation_coord.

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

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
boresight_rotation_coord : None or str

Always returns None.

to_dark_time()

Unimplemented forwarding translator for dark_time.

Duration of the exposure with shutter closed (seconds).

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
dark_time : None or astropy.units.Quantity

Always returns None.

to_datetime_begin()

Unimplemented forwarding translator for datetime_begin.

Time of the start of the observation.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
datetime_begin : None or astropy.time.Time

Always returns None.

to_datetime_end()

Unimplemented forwarding translator for datetime_end.

Time of the end of the observation.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
datetime_end : None or astropy.time.Time

Always returns None.

to_detector_exposure_id()

Unimplemented forwarding translator for detector_exposure_id.

Unique integer identifier for this detector in this exposure.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
detector_exposure_id : None or int

Always returns None.

to_detector_group()

Unimplemented forwarding translator for detector_group.

Collection name of which this detector is a part. Can be None if there are no detector groupings.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
detector_group : None or str

Always returns None.

to_detector_name()

Unimplemented forwarding translator for detector_name.

Name of the detector within the instrument (might not be unique if there are detector groups).

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
detector_name : None or str

Always returns None.

to_detector_num()

Unimplemented forwarding translator for detector_num.

Unique (for instrument) integer identifier for the sensor.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
detector_num : None or int

Always returns None.

to_detector_serial()

Unimplemented forwarding translator for detector_serial.

Serial number/string associated with this detector.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
detector_serial : None or str

Always returns None.

to_detector_unique_name()

Unimplemented forwarding translator for detector_unique_name.

Unique name of the detector within the focal plane, generally combining detector_group with detector_name.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
detector_unique_name : None or str

Always returns None.

to_exposure_id()

Unimplemented forwarding translator for exposure_id.

Unique (with instrument) integer identifier for this observation.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
exposure_id : None or int

Always returns None.

to_exposure_time()

Unimplemented forwarding translator for exposure_time.

Duration of the exposure with shutter open (seconds).

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
exposure_time : None or astropy.units.Quantity

Always returns None.

to_instrument()

Unimplemented forwarding translator for instrument.

The instrument used to observe the exposure.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
instrument : None or str

Always returns None.

to_location()

Unimplemented forwarding translator for location.

Location of the observatory.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
location : None or astropy.coordinates.EarthLocation

Always returns None.

to_object()

Unimplemented forwarding translator for object.

Object of interest or field name.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
object : None or str

Always returns None.

to_observation_id()

Unimplemented forwarding translator for observation_id.

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

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
observation_id : None or str

Always returns None.

to_observation_type()

Unimplemented forwarding translator for observation_type.

Type of observation (currently: science, dark, flat, bias, focus).

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
observation_type : None or str

Always returns None.

to_physical_filter()

Unimplemented forwarding translator for physical_filter.

The bandpass filter used for this observation.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
physical_filter : None or str

Always returns None.

to_pressure()

Unimplemented forwarding translator for pressure.

Atmospheric pressure outside the dome.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
pressure : None or astropy.units.Quantity

Always returns None.

to_relative_humidity()

Unimplemented forwarding translator for relative_humidity.

Relative humidity outside the dome.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
relative_humidity : None or float

Always returns None.

to_science_program()

Unimplemented forwarding translator for science_program.

Observing program (survey or proposal) identifier.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
science_program : None or str

Always returns None.

to_telescope()

Unimplemented forwarding translator for telescope.

Full name of the telescope.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
telescope : None or str

Always returns None.

to_temperature()

Unimplemented forwarding translator for temperature.

Temperature outside the dome.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
temperature : None or astropy.units.Quantity

Always returns None.

to_tracking_radec()

Unimplemented forwarding translator for tracking_radec.

Requested RA/Dec to track.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.

Returns:
tracking_radec : None or astropy.coordinates.SkyCoord

Always returns None.

to_visit_id()

Unimplemented forwarding translator for 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.

Calls the base class translation method and if that fails with NotImplementedError issues a warning reminding the implementer to override this method.
Returns:
visit_id : None or int

Always returns None.

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.