AST_OVERLAP

Test if two regions overlap each other

Description:

This function returns an integer value indicating if the two supplied Regions overlap. The two Regions are converted to a commnon coordinate system before performing the check. If this conversion is not possible (for instance because the two Regions represent areas in different domains), then the check cannot be performed and a zero value is returned to indicate this.

Invocation

RESULT = AST_OVERLAP( THIS, THAT, STATUS )

Arguments

THIS = INTEGER (Given)
Pointer to the first Region.
THAT = INTEGER (Given)
Pointer to the second Region.
STATUS = INTEGER (Given and Returned)
The global status.

Returned Value

AST_OVERLAP = INTEGER
A value indicating if there is any overlap between the two Regions. Possible values are:

0 - The check could not be performed because the second Region could not be mapped into the coordinate system of the first Region.

1 - There is no overlap between the two Regions.

2 - The first Region is completely inside the second Region.

3 - The second Region is completely inside the first Region.

4 - There is partial overlap between the two Regions.

5 - The Regions are identical to within their uncertainties.

6 - The second Region is the exact negation of the first Region to within their uncertainties.

Notes:

Copyright (C) 2021 East Asian Observatory