HALCON Website / HALCON Operator Reference / Regions / Features
ClassesClasses | | Operators

runlength_featuresrunlength_featuresRunlengthFeaturesRunlengthFeaturesrunlength_features (Operator)

Name

runlength_featuresrunlength_featuresRunlengthFeaturesRunlengthFeaturesrunlength_features — Characteristic values for runlength coding of regions.

Signature

runlength_features(Regions : : : NumRuns, KFactor, LFactor, MeanLength, Bytes)

Herror runlength_features(const Hobject Regions, Hlong* NumRuns, double* KFactor, double* LFactor, double* MeanLength, Hlong* Bytes)

Herror T_runlength_features(const Hobject Regions, Htuple* NumRuns, Htuple* KFactor, Htuple* LFactor, Htuple* MeanLength, Htuple* Bytes)

void RunlengthFeatures(const HObject& Regions, HTuple* NumRuns, HTuple* KFactor, HTuple* LFactor, HTuple* MeanLength, HTuple* Bytes)

HTuple HRegion::RunlengthFeatures(HTuple* KFactor, HTuple* LFactor, HTuple* MeanLength, HTuple* Bytes) const

Hlong HRegion::RunlengthFeatures(double* KFactor, double* LFactor, double* MeanLength, Hlong* Bytes) const

static void HOperatorSet.RunlengthFeatures(HObject regions, out HTuple numRuns, out HTuple KFactor, out HTuple LFactor, out HTuple meanLength, out HTuple bytes)

HTuple HRegion.RunlengthFeatures(out HTuple KFactor, out HTuple LFactor, out HTuple meanLength, out HTuple bytes)

int HRegion.RunlengthFeatures(out double KFactor, out double LFactor, out double meanLength, out int bytes)

def runlength_features(regions: HObject) -> Tuple[Sequence[int], Sequence[float], Sequence[float], Sequence[float], Sequence[int]]

def runlength_features_s(regions: HObject) -> Tuple[int, float, float, float, int]

Description

The operator runlength_featuresrunlength_featuresRunlengthFeaturesRunlengthFeaturesRunlengthFeaturesrunlength_features calculates for every input region from RegionsRegionsRegionsRegionsregionsregions the number of runs necessary for storing this region with the aid of runlength coding. Furthermore the so-called “K-factor” is determined, which indicates by how much the number of runs differs from the ideal of the square in which this value is 1.0.

The K-factor (KFactorKFactorKFactorKFactorKFactorkfactor) is calculated according to the formula: wherein Area indicates the area of the region. It should be noted that the K-factor can be smaller than 1.0 (in case of long horizontal regions).

The L-factor (LFactorLFactorLFactorLFactorLFactorlfactor) indicates the mean number of runs for each line index occurring in the region.

MeanLengthMeanLengthMeanLengthMeanLengthmeanLengthmean_length indicates the mean length of the runs. The parameter BytesBytesBytesBytesbytesbytes indicates how many bytes are necessary for coding the region with runlengths.

Attention

All features calculated by the operator runlength_featuresrunlength_featuresRunlengthFeaturesRunlengthFeaturesRunlengthFeaturesrunlength_features are not rotation invariant because the runlength coding depends on the direction. The operator runlength_featuresrunlength_featuresRunlengthFeaturesRunlengthFeaturesRunlengthFeaturesrunlength_features does not serve for calculating shape features but for controlling and analyzing the efficiency of the runlength coding.

Execution Information

Parameters

RegionsRegionsRegionsRegionsregionsregions (input_object)  region(-array) → objectHRegionHObjectHRegionHobject

Regions to be examined.

NumRunsNumRunsNumRunsNumRunsnumRunsnum_runs (output_control)  integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of runs.

Assertion: 0 <= NumRuns

KFactorKFactorKFactorKFactorKFactorkfactor (output_control)  real(-array) → HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Storing factor in relation to a square.

Assertion: 0 <= KFactor

LFactorLFactorLFactorLFactorLFactorlfactor (output_control)  real(-array) → HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Mean number of runs per line.

Assertion: 0 <= LFactor

MeanLengthMeanLengthMeanLengthMeanLengthmeanLengthmean_length (output_control)  real(-array) → HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Mean length of runs.

Assertion: 0 <= MeanLength

BytesBytesBytesBytesbytesbytes (output_control)  integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of bytes necessary for coding the region.

Assertion: 0 <= Bytes

Complexity

The mean runtime complexity is O(1).

Result

The operator runlength_featuresrunlength_featuresRunlengthFeaturesRunlengthFeaturesRunlengthFeaturesrunlength_features returns the value TRUE if the input is not empty. If necessary an exception is raised.

Possible Predecessors

thresholdthresholdThresholdThresholdThresholdthreshold, regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowingregiongrowing, connectionconnectionConnectionConnectionConnectionconnection

See also

runlength_distributionrunlength_distributionRunlengthDistributionRunlengthDistributionRunlengthDistributionrunlength_distribution

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 20.11.4.0 Copyright © 1996-2023 MVTec Software GmbH