next up previous
Next: astRemoveFrame - Remove a Frame from a FrameSet
Up: AST Function Descriptions
Previous: astRead - Read an Object from a Channel

   
astRemapFrame - Modify a Frame's relationship to other Frames in a FrameSet

Description:
This function modifies the relationship (i.e. Mapping) between a specified Frame in a FrameSet and the other Frames in that FrameSet.

Typically, this might be required if the FrameSet has been used to calibrate (say) an image, and that image is re-binned. The Frame describing the image will then have undergone a coordinate transformation, and this should be communicated to the associated FrameSet using this function.

Synopsis:
void astRemapFrame( AstFrameSet *this, int iframe, AstMapping *map )

Parameters:
this
Pointer to the FrameSet.
iframe
The index within the FrameSet of the Frame to be modified. This value should lie in the range from 1 to the number of Frames in the FrameSet (as given by its Nframe attribute).
map
Pointer to a Mapping whose forward transformation converts coordinate values from the original coordinate system described by the Frame to the new one, and whose inverse transformation converts in the opposite direction.

Notes:
  • A value of AST__BASE or AST__CURRENT may be given for the "iframe" parameter to specify the base Frame or the current Frame respectively.
  • The relationship between the selected Frame and any other Frame within the FrameSet will be modified by this function, but the relationship between all other Frames in the FrameSet remains unchanged.
  • The number of input coordinate values accepted by the Mapping (its Nin attribute) and the number of output coordinate values generated (its Nout attribute) must be equal and must match the number of axes in the Frame being modified.
  • If a simple change of axis order is required, then the astPermAxes function may provide a more straightforward method of making the required changes to the FrameSet.
  • This function cannot be used to change the number of Frame axes. To achieve this, a new Frame must be added to the FrameSet (astAddFrame) and the original one removed if necessary (astRemoveFrame).



next up previous
Next: astRemoveFrame - Remove a Frame from a FrameSet
Up: AST Function Descriptions
Previous: astRead - Read an Object from a Channel

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 211
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