next up previous 264
Next: StdOfRest - Standard of rest
Up: AST Attribute Descriptions
Previous: StcsLength - Controls output line length


StcsProps - Return all properties when reading an STC-S document?

Description:
This is a boolean attribute which controls what is returned by the astRead function when it is used to read from an StcsChan. If StcsProps is set non-zero, then a KeyMap containing all the properties read from the STC-S document will be returned by astRead. If StcsProps is set to zero (the default), then the properties will not be returned.
Type:
Integer (boolean).
Class Applicability:
StcsChan
All StcsChans have this attribute.
Notes:
  • Other attributes such as StcsCoords and StcsArea can be used to specify other Objects to be returned by astRead. If more than one of these attributes is set non-zero, then the actual Object returned by astRead will be a KeyMap containing the requested Objects. In this case, the properties KeyMap will be stored in the returned KeyMap using the key "PROPS". If StcsProps is the only attribute to be set non-zero, then the Object returned by astRead will be the properties KeyMap itself.

  • The KeyMap containing the properties will have entries for one or more of the following keys: "TIME_PROPS", "SPACE_PROPS", "SPECTRAL_PROPS" and "REDSHIFT_PROPS". Each of these entries will be another KeyMap containing the properties of the corresponding STC-S sub-phrase.


next up previous 264
Next: StdOfRest - Standard of rest
Up: AST Attribute Descriptions
Previous: StcsLength - Controls output line length

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