GroundFrame#

class ctapipe.coordinates.GroundFrame(*args, copy=True, representation_type=None, differential_type=None, **kwargs)[source]#

Bases: BaseCoordinateFrame

Ground coordinate frame.

The ground coordinate frame is a simple cartesian frame describing the 3 dimensional position of objects compared to the array ground level in relation to the nominal center of the array.

Typically this frame will be used for describing the position of telescopes, equipment and shower impact coordinates.

In this frame x points north, y points west and z is meters above array center.

Frame attributes: None

Attributes Summary

default_differential

Default representation for differential data (e.g., velocity)

default_representation

Default representation for position data

frame_attributes

frame_specific_representation_info

Mapping for frame-specific component names

name

observation_level

Height of the reference location

reference_location

A frame attribute

Methods Summary

from_earth_location(location, reference_location)

Convert EarthLocation into Groundframe.

to_earth_location()

Convert this GroundFrame coordinate into an astropy.coordinates.EarthLocation

Attributes Documentation

default_differential#

Default representation for differential data (e.g., velocity)

default_representation#

Default representation for position data

frame_attributes = {'reference_location': <astropy.coordinates.attributes.EarthLocationAttribute object>}#
frame_specific_representation_info#

Mapping for frame-specific component names

name = 'groundframe'#
observation_level#

Height of the reference location

reference_location#

A frame attribute

No default value

Methods Documentation

classmethod from_earth_location(location, reference_location)[source]#

Convert EarthLocation into Groundframe.

Parameters:
locationastropy.coordinates.EarthLocation

The location to convert

reference_locationastropy.coordinates.EarthLocation

Reference location for the GroundFrame

Returns:
ground_frameGroundFrame

EarthLocation converted to GroundFrame

to_earth_location()[source]#

Convert this GroundFrame coordinate into an astropy.coordinates.EarthLocation

This requires that the reference_location is set.