find_neighborsT_find_neighborsFindNeighborsFindNeighbors (Operator)

Name

find_neighborsT_find_neighborsFindNeighborsFindNeighbors — Search direct neighbors.

Signature

Description

The operator find_neighborsfind_neighborsFindNeighborsFindNeighborsFindNeighbors determines neighboring regions with Regions1Regions1Regions1Regions1regions1 and Regions2Regions2Regions2Regions2regions2 containing the regions to be examined. Regions1Regions1Regions1Regions1regions1 can have three different states:

• Regions1Regions1Regions1Regions1regions1 is empty:
  In this case all regions in Regions2Regions2Regions2Regions2regions2 are permutatively checked for neighborhood.

• Regions1Regions1Regions1Regions1regions1 consists of one region:
  The regions of Regions1Regions1Regions1Regions1regions1 are compared to all regions in Regions2Regions2Regions2Regions2regions2.

• Regions1Regions1Regions1Regions1regions1 consists of the same number of regions as Regions2Regions2Regions2Regions2regions2:
  Here all regions at the n-th position in Regions1Regions1Regions1Regions1regions1 and Regions2Regions2Regions2Regions2regions2 are checked for the neighboring relation.

The operator find_neighborsfind_neighborsFindNeighborsFindNeighborsFindNeighbors uses the chessboard distance between neighboring regions. It can be specified by the parameter MaxDistanceMaxDistanceMaxDistanceMaxDistancemaxDistance. Neighboring regions are located at the n-th position in RegionIndex1RegionIndex1RegionIndex1RegionIndex1regionIndex1 and RegionIndex2RegionIndex2RegionIndex2RegionIndex2regionIndex2, i.e., the region with index RegionIndex1RegionIndex1RegionIndex1RegionIndex1regionIndex1[n] from Regions1Regions1Regions1Regions1regions1 is the neighbor of the region with index RegionIndex2RegionIndex2RegionIndex2RegionIndex2regionIndex2[n] from Regions2Regions2Regions2Regions2regions2.

Attention

Covered regions are not found!

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

The operator find_neighborsfind_neighborsFindNeighborsFindNeighborsFindNeighbors returns the value 2 (H_MSG_TRUE) if the input is not empty. The behavior in case of empty input (no input regions available) is set via the operator set_system('no_object_result',<Result>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>). The behavior in case of empty region (the region is the empty set) is set via set_system('empty_region_result',<Result>)set_system("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>). If necessary an exception is raised.

Possible Predecessors

thresholdthresholdThresholdThresholdThreshold, regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowing, connectionconnectionConnectionConnectionConnection

See also

spatial_relationspatial_relationSpatialRelationSpatialRelationSpatialRelation, select_region_spatialselect_region_spatialSelectRegionSpatialSelectRegionSpatialSelectRegionSpatial, expand_regionexpand_regionExpandRegionExpandRegionExpandRegion, distance_transformdistance_transformDistanceTransformDistanceTransformDistanceTransform, interjacentinterjacentInterjacentInterjacentInterjacent, boundaryboundaryBoundaryBoundaryBoundary

Module

Foundation