Operator Reference

HALCON Operator Reference / Tuple / Features
ClassesClasses | | Operators

tuple_histo_rangeT_tuple_histo_rangeTupleHistoRangeTupleHistoRangetuple_histo_range (Operator)

tuple_histo_rangeT_tuple_histo_rangeTupleHistoRangeTupleHistoRangetuple_histo_range — Calculate the value distribution of a tuple within a certain value range.

Signature

tuple_histo_range( : : Tuple, Min, Max, NumBins : Histo, BinSize)

Herror T_tuple_histo_range(const Htuple Tuple, const Htuple Min, const Htuple Max, const Htuple NumBins, Htuple* Histo, Htuple* BinSize)

void TupleHistoRange(const HTuple& Tuple, const HTuple& Min, const HTuple& Max, const HTuple& NumBins, HTuple* Histo, HTuple* BinSize)

HTuple HTuple::TupleHistoRange(const HTuple& Min, const HTuple& Max, const HTuple& NumBins, HTuple* BinSize) const

static void HOperatorSet.TupleHistoRange(HTuple tuple, HTuple min, HTuple max, HTuple numBins, out HTuple histo, out HTuple binSize)

HTuple HTuple.TupleHistoRange(HTuple min, HTuple max, HTuple numBins, out HTuple binSize)

def tuple_histo_range(tuple: Sequence[Union[float, int]], min: Union[float, int], max: Union[float, int], num_bins: int) -> Tuple[Sequence[int], float]

def tuple_histo_range_s(tuple: Sequence[Union[float, int]], min: Union[float, int], max: Union[float, int], num_bins: int) -> Tuple[int, float]

Description

tuple_histo_rangetuple_histo_rangeTupleHistoRangeTupleHistoRangetuple_histo_range calculates the value distribution HistoHistoHistohistohisto of the TupleTupleTupletupletuple within the value range [MinMinMinminmin,MaxMaxMaxmaxmax]. The values for MinMinMinminmin and MaxMaxMaxmaxmax are rounded down to the next integer if all entries of the TupleTupleTupletupletuple are of type integer. The value range is divided into NumBinsNumBinsNumBinsnumBinsnum_bins bins of the same size, which is returned in BinSizeBinSizeBinSizebinSizebin_size. If a value lies between two bins the value is assigned to the smaller bin. If the TupleTupleTupletupletuple has entries of type real . If all entries are of type integer the size of a bin is computed with .

Exception: Empty input tuples

If any of the input tuples is empty, an exception is raised.

Attention

If all the data of the TupleTupleTupletupletuple are of type integer the value of BinSizeBinSizeBinSizebinSizebin_size may cause the following effects: For BinSizeBinSizeBinSizebinSizebin_size > 1 multiple consecutive numbers are assigned to the same bin. If BinSizeBinSizeBinSizebinSizebin_size is no integer the numbers are distributed uneven among the bins, e.g., for BinSizeBinSizeBinSizebinSizebin_size = 1.5 the first and second number are assigned to the first bin, the third number is assigned to the second bin, and the fourth and fifth number are assigned to the third bin. This becomes noticeable in several peeks in the histogram HistoHistoHistohistohisto. If BinSizeBinSizeBinSizebinSizebin_size < 1 some classes are not assigned by any number, e.g., for BinSizeBinSizeBinSizebinSizebin_size = 0.5 the first number is assigned to the first bin and the second number is assigned to the third bin. The histogram HistoHistoHistohistohisto shows some gaps, which resembles the structure of a comb.

If the TupleTupleTupletupletuple has entries of type real and MinMinMinminmin = MaxMaxMaxmaxmax, all entries of the corresponding value are assigned only to the first bin.

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

TupleTupleTupletupletuple (input_control)  number-array → HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Input tuple.

MinMinMinminmin (input_control)  number → HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Minimum value.

MaxMaxMaxmaxmax (input_control)  number → HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Maximum value.

Restriction: Max >= Min

NumBinsNumBinsNumBinsnumBinsnum_bins (input_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of bins.

Restriction: NumBins >= 1

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

Histogram to be calculated.

BinSizeBinSizeBinSizebinSizebin_size (output_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Bin size.

Result

If the parameters are valid, the operator tuple_histo_rangetuple_histo_rangeTupleHistoRangeTupleHistoRangetuple_histo_range returns the value 2 ( H_MSG_TRUE) . If necessary an exception is raised.

Possible Predecessors

tuple_mintuple_minTupleMinTupleMintuple_min, tuple_maxtuple_maxTupleMaxTupleMaxtuple_max

Possible Successors

create_funct_1d_arraycreate_funct_1d_arrayCreateFunct1dArrayCreateFunct1dArraycreate_funct_1d_array

See also

gray_histogray_histoGrayHistoGrayHistogray_histo, gray_histo_absgray_histo_absGrayHistoAbsGrayHistoAbsgray_histo_abs, gray_histo_rangegray_histo_rangeGrayHistoRangeGrayHistoRangegray_histo_range

Module

Foundation

ClassesClasses | | Operators