- ←Prev
- AST
A Library for Handling
World Coordinate Systems
in Astronomy - Next→
- TOC ↑
Description:
This
function returns a pointer to a specified
Frame in a
FrameSet.
Invocation
RESULT = AST_GETFRAME(
THIS, IFRAME, STATUS )
Arguments
THIS = INTEGER (Given)
Pointer to the FrameSet.
IFRAME = INTEGER (Given)
The index of the required Frame within the FrameSet. This value
should lie in the range from 1 to the number of Frames in the FrameSet (as given by its
Nframe attribute).
STATUS = INTEGER (Given and Returned)
The global status.
Returned Value
AST_GETFRAME = INTEGER
A pointer to the requested Frame.
Notes:
-
A value of AST__BASE or AST__CURRENT may be given for the IFRAME argument to specify the
base Frame or the current Frame respectively.
-
This function increments the RefCount attribute of the selected Frame by one.
-
A null Object pointer (AST__NULL) will be returned if this function is invoked with STATUS set to an
error value, or if it should fail for any reason.
Copyright (C) 2021 East Asian Observatory
- ←Prev
- AST
A Library for Handling
World Coordinate
Systems
in Astronomy - Next→
- TOC ↑