next up previous 264
Next: astGetRegionMesh - Return a mesh of points covering the surface or volume of a Region
Up: AST Function Descriptions
Previous: astGetRegionBounds - Returns the bounding box of Region


astGetRegionFrame - Obtain a pointer to the encapsulated Frame within a Region

Description:
This function returns a pointer to the Frame represented by a Region.
Synopsis:
AstFrame $*$astGetRegionFrame( AstRegion $*$this )
Parameters:
this
Pointer to the Region.
Returned Value:
astGetRegionFrame()
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 the AST error status set, or if it should fail for any reason.


next up previous 264
Next: astGetRegionMesh - Return a mesh of points covering the surface or volume of a Region
Up: AST Function Descriptions
Previous: astGetRegionBounds - Returns the bounding box of Region

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

Copyright (C) 2009 Science \& Technology Facilities Council