next up previous 264
Next: AST_STCSCHAN - Create an StcsChan
Up: AST Routine Descriptions
Previous: AST_STCOBSDATALOCATION - Create a StcObsDataLocation


AST_STCRESOURCEPROFILE - Create a StcResourceProfile

Description:
This function creates a new StcResourceProfile and optionally initialises its attributes.

The StcResourceProfile class is a sub-class of Stc used to describe the coverage of the datasets contained in some VO resource.

See http://hea-www.harvard.edu/$\sim$arots/nvometa/STC.html

Invocation:
RESULT = AST_STCRESOURCEPROFILE( REGION, NCOORDS, COORDS, OPTIONS, STATUS )
Arguments:
REGION = INTEGER (Given)
Pointer to the encapsulated Region.
NCOORDS = INTEGER (Given)
The length of the COORDS array. Supply zero if COORDS should be ignored.
COORDS( NCOORDS ) = INTEGER (Given)
An array holding NCOORDS AstKeyMap pointers (if NCOORDS is zero, the supplied value is ignored). Each supplied KeyMap describes the contents of a single STC $<$AstroCoords$>$ element, and should have elements with keys given by constants AST__STCNAME, AST__STCVALUE, AST__STCERROR, AST__STCRES, AST__STCSIZE, AST__STCPIXSZ. Any of these elements may be omitted, but no other elements should be included. If supplied, the AST__STCNAME element should be a vector of character string pointers holding the "Name" item for each axis in the coordinate system represented by REGION. Any other supplied elements should be scalar elements, each holding a pointer to a Region describing the associated item of ancillary information (error, resolution, size, pixel size or value). These Regions should describe a volume within the coordinate system represented by REGION.
OPTIONS = CHARACTER $*$ ( $*$ ) (Given)
A character string containing an optional comma-separated list of attribute assignments to be used for initialising the new StcResourceProfile. The syntax used is identical to that for the AST_SET routine.
STATUS = INTEGER (Given and Returned)
The global status.
Returned Value:
AST_STCRESOURCEPROFILE = INTEGER
A pointer to the new StcResourceProfile.
Notes:
  • A deep copy is taken of the supplied Region. This means that any subsequent changes made to the encapsulated Region using the supplied pointer will have no effect on the Stc.

  • 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.
Status Handling
The protected interface to this function includes an extra parameter at the end of the parameter list descirbed above. This parameter is a pointer to the integer inherited status variable: "int $*$status".


next up previous 264
Next: AST_STCSCHAN - Create an StcsChan
Up: AST Routine Descriptions
Previous: AST_STCOBSDATALOCATION - Create a StcObsDataLocation

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