km3astro.frame
¶
Module Contents¶
Classes¶
The base class for coordinate frames. |
|
The base class for coordinate frames. |
Functions¶
|
|
|
Calculate the converge angle on the UTM grid. |
|
The UTM zone for a given latitude |
|
The longitude of the central meridian for a given UTM zone. |
|
|
|
|
|
|
|
|
|
|
|
Attributes¶
- km3astro.frame.convergence_angle(lat, lon)[source]¶
Calculate the converge angle on the UTM grid.
- Parameters:
- lonnumber
Longitude in rad
- latnumber
Latitude in rad
- km3astro.frame.utm_zone(lat)[source]¶
The UTM zone for a given latitude
- Parameters:
- latnumber
Latitude in rad
- km3astro.frame.longitude_of_central_meridian(utmzone)[source]¶
The longitude of the central meridian for a given UTM zone.
- Parameters:
- utmzonenumber
The UTM zone.
- class km3astro.frame.ParticleFrame(*args, copy=True, representation_type=None, differential_type=None, **kwargs)[source]¶
The base class for coordinate frames.
This class is intended to be subclassed to create instances of specific systems. Subclasses can implement the following attributes:
- default_representation
A subclass of ~astropy.coordinates.BaseRepresentation that will be treated as the default representation of this frame. This is the representation assumed by default when the frame is created.
- default_differential
A subclass of ~astropy.coordinates.BaseDifferential that will be treated as the default differential class of this frame. This is the differential class assumed by default when the frame is created.
- ~astropy.coordinates.Attribute class attributes
Frame attributes such as
FK4.equinox
orFK4.obstime
are defined using a descriptor class. See the narrative documentation or built-in classes code for details.
- frame_specific_representation_info
A dictionary mapping the name or class of a representation to a list of ~astropy.coordinates.RepresentationMapping objects that tell what names and default units should be used on this frame for the components of that representation.
Unless overridden via frame_specific_representation_info, velocity name defaults are:
pm_{lon}_cos{lat}
,pm_{lat}
for SphericalCosLatDifferential proper motion componentspm_{lon}
,pm_{lat}
for SphericalDifferential proper motion componentsradial_velocity
for anyd_distance
componentv_{x,y,z}
for CartesianDifferential velocity components
where
{lon}
and{lat}
are the frame names of the angular components.
- class km3astro.frame.UTM(*args, copy=True, representation_type=None, differential_type=None, **kwargs)[source]¶
The base class for coordinate frames.
This class is intended to be subclassed to create instances of specific systems. Subclasses can implement the following attributes:
- default_representation
A subclass of ~astropy.coordinates.BaseRepresentation that will be treated as the default representation of this frame. This is the representation assumed by default when the frame is created.
- default_differential
A subclass of ~astropy.coordinates.BaseDifferential that will be treated as the default differential class of this frame. This is the differential class assumed by default when the frame is created.
- ~astropy.coordinates.Attribute class attributes
Frame attributes such as
FK4.equinox
orFK4.obstime
are defined using a descriptor class. See the narrative documentation or built-in classes code for details.
- frame_specific_representation_info
A dictionary mapping the name or class of a representation to a list of ~astropy.coordinates.RepresentationMapping objects that tell what names and default units should be used on this frame for the components of that representation.
Unless overridden via frame_specific_representation_info, velocity name defaults are:
pm_{lon}_cos{lat}
,pm_{lat}
for SphericalCosLatDifferential proper motion componentspm_{lon}
,pm_{lat}
for SphericalDifferential proper motion componentsradial_velocity
for anyd_distance
componentv_{x,y,z}
for CartesianDifferential velocity components
where
{lon}
and{lat}
are the frame names of the angular components.