Next: AST_GETREGIONMESH - Return a mesh of points covering the surface or volume of a Region
Up: AST Routine Descriptions
Previous: AST_GETREGIONBOUNDS - Returns the bounding box of Region
AST_GETREGIONFRAME
-
Obtain a pointer to the encapsulated Frame within a Region
- Description:
- This function returns a pointer to the Frame represented by a
Region.
- Invocation:
- RESULT = AST_GETREGIONFRAME( THIS, STATUS )
- Arguments:
-
THIS = INTEGER (Given)
-
Pointer to the Region.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Returned Value:
-
AST_GETREGIONFRAME = INTEGER
-
A pointer to a deep copy of the Frame represented by the Region.
Using this pointer to modify the Frame will have no effect on
the Region. To modify the Region, use the Region pointer directly.
- Notes:
- 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.
Next: AST_GETREGIONMESH - Return a mesh of points covering the surface or volume of a Region
Up: AST Routine Descriptions
Previous: AST_GETREGIONBOUNDS - Returns the bounding box of Region
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