BaseRepresentation¶

class
astropy.coordinates.
BaseRepresentation
(*args, differentials=None, **kwargs)[source]¶ Bases:
astropy.coordinates.BaseRepresentationOrDifferential
Base for representing a point in a 3D coordinate system.
 Parameters
 comp1, comp2, comp3
Quantity
or subclass The components of the 3D points. The names are the keys and the subclasses the values of the
attr_classes
attribute. differentialsdict,
BaseDifferential
, optional Any differential classes that should be associated with this representation. The input must either be a single
BaseDifferential
subclass instance, or a dictionary with keys set to a string representation of the SI unit with which the differential (derivative) is taken. For example, for a velocity differential on a positional representation, the key would be's'
for seconds, indicating that the derivative is a time derivative. copybool, optional
If
True
(default), arrays will be copied rather than referenced.
 comp1, comp2, comp3
Notes
All representation classes should subclass this base representation class, and define an
attr_classes
attribute, anOrderedDict
which maps component names to the class that creates them. They must also define ato_cartesian
method and afrom_cartesian
class method. By default, transformations are done via the cartesian system, but classes that want to define a smarter transformation path can overload therepresent_as
method. If one wants to use an associated differential class, one should also defineunit_vectors
andscale_factors
methods (see those methods for details).Attributes Summary
A dictionary of differential class instances.
Deprecated since version 3.0.
The shape of the instance and underlying arrays.
Methods Summary
cross
(self, other)Vector cross product of two representations.
dot
(self, other)Dot product of two representations.
from_representation
(representation)Create a new instance of this representation from another one.
mean
(self, \*args, \*\*kwargs)Vector mean.
norm
(self)Vector norm.
represent_as
(self, other_class[, …])Convert coordinates to another representation.
scale_factors
(self)Scale factors for each component’s direction.
sum
(self, \*args, \*\*kwargs)Vector sum.
unit_vectors
(self)Cartesian unit vectors in the direction of each component.
with_differentials
(self, differentials)Create a new representation with the same positions as this representation, but with these new differentials.
without_differentials
(self)Return a copy of the representation without attached differentials.
Attributes Documentation

differentials
¶ A dictionary of differential class instances.
The keys of this dictionary must be a string representation of the SI unit with which the differential (derivative) is taken. For example, for a velocity differential on a positional representation, the key would be
's'
for seconds, indicating that the derivative is a time derivative.

recommended_units
¶ Deprecated since version 3.0: The recommended_units attribute is deprecated and may be removed in a future version.

shape
¶ The shape of the instance and underlying arrays.
Like
shape
, can be set to a new shape by assigning a tuple. Note that if different instances share some but not all underlying data, setting the shape of one instance can make the other instance unusable. Hence, it is strongly recommended to get new, reshaped instances with thereshape
method. Raises
 AttributeError
If the shape of any of the components cannot be changed without the arrays being copied. For these cases, use the
reshape
method (which copies any arrays that cannot be reshaped inplace).
Methods Documentation

cross
(self, other)[source]¶ Vector cross product of two representations.
The calculation is done by converting both
self
andother
toCartesianRepresentation
, and converting the result back to the type of representation ofself
. Parameters
 otherrepresentation
The representation to take the cross product with.
 Returns
 cross_productrepresentation
With vectors perpendicular to both
self
andother
, in the same type of representation asself
.

dot
(self, other)[source]¶ Dot product of two representations.
The calculation is done by converting both
self
andother
toCartesianRepresentation
.Note that any associated differentials will be dropped during this operation.
 Parameters
 other
BaseRepresentation
The representation to take the dot product with.
 other
 Returns
 dot_product
Quantity
The sum of the product of the x, y, and z components of the cartesian representations of
self
andother
.
 dot_product

classmethod
from_representation
(representation)[source]¶ Create a new instance of this representation from another one.
 Parameters
 representation
BaseRepresentation
instance The presentation that should be converted to this class.
 representation

mean
(self, *args, **kwargs)[source]¶ Vector mean.
Averaging is done by converting the representation to cartesian, and taking the mean of the x, y, and z components. The result is converted back to the same representation as the input.
Refer to
mean
for full documentation of the arguments, noting thataxis
is the entry in theshape
of the representation, and that theout
argument cannot be used. Returns
 meanrepresentation
Vector mean, in the same representation as that of the input.

norm
(self)[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 nonangular units.
Note that any associated differentials will be dropped during this operation.
 Returns
 norm
astropy.units.Quantity
Vector norm, with the same shape as the representation.
 norm

represent_as
(self, other_class, differential_class=None)[source]¶ Convert coordinates to another representation.
If the instance is of the requested class, it is returned unmodified. By default, conversion is done via cartesian coordinates.
 Parameters
 other_class
BaseRepresentation
subclass The type of representation to turn the coordinates into.
 differential_classdict of
BaseDifferential
, optional Classes in which the differentials should be represented. Can be a single class if only a single differential is attached, otherwise it should be a
dict
keyed by the same keys as the differentials.
 other_class

scale_factors
(self)[source]¶ Scale factors for each component’s direction.
Given unit vectors \(\hat{e}_c\) and scale factors \(f_c\), a change in one component of \(\delta c\) corresponds to a change in representation of \(\delta c \times f_c \times \hat{e}_c\).
 Returns
 scale_factorsdict of
Quantity
The keys are the component names.
 scale_factorsdict of

sum
(self, *args, **kwargs)[source]¶ Vector sum.
Adding is done by converting the representation to cartesian, and summing the x, y, and z components. The result is converted back to the same representation as the input.
Refer to
sum
for full documentation of the arguments, noting thataxis
is the entry in theshape
of the representation, and that theout
argument cannot be used. Returns
 sumrepresentation
Vector sum, in the same representation as that of the input.

unit_vectors
(self)[source]¶ Cartesian unit vectors in the direction of each component.
Given unit vectors \(\hat{e}_c\) and scale factors \(f_c\), a change in one component of \(\delta c\) corresponds to a change in representation of \(\delta c \times f_c \times \hat{e}_c\).
 Returns
 unit_vectorsdict of
CartesianRepresentation
The keys are the component names.
 unit_vectorsdict of

with_differentials
(self, differentials)[source]¶ Create a new representation with the same positions as this representation, but with these new differentials.
Differential keys that already exist in this object’s differential dict are overwritten.
 Parameters
 differentialsSequence of
BaseDifferential
The differentials for the new representation to have.
 differentialsSequence of
 Returns
 newrepr
A copy of this representation, but with the
differentials
as its differentials.