CartesianRepresentationAttribute#
- class astropy.coordinates.CartesianRepresentationAttribute(default=None, secondary_attribute='', unit=None, **kwargs)[source]#
Bases:
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.- unitastropy:unit-like or
None
Name of a unit that the input will be converted into. If None, no unit-checking or conversion is performed
- doc
str
Description of the frame attribute for help and documentation
- 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:
- Raises:
ValueError
If the input is not valid for this attribute.