RadialDifferential

class astropy.coordinates.RadialDifferential(*args, **kwargs)[source]

Bases: astropy.coordinates.BaseDifferential

Differential(s) of radial distances.

Parameters
d_distanceQuantity

The differential distance.

copybool, optional

If True (default), arrays will be copied. If False, arrays will be references, though possibly broadcast to ensure matching shapes.

Attributes Summary

attr_classes

d_distance

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.

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.

Returns
A 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
representationBaseRepresentation 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.

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.

Returns
normastropy.units.Quantity

Vector norm, with the same shape as the representation.

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.

Returns
This object as a CartesianDifferential