CartesianRepresentationAttribute¶
-
class
astropy.coordinates.
CartesianRepresentationAttribute
(default=None, secondary_attribute='', unit=None)[source]¶ 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
python:str
Name of a secondary instance attribute which supplies the value if
default is None
and no value was supplied during initialization.- unitunit-like or
python:None
Name of a unit that the input will be converted into. If None, no unit-checking or conversion is performed
- default
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]¶ 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.
- value
- Returns
- out
object
The correctly-typed object.
- convertedbool
A boolean which indicates if conversion was actually performed.
- out
- Raises
ValueError
If the input is not valid for this attribute.