CartesianRepresentationAttribute¶
-
class
astropy.coordinates.
CartesianRepresentationAttribute
(default=None, secondary_attribute='', unit=None)[source] [edit on github]¶ Bases:
astropy.coordinates.Attribute
A frame attribute that is a CartesianRepresentation with specified units.
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.- unit : unit object or None
Name of a unit that the input will be converted into. If None, no unit-checking or conversion is performed
Methods Summary
convert_input
(value)Checks that the input is a CartesianRepresentation with the correct unit, or the special value [0, 0, 0]
.Methods Documentation
-
convert_input
(value)[source] [edit on github]¶ Checks that the input is a CartesianRepresentation with the correct unit, or the special value
[0, 0, 0]
.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.