spatial_relationT_spatial_relationSpatialRelationSpatialRelationspatial_relation (Operator)

Name

spatial_relationT_spatial_relationSpatialRelationSpatialRelationspatial_relation — Pose relation of regions with regard to the coordinate axes.

Signature

Description

The operator spatial_relationspatial_relationSpatialRelationSpatialRelationSpatialRelationspatial_relation selects regions located by PercentPercentPercentPercentpercentpercent percent “left”, “right”, “above” or “below” other regions. Regions1Regions1Regions1Regions1regions1regions_1 and Regions2Regions2Regions2Regions2regions2regions_2 contain the regions to be compared. Regions1Regions1Regions1Regions1regions1regions_1 can have three states:

• Regions1Regions1Regions1Regions1regions1regions_1 contains an empty object tuple, i.e., count_objcount_objCountObjCountObjCountObjcount_obj returns 0:
  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:
  Regions1Regions1Regions1Regions1regions1regions_1 and Regions2Regions2Regions2Regions2regions2regions_2 are checked for a neighboring relation.

The percentage PercentPercentPercentPercentpercentpercent is interpreted in such a way that the area of the second region has to be located really left/right or above/below the region margins of the first region by at least PercentPercentPercentPercentpercentpercent percent. The indices of the regions that fulfill at least one of these conditions are then located at the n-th position in the output parameters RegionIndex1RegionIndex1RegionIndex1RegionIndex1regionIndex1region_index_1 and RegionIndex2RegionIndex2RegionIndex2RegionIndex2regionIndex2region_index_2. Additionally the output parameters Relation1Relation1Relation1Relation1relation1relation_1 and Relation2Relation2Relation2Relation2relation2relation_2 contain at the n-th position the type of relation of the region pair (RegionIndex1RegionIndex1RegionIndex1RegionIndex1regionIndex1region_index_1[n], RegionIndex2RegionIndex2RegionIndex2RegionIndex2regionIndex2region_index_2[n]), i.e., region with index RegionIndex2RegionIndex2RegionIndex2RegionIndex2regionIndex2region_index_2[n] has the relation Relation1Relation1Relation1Relation1relation1relation_1[n] and Relation2Relation2Relation2Relation2relation2relation_2[n] with region with index RegionIndex1RegionIndex1RegionIndex1RegionIndex1regionIndex1region_index_1[n].

Possible values for Relation1Relation1Relation1Relation1relation1relation_1 and Relation2Relation2Relation2Relation2relation2relation_2 are:

• Relation1Relation1Relation1Relation1relation1relation_1: 'left'"left""left""left""left""left", 'right'"right""right""right""right""right" or ''""""""""""

• Relation2Relation2Relation2Relation2relation2relation_2: 'above'"above""above""above""above""above", 'below'"below""below""below""below""below" or ''""""""""""

In RegionIndex1RegionIndex1RegionIndex1RegionIndex1regionIndex1region_index_1 and RegionIndex2RegionIndex2RegionIndex2RegionIndex2regionIndex2region_index_2 the indices of the regions in the tuples of the input regions (Regions1Regions1Regions1Regions1regions1regions_1 or Regions2Regions2Regions2Regions2regions2regions_2), respectively, are entered as image identifiers. Access to chosen regions via the index can be obtained by the operator copy_objcopy_objCopyObjCopyObjCopyObjcopy_obj.

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 spatial_relationspatial_relationSpatialRelationSpatialRelationSpatialRelationspatial_relation returns the value 2 ( H_MSG_TRUE) if Regions2Regions2Regions2Regions2regions2regions_2 is not empty and PercentPercentPercentPercentpercentpercent is correctly chosen. The behavior in case of empty parameter Regions2Regions2Regions2Regions2regions2regions_2 (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

Alternatives

area_centerarea_centerAreaCenterAreaCenterAreaCenterarea_center, intersectionintersectionIntersectionIntersectionIntersectionintersection

See also

select_region_spatialselect_region_spatialSelectRegionSpatialSelectRegionSpatialSelectRegionSpatialselect_region_spatial, find_neighborsfind_neighborsFindNeighborsFindNeighborsFindNeighborsfind_neighbors, copy_objcopy_objCopyObjCopyObjCopyObjcopy_obj, obj_to_integerobj_to_integerObjToIntegerObjToIntegerObjToIntegerobj_to_integer

Module

Foundation