FocalPlaneCoordinates

class sofia_redux.scan.coordinate_systems.focal_plane_coordinates.FocalPlaneCoordinates(coordinates=None, unit='degree', copy=True)[source]

Bases: SphericalCoordinates

Initialize focal plane coordinates.

The focal plane coordinates are spherical coordinates used to represent coordinates on the plane perpendicular to the axis containing the focal point.

Parameters:
coordinateslist or tuple or array-like or units.Quantity, optional

The coordinates used to populate the object during initialization. The first (0) value or index should represent longitudinal coordinates, and the second should represent latitude.

unitunits.Unit or str, optional

The angular unit for the spherical coordinates. The default is ‘degree’.

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.

Attributes Summary

fits_latitude_stem

Return the FITS latitude stem string.

fits_longitude_stem

Return the FITS longitude stem string.

two_letter_code

Return the two-letter code for the coordinate system.

Methods Summary

copy()

Return a copy of the focal-plane coordinates.

edit_header(header, key_stem[, alt])

Edit the header with focal plane coordinate information.

setup_coordinate_system()

Setup the system for the coordinates.

Attributes Documentation

fits_latitude_stem

Return the FITS latitude stem string.

Returns:
stemstr
fits_longitude_stem

Return the FITS longitude stem string.

Returns:
stemstr
two_letter_code

Return the two-letter code for the coordinate system.

Returns:
codestr

Methods Documentation

copy()[source]

Return a copy of the focal-plane coordinates.

Returns:
FocalPlaneCoordinates
edit_header(header, key_stem, alt='')[source]

Edit the header with focal plane coordinate information.

Parameters:
headerastropy.io.fits.header.Header

The header to modify.

key_stemstr

The name of the header key to update.

altstr, optional

The alternative coordinate system.

Returns:
None
setup_coordinate_system()[source]

Setup the system for the coordinates.

Returns:
None