next up previous 264
Next: astGetStcNCoord - Return the number of AstroCoords elements stored in an Stc
Up: AST Function Descriptions
Previous: astGetRegionPoints - Returns the positions that define the given Region


astGetStcCoord - Return information about an AstroCoords element stored in an Stc

Description:
When any sub-class of Stc is created, the constructor function allows one or more AstroCoords elements to be stored within the Stc. This function allows any one of these AstroCoords elements to be retrieved. The format of the returned information is the same as that used to pass the original information to the Stc constructor. That is, the information is returned in a KeyMap structure containing elements with one or more of the keys given by symbolic constants AST__STCNAME, AST__STCVALUE, AST__STCERROR, AST__STCRES, AST__STCSIZE and AST__STCPIXSZ.

If the coordinate system represented by the Stc has been changed since it was created (for instance, by changing its System attribute), then the sizes and positions in the returned KeyMap will reflect the change in coordinate system.

Synopsis:
AstKeyMap $*$astGetStcCoord( AstStc $*$this, int icoord )
Parameters:
this
Pointer to the Stc.
icoord
The index of the AstroCoords element required. The first has index one. The number of AstroCoords elements in the Stc can be found using function astGetStcNcoord.
Returned Value:
astGetStcCoord()
A pointer to a new KeyMap containing the required information.
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: astGetStcNCoord - Return the number of AstroCoords elements stored in an Stc
Up: AST Function Descriptions
Previous: astGetRegionPoints - Returns the positions that define the given 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