Skip to content

hamming_distanceHammingDistanceHammingDistancehamming_distancehamming_distance🔗

Short description🔗

hamming_distanceHammingDistanceHammingDistancehamming_distancehamming_distance — Hamming distance between two regions.

Signature🔗

hamming_distance( region Regions1, region Regions2, out integer Distance, out real Similarity )void HammingDistance( const HObject& Regions1, const HObject& Regions2, HTuple* Distance, HTuple* Similarity )static void HOperatorSet.HammingDistance( HObject regions1, HObject regions2, out HTuple distance, out HTuple similarity )def hamming_distance( regions_1: HObject, regions_2: HObject ) -> Tuple[Sequence[int], Sequence[float]]

def hamming_distance_s( regions_1: HObject, regions_2: HObject ) -> Tuple[int, float]Herror hamming_distance( const Hobject Regions1, const Hobject Regions2, Hlong* Distance, double* Similarity )

Herror T_hamming_distance( const Hobject Regions1, const Hobject Regions2, Htuple* Distance, Htuple* Similarity )

HTuple HRegion::HammingDistance( const HRegion& Regions2, HTuple* Similarity ) const

Hlong HRegion::HammingDistance( const HRegion& Regions2, double* Similarity ) const

HTuple HRegion.HammingDistance( HRegion regions2, out HTuple similarity )

int HRegion.HammingDistance( HRegion regions2, out double similarity )

Description🔗

The operator hamming_distanceHammingDistance returns the hamming distance between two regions, i.e., the number of pixels of the regions which are different (Distancedistancedistance), i.e., the number of pixels contained in one region but not in the other:

\[\begin{eqnarray*} \textrm{Distance} = |\textrm{Regions1} \cap \overline{\textrm{Regions2}}| + |\textrm{Regions2} \cap \overline{\textrm{Regions1}}| \end{eqnarray*}\]

The parameter Similaritysimilaritysimilarity describes the similarity between the two regions based on the hamming distance Distancedistancedistance:

\[\begin{eqnarray*} \textrm{Similarity} = 1 - \frac{\textrm{Distance}} {|\textrm{Regions1}| + |\textrm{Regions2}|} \end{eqnarray*}\]

If both regions are empty Similaritysimilaritysimilarity is set to 0. The regions with the same index from both input parameters are always compared.

Attention🔗

In both input parameters the same number of regions must be passed.

Execution information🔗

Execution information

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

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

Parameters🔗

Regions1regions1regions_1 (input_object) region(-array) → objectHObjectHRegionHObjectHobject

Regions to be examined.

Regions2regions2regions_2 (input_object) region(-array) → objectHObjectHRegionHObjectHobject

Comparative regions.

Distancedistancedistance (output_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

Hamming distance of two regions.

Assertion: Distance >= 0

Similaritysimilaritysimilarity (output_control) real(-array) → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Similarity of two regions.

Assertion: 0 <= Similarity && Similarity <= 1

Complexity🔗

If \(F\) is the area of a region the mean runtime complexity is \(O(\sqrt{F})\).

Result🔗

hamming_distance returns the value 2 (H_MSG_TRUE) if the number of objects in both parameters is the same and is not 0. The behavior in case of empty input (no input objects available) is set via the operator 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>). If necessary an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

thresholdThreshold, regiongrowingRegiongrowing, connectionConnection

Alternatives

intersectionIntersection, complementComplement, area_centerAreaCenter

See also

hamming_change_regionHammingChangeRegion

Module🔗

Foundation