next up previous
Next: Invert - Mapping inversion flag
Up: AST Attribute Descriptions
Previous: Ident - Permanent Object identification string

IntraFlag - IntraMap identification string   

Description:
This attribute allows an IntraMap to be flagged so that it is distinguishable from other IntraMaps. The transformation routine associated with the IntraMap may then enquire the value of this attribute and adapt the transformation it provides according to the particular IntraMap involved.

Although this is a string attribute, it may often be useful to store numerical values here, encoded as a character string, and to use these as data within the transformation routine. Note, however, that this mechanism is not suitable for transferring large amounts of data (more than about 1000 characters) to an IntraMap. For that purpose, global variables are recommended, although the IntraFlag value can be used to supplement this approach. The default IntraFlag value is an empty string.

Type:
String.

Class Applicability:
IntraMap
All IntraMaps have this attribute.

Notes:
  • A pair of IntraMaps whose transformations may potentially cancel cannot be simplified to produce a UnitMap (e.g. using AST_SIMPLIFY) unless they have the same IntraFlag values. The test for equality is case-sensitive.



next up previous
Next: Invert - Mapping inversion flag
Up: AST Attribute Descriptions
Previous: Ident - Permanent Object identification string

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

Copyright (C) 2003 Central Laboratory of the Research Councils