EarthLocationAttribute

class astropy.coordinates.EarthLocationAttribute(default=None, secondary_attribute='', *, doc='A frame attribute')

Bases: Attribute

A frame attribute that can act as a EarthLocation. It can be created as anything that can be transformed to the ITRS frame, but always presents as an EarthLocation when accessed after creation.

Parameters:

defaultobject

Default value for the attribute if not provided

secondary_attributestr

Name of a secondary instance attribute which supplies the value if default is None and no value was supplied during initialization.

docstr

Description of the frame attribute for help and documentation

Methods Summary

convert_input(value)

Checks that the input is a Quantity with the necessary units (or the special value 0).

Methods Documentation

convert_input(value)

Checks that the input is a Quantity with the necessary units (or the special value 0).

Parameters:

valueobject

Input value to be converted.

Returns:

out, convertedcorrectly-typed object, bool

Tuple consisting of the correctly-typed object and a boolean which indicates if conversion was actually performed.

Raises:

ValueError

If the input is not valid for this attribute.