Checks if Region A and Region B polygons overlap and calculates the percentage of Region A overlapped by Region B.
Syntax
intl pipCheckForRegionOverlapEx ( pipOverlapHandle over_h, intl
numIncrements, double* percentage );
Arguments
over_h
pipOverlapHandle from pipInitializeOverlapCheck. Input.
numIncrements
Number of increments used in the overlap percentage calculation. Input.
percentage
Calculated overlap percentage. Output.
Return Value
PIP_ERROR
PIP_NO_REGION_OVERLAP
PIP_REGION_OVERLAP
PIP_REGION_A_IN_B
PIP_REGION_B_IN_A
PIP_REGION_A_EQUALS_B
Prerequisites
pipAddRegionAPolygon, pipAddRegionBPolygon
Alternates
pipObjectFindFirstPolygonEx, pipCheckForRegionOverlap
Notes
This function compares two regions and evaluates the nature of their overlap (if any). If the number of increments is greater than 0 and percentage is not NULL, this function computes the percentage of Region A covered by Region B.
The accuracy and precision of the calculation increases as the number of increments is increased. Note that increasing the number of increments also increases processing time.