find_neighborsT_find_neighborsFindNeighborsFindNeighborsfind_neighbors (Operator)

Name

find_neighborsT_find_neighborsFindNeighborsFindNeighborsfind_neighbors — Search direct neighbors.

Signature

Description

The operator find_neighborsfind_neighborsFindNeighborsFindNeighborsFindNeighborsfind_neighbors determines neighboring regions with Regions1Regions1Regions1Regions1regions1regions_1 and Regions2Regions2Regions2Regions2regions2regions_2 containing the regions to be examined. Regions1Regions1Regions1Regions1regions1regions_1 can have three different states:

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

• Regions1Regions1Regions1Regions1regions1regions_1 consists of one region:
  The regions of Regions1Regions1Regions1Regions1regions1regions_1 are compared to all regions in Regions2Regions2Regions2Regions2regions2regions_2.

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

The operator find_neighborsfind_neighborsFindNeighborsFindNeighborsFindNeighborsfind_neighbors uses the chessboard distance between neighboring regions. It can be specified by the parameter MaxDistanceMaxDistanceMaxDistanceMaxDistancemaxDistancemax_distance. Neighboring regions are located at the n-th position in RegionIndex1RegionIndex1RegionIndex1RegionIndex1regionIndex1region_index_1 and RegionIndex2RegionIndex2RegionIndex2RegionIndex2regionIndex2region_index_2, i.e., the region with index RegionIndex1RegionIndex1RegionIndex1RegionIndex1regionIndex1region_index_1[n] from Regions1Regions1Regions1Regions1regions1regions_1 is the neighbor of the region with index RegionIndex2RegionIndex2RegionIndex2RegionIndex2regionIndex2region_index_2[n] from Regions2Regions2Regions2Regions2regions2regions_2.

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_neighborsFindNeighborsFindNeighborsFindNeighborsfind_neighbors 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>)set_system("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>)set_system("empty_region_result",<Result>). If necessary an exception is raised.

Possible Predecessors

thresholdthresholdThresholdThresholdThresholdthreshold, regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowingregiongrowing, connectionconnectionConnectionConnectionConnectionconnection

See also

spatial_relationspatial_relationSpatialRelationSpatialRelationSpatialRelationspatial_relation, select_region_spatialselect_region_spatialSelectRegionSpatialSelectRegionSpatialSelectRegionSpatialselect_region_spatial, expand_regionexpand_regionExpandRegionExpandRegionExpandRegionexpand_region, distance_transformdistance_transformDistanceTransformDistanceTransformDistanceTransformdistance_transform, interjacentinterjacentInterjacentInterjacentInterjacentinterjacent, boundaryboundaryBoundaryBoundaryBoundaryboundary

Module

Foundation