RadialDifferential¶
- class astropy.coordinates.RadialDifferential(*args, **kwargs)[source]¶
Bases:
BaseDifferential
Differential(s) of radial distances.
- Parameters:
Attributes Summary
Component 'd_distance' of the Differential.
Methods Summary
from_cartesian
(other, base)Convert the differential from 3D rectangular cartesian coordinates to the desired class.
from_representation
(representation[, base])Create a new instance of this representation from another one.
norm
([base])Vector norm.
to_cartesian
(base)Convert the differential to 3D rectangular cartesian coordinates.
Attributes Documentation
- attr_classes = {'d_distance': <class 'astropy.units.quantity.Quantity'>}¶
- d_distance¶
Component ‘d_distance’ of the Differential.
Methods Documentation
- classmethod from_cartesian(other, base)[source]¶
Convert the differential from 3D rectangular cartesian coordinates to the desired class.
- Parameters:
- other
The object to convert into this differential.
- base
BaseRepresentation
The points for which the differentials are to be converted: each of the components is multiplied by its unit vectors and scale factors. Will be converted to
cls.base_representation
if needed.
- Returns:
BaseDifferential
subclass instanceA new differential object that is this class’ type.
- classmethod from_representation(representation, base=None)[source]¶
Create a new instance of this representation from another one.
- Parameters:
- representation
BaseRepresentation
instance The presentation that should be converted to this class.
- baseinstance of
cls.base_representation
The base relative to which the differentials will be defined. If the representation is a differential itself, the base will be converted to its
base_representation
to help convert it.
- representation
- norm(base=None)[source]¶
Vector norm.
The norm is the standard Frobenius norm, i.e., the square root of the sum of the squares of all components with non-angular units.
- Parameters:
- baseinstance of
self.base_representation
Base relative to which the differentials are defined. This is required to calculate the physical size of the differential for all but Cartesian differentials or radial differentials.
- baseinstance of
- Returns:
- norm
astropy.units.Quantity
Vector norm, with the same shape as the representation.
- norm
- to_cartesian(base)[source]¶
Convert the differential to 3D rectangular cartesian coordinates.
- Parameters:
- baseinstance of
self.base_representation
The points for which the differentials are to be converted: each of the components is multiplied by its unit vectors and scale factors.
- baseinstance of
- Returns:
CartesianDifferential
This object, converted.