Obtain a Mapping that converts between two Frames in a FrameSet astGetMapping
"
input"
end of the Mapping. "
output"
end of
the Mapping. The returned Mapping will include the clipping effect of any Regions which occur on the path between the two supplied Frames (this includes the two supplied Frames themselves).
The values given for the "
iframe1"
and "
iframe2"
parameters should lie in the range
from 1 to the number of Frames in the FrameSet (as given by its Nframe attribute). A
value of AST__BASE or AST__CURRENT may also be given to identify the FrameSet’
s
base Frame or current Frame respectively. It is permissible for both these
parameters to have the same value, in which case a unit Mapping (UnitMap) is
returned.
It should always be possible to generate the Mapping requested, but this does necessarily guarantee that it will be able to perform the required coordinate conversion. If necessary, the TranForward and TranInverse attributes of the returned Mapping should be inspected to determine if the required transformation is available.
A null Object pointer (AST__NULL) will be returned if this function is invoked with the AST error status set, or if it should fail for any reason.