astropy:docs

Note

This is an old version of the documentation. See http://docs.astropy.org/en/stable for the latest version.

TimeFrameAttribute

class astropy.coordinates.TimeFrameAttribute(default=None, secondary_attribute=u'')[source] [edit on github]

Bases: astropy.coordinates.FrameAttribute

Frame attribute descriptor for quantities that are Time objects. See the FrameAttribute API doc for further information.

Parameters:

default : object

Default value for the attribute if not provided

secondary_attribute : str

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

Methods Summary

convert_input(value) Convert input value to a Time object and validate by running through the Time constructor.

Methods Documentation

convert_input(value)[source] [edit on github]

Convert input value to a Time object and validate by running through the Time constructor. Also check that the input was a scalar.

Parameters:

value : object

Input value to be converted.

Returns:

out, converted : correctly-typed object, boolean

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.

Page Contents