StcsAreaStcsArea
-
Return the CoordinateArea component when reading an STC-S document?
- Description:
- This is a boolean attribute which controls what is returned
by the
astReadastRead
function when it is used to read from an StcsChanStcsChan.
If StcsArea is set non-zero (the default), then a RegionRegion
representing the STC CoordinateArea will be returned by
astRead.
If StcsArea is set to zero, then the STC CoordinateArea
will not be returned.
- Type:
- Integer (boolean).
- Class Applicability:
-
StcsChan
-
All StcsChans have this attribute.
- Notes:
- Other attributes such as StcsCoordsStcsCoords and StcsPropsStcsProps 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 ObjectObject returned by
astRead
will be a KeyMapKeyMap, containing the requested Objects. In this
case, the Region representing the STC CoordinateArea will be
stored in the returned KeyMap using the key "AREA". If StcsArea
is the only attribute to be set non-zero, then the Object returned by
astRead
will be the CoordinateArea Region itself.
- The class of Region used to represent the CoordinateArea for each
STC-S sub-phrase is determined by the first word in the
sub-phrase (the "sub-phrase identifier"). The individual sub-phrase
Regions are combined into a single PrismPrism, which is then simplified
using astSimplifyastSimplify
to form the returned region.
- Sub-phrases that represent a single value ( that is, have
identifiers "Time", "Position", "Spectral" or "Redshift" ) are
considered to be be part of the STC CoordinateArea component.
- The TimeFrameTimeFrame used to represent a time STC-S sub-phrase will have
its TimeOriginTimeOrigin attribute set to the sub-phrase start time. If no
start time is specified by the sub-phrase, then the stop time will be
used instead. If no stop time is specified by the sub-phrase, then
the single time value specified in the sub-phrase will be used
instead. Subsequently clearing the TimeOrigin attribute (or setting
its value to zero) will cause the TimeFrame to reprsent absolute times.
- The EpochEpoch attribute for the returned Region is set in the same
way as the TimeOrigin attribute (see above).