next up previous
Next: RestFreq - The rest frequency
Up: AST Attribute Descriptions
Previous: RefRA - The right ascension of the reference point

Report - Report transformed coordinates?   

Description:
This attribute controls whether coordinate values are reported whenever a Mapping is used to transform a set of points. If its value is zero (the default), no report is made. However, if it is non-zero, the coordinates of each point are reported (both before and after transformation) by writing them to standard output.

This attribute is provided as an aid to debugging, and to avoid having to report values explicitly in simple programs.

Type:
Integer (boolean).

Class Applicability:
Mapping
All Mappings have this attribute.
CmpMap
When applied to a compound Mapping (CmpMap), only the Report attribute of the CmpMap, and not those of its component Mappings, is used. Coordinate information is never reported for the component Mappings individually, only for the complete CmpMap.
Frame
When applied to any Frame, the formatting capabilities of the Frame (as provided by the astFormat function) will be used to format the reported coordinates.
FrameSet
When applied to any FrameSet, the formatting capabilities of the base and current Frames will be used (as above) to individually format the input and output coordinates, as appropriate. The Report attribute of a FrameSet is not itself affected by selecting a new base or current Frame, but the resulting formatting capabilities may be.

Notes:
  • Unlike most other attributes, the value of the Report attribute is not transferred when a Mapping is copied. Instead, its value is undefined (and therefore defaults to zero) in any copy. Similarly, it becomes undefined in any external representation of a Mapping produced by the astWrite function.



next up previous
Next: RestFreq - The rest frequency
Up: AST Attribute Descriptions
Previous: RefRA - The right ascension of the reference point

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 211
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