next up previous
Next: Higher Level Operations on FrameSets
Up: Coordinate System Networks (FrameSets)
Previous: Extracting a Frame from a FrameSet

Removing a Frame from a FrameSet

Removing a Frame from a FrameSet is straightforward and is performed using the AST_REMOVEFRAME routine. You identify the Frame you wish to remove in the usual way, by giving its index within the FrameSet. For example, the following would remove the Frame with index 1:

      CALL AST_REMOVEFRAME( FRAMESET, 1, STATUS );

The only restriction is that you cannot remove the last remaining Frame because a FrameSet must always contain at least one Frame. When a Frame is removed, the Frames which follow it are re-numbered (i.e. their indices are reduced by one) so as to preserve the sequence of consecutive Frame indices. The FrameSet's Nframe attribute is also decremented.

If appropriate, AST_REMOVEFRAME will modify the FrameSet's Base and/or Current attributes so that they continue to identify the same Frames as previously. If either the base or current Frame is removed, however, the corresponding attribute will become un-set, so that it reverts to its default value ([*]) and therefore identifies an alternative Frame.

Note that it is quite permissible to remove any Frame from a FrameSet, even although other Frames may appear to depend on it. For example, in Figure [*], if Frame 1 were removed, the correct relationship between Frames 2 and 3 would still be preserved, although they would be re-numbered as Frames 1 and 2.



next up previous
Next: Higher Level Operations on FrameSets
Up: Coordinate System Networks (FrameSets)
Previous: Extracting a Frame from a FrameSet

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