next up previous 264
Next: AST_REMOVECOLUMN - Remove a column from a table
Up: AST Routine Descriptions
Previous: AST_REBINSEQX - Rebin a region of a sequence of data grids


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

Description:
This routine 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 routine.

Invocation:
CALL AST_REMAPFRAME( THIS, IFRAME, MAP, STATUS )
Arguments:
THIS = INTEGER (Given)
Pointer to the FrameSet.
IFRAME = INTEGER (Given)
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 = INTEGER (Given)
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.
STATUS = INTEGER (Given and Returned)
The global status.
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.

  • The relationship between the selected Frame and any other Frame within the FrameSet will be modified by this routine, 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 AST_PERMAXES routine may provide a more straightforward method of making the required changes to the FrameSet.

  • This routine cannot be used to change the number of Frame axes. To achieve this, a new Frame must be added to the FrameSet (AST_ADDFRAME) and the original one removed if necessary (AST_REMOVEFRAME).


next up previous 264
Next: AST_REMOVECOLUMN - Remove a column from a table
Up: AST Routine Descriptions
Previous: AST_REBINSEQX - Rebin a region of a sequence of data grids

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

Copyright (C) 2009 Science \& Technology Facilities Council