Offset2D

class sofia_redux.scan.coordinate_systems.offset_2d.Offset2D(reference, coordinates=None, unit=None, copy=True)[source]

Bases: Coordinate2D

Initialize a 2-dimensional offset.

The 2D offset is an extension of the Coordinate2D that represents (x, y) coordinates in relation to a given 2-dimensional reference coordinate.

Parameters:
referenceCoordinate2D or numpy.ndarray or units.Quantity

The reference (x, y) coordinate(s).

coordinatesCoordinate2D or units.Quantity or numpy.ndarray, optional

Offset coordinates from the reference position.

unitunits.Unit or str, optional

The angular unit for the spherical coordinates.

copybool, optional

Whether to explicitly perform a copy operation on the input coordinates when storing them into these coordinates. Note that it is extremely unlikely for the original coordinates to be passed in as a reference due to the significant checks performed on them.

Methods Summary

get_coordinate_class()

Return the coordinate class of the reference position.

Methods Documentation

get_coordinate_class()[source]

Return the coordinate class of the reference position.

Returns:
class