next up previous
Next: FrameSet - Set of inter-related coordinate systems
Up: AST Class Descriptions
Previous: FitsChan - I/O Channel using FITS header cards to represent Objects

Frame - Coordinate system description   

Description:
This class is used to represent coordinate systems. It does this in rather the same way that a frame around a graph describes the coordinate space in which data are plotted. Consequently, a Frame has a Title (string) attribute, which describes the coordinate space, and contains axes which in turn hold information such as Label and Units strings which are used for labelling (e.g.) graphical output. In general, however, the number of axes is not restricted to two.

Functions are available for converting Frame coordinate values into a form suitable for display, and also for calculating distances and offsets between positions within the Frame.

Frames may also contain knowledge of how to transform to and from related coordinate systems.

Constructor Function:
AST_FRAME

Notes:
  • When used as a Mapping, a Frame implements a unit (null) transformation in both the forward and inverse directions (equivalent to a UnitMap). The Nin and Nout attribute values are both equal to the number of Frame axes.

Inheritance
The Frame class inherits from the Mapping class.

Attributes
In addition to those attributes common to all Mappings, every Frame also has the following attributes:

Functions
In addition to those routines applicable to all Mappings, the following routines may also be applied to all Frames:

  • AST_ANGLE: Find the angle subtended by two points at a third point
  • AST_AXANGLE: Find the angle from an axis, to a line through two points
  • AST_AXDISTANCE: Calculate the distance between two axis values
  • AST_AXOFFSET: Calculate an offset along an axis
  • AST_CONVERT: Determine how to convert between two coordinate systems
  • AST_DISTANCE: Calculate the distance between two points in a Frame
  • AST_FINDFRAME: Find a coordinate system with specified characteristics
  • AST_FORMAT: Format a coordinate value for a Frame axis
  • AST_GETACTIVEUNIT: Determines how the Unit attribute will be used
  • AST_NORM: Normalise a set of Frame coordinates
  • AST_OFFSET: Calculate an offset along a geodesic curve
  • AST_OFFSET2: Calculate an offset along a geodesic curve in a 2D Frame
  • AST_PERMAXES: Permute the order of a Frame's axes
  • AST_PICKAXES: Create a new Frame by picking axes from an existing one
  • AST_RESOLVE: Resolve a vector into two orthogonal components
  • AST_SETACTIVEUNIT: Specify how the Unit attribute should be used
  • AST_UNFORMAT: Read a formatted coordinate value for a Frame axis



next up previous
Next: FrameSet - Set of inter-related coordinate systems
Up: AST Class Descriptions
Previous: FitsChan - I/O Channel using FITS header cards to represent Objects

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 210
R.F. Warren-Smith & D.S. Berry
30th April 2003
E-mail:ussc@star.rl.ac.uk

Copyright (C) 2003 Central Laboratory of the Research Councils