Skip to content

affine_trans_regionaffine_trans_regionAffineTransRegionAffineTransRegionaffine_trans_regionT_affine_trans_region🔗

Short description🔗

affine_trans_regionaffine_trans_regionAffineTransRegionAffineTransRegionaffine_trans_regionT_affine_trans_region — Apply an arbitrary affine 2D transformation to regions.

Signature🔗

affine_trans_region( region Region, out region RegionAffineTrans, hom_mat2d HomMat2D, string Interpolate )affine_trans_region( Region : RegionAffineTrans : HomMat2D, Interpolate : )void AffineTransRegion( const HObject& Region, HObject* RegionAffineTrans, const HTuple& HomMat2D, const HTuple& Interpolate )static void HOperatorSet.AffineTransRegion( HObject region, out HObject regionAffineTrans, HTuple homMat2D, HTuple interpolate )def affine_trans_region( region: HObject, hom_mat_2d: Sequence[float], interpolate: str ) -> HObject

Herror T_affine_trans_region( const Hobject Region, Hobject* RegionAffineTrans, const Htuple HomMat2D, const Htuple Interpolate )

HRegion HRegion::AffineTransRegion( const HHomMat2D& HomMat2D, const HString& Interpolate ) const

HRegion HRegion::AffineTransRegion( const HHomMat2D& HomMat2D, const char* Interpolate ) const

HRegion HRegion::AffineTransRegion( const HHomMat2D& HomMat2D, const wchar_t* Interpolate ) const (Windows only)

HRegion HHomMat2D::AffineTransRegion( const HRegion& Region, const HString& Interpolate ) const

HRegion HHomMat2D::AffineTransRegion( const HRegion& Region, const char* Interpolate ) const

HRegion HHomMat2D::AffineTransRegion( const HRegion& Region, const wchar_t* Interpolate ) const (Windows only)

HRegion HRegion.AffineTransRegion( HHomMat2D homMat2D, string interpolate )

HRegion HHomMat2D.AffineTransRegion( HRegion region, string interpolate )

Description🔗

affine_trans_regionAffineTransRegion applies an arbitrary affine 2D transformation, i.e., scaling, rotation, translation, and slant (skewing), to the regions given in Regionregionregion and returns the transformed regions in RegionAffineTransregionAffineTransregion_affine_trans. The affine transformation is described by the homogeneous transformation matrix given in HomMat2DhomMat2Dhom_mat_2d, which can be created using the operators hom_mat2d_identityHomMat2dIdentity, hom_mat2d_scaleHomMat2dScale, hom_mat2d_rotateHomMat2dRotate, hom_mat2d_translateHomMat2dTranslate, etc., or be the result of operators like vector_angle_to_rigidVectorAngleToRigid.

The components of the homogeneous transformation matrix are interpreted as follows: The row coordinate of the image corresponds to \(x\) and the column coordinate corresponds to \(y\) of the coordinate system in which the transformation matrix was defined. This is necessary to obtain a right-handed coordinate system for the image. In particular, this assures that rotations are performed in the correct direction. Note that the (\(x\),\(y\)) order of the matrices quite naturally corresponds to the usual (row,column) order for coordinates in the image.

The parameter Interpolateinterpolateinterpolate determines whether the transformation is to be done by using interpolation internally. The interpolation modes 'nearest_neighbor'"nearest_neighbor" and 'constant'"constant", which are described in detail for affine_trans_imageAffineTransImage, can be used. An interpolation can lead to smoother region boundaries, especially if regions are enlarged. However, the runtime increases drastically.

Attention🔗

affine_trans_regionAffineTransRegion in general is not reversible (clipping and discretization during rotation and scaling).

affine_trans_regionAffineTransRegion does not use the HALCON standard coordinate system (with the origin in the center of the upper left pixel), but instead uses the same coordinate system as in affine_trans_pixelAffineTransPixel, i.e., the origin lies in the upper left corner of the upper left pixel. Therefore, applying affine_trans_regionAffineTransRegion corresponds to a chain of transformations (see affine_trans_pixelAffineTransPixel), which is applied to each point of the region (input and output pixels as homogeneous vectors). As an effect, you might get unexpected results when creating affine transformations based on coordinates that are derived from the region, e.g., by operators like area_centerAreaCenter. For example, if you use this operator to calculate the center of gravity of a rotationally symmetric region and then rotate the region around this point using hom_mat2d_rotateHomMat2dRotate, the resulting region will not lie on the original one. In such a case, you can compensate this effect by applying the following translations to HomMat2DhomMat2Dhom_mat_2d before using it in affine_trans_regionAffineTransRegion:

 
hom_mat2d_translate(HomMat2D, 0.5, 0.5, HomMat2DTmp)
hom_mat2d_translate_local(HomMat2DTmp, -0.5, -0.5, HomMat2DAdapted)
affine_trans_region(Region, RegionAffineTrans, HomMat2DAdapted, 'nearest_neighbor')

For an explanation of the different 2D coordinate systems used in HALCON, see the introduction of chapter Transformations / 2D Transformations.

Execution information🔗

Execution information
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Automatically parallelized on tuple level.

  • Automatically parallelized on internal data level.

Parameters🔗

Regionregionregion (input_object) region(-array) → objectobjectHObjectHRegionHObjectHobject

Region(s) to be rotated and scaled.

RegionAffineTransregionAffineTransregion_affine_trans (output_object) region(-array) → objectobjectHObjectHRegionHObjectHobject *

Transformed output region(s).

Number of elements: RegionAffineTrans == Region

HomMat2DhomMat2Dhom_mat_2d (input_control) hom_mat2d → (real)(real)HTuple (double)HHomMat2D, HTuple (double)Sequence[float]Htuple (double)

Input transformation matrix.

Interpolateinterpolateinterpolate (input_control) string → (string)(string)HTuple (HString)HTuple (string)strHtuple (char*)

Should the transformation be done using interpolation?

Default: 'nearest_neighbor'"nearest_neighbor"
List of values: 'constant', 'nearest_neighbor'"constant", "nearest_neighbor"

Result🔗

If the matrix HomMat2DhomMat2Dhom_mat_2d represents an affine transformation (i.e., not a projective transformation), affine_trans_regionAffineTransRegion returns 2 (H_MSG_TRUE). The clipping according to the global image size is set via the operator set_system('clip_region',<'true'/'false'>). The behavior in case of empty input (no regions given) can be set via set_system('no_object_result',<Result>), the behavior in case of an empty input region via set_system('empty_region_result',<Result>), and the behavior in case of an empty result region via set_system('store_empty_region',<'true'/'false'>). If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

hom_mat2d_identityHomMat2dIdentity, hom_mat2d_scaleHomMat2dScale, hom_mat2d_translateHomMat2dTranslate, hom_mat2d_invertHomMat2dInvert, hom_mat2d_rotateHomMat2dRotate, hom_mat2d_reflectHomMat2dReflect

Possible successors

select_shapeSelectShape

Alternatives

move_regionMoveRegion, mirror_regionMirrorRegion, zoom_regionZoomRegion

See also

affine_trans_imageAffineTransImage

Module🔗

Foundation