- ←Prev
- AST
A Library for Handling
World Coordinate Systems
in Astronomy - Next→
- TOC ↑
Description:
This routine returns a
logical value indicating if a supplied point is inside a supplied
Region.
Invocation
RESULT =
AST_POINTINREGION( THIS, POINT, STATUS )
Arguments
THIS = INTEGER (Given)
Pointer to the Region.
POINT( )
= DOUBLE PRECISION (Given)
An array holding the axis values of the point to be tested. The
number of values in this array should match the number of axes in the supplied Region.
STATUS =
INTEGER (Given and Returned)
The global status.
Returned Value
AST_POINTINREGION =
LOGICAL
.FALSE. if the point is outside the Region, and .TRUE. otherwise.
Notes:
-
If the supplied value is AST__BAD on every axis, then .FALSE. is always returned.
-
If many points need to be tested, then it is usually more efficient to use the Region as a Mapping to
transform all the points. This can be done using one of the Mapping transformation methods
(AST_TRANX).
If a transformed axis value is AST__BAD then the corresponding input point is outside the
Region.
-
.FALSE. will be returned if an error occurs.
Copyright (C) 2021 East Asian Observatory
- ←Prev
- AST
A Library for Handling
World Coordinate
Systems
in Astronomy - Next→
- TOC ↑