tuple_histo_rangeT_tuple_histo_rangeTupleHistoRangetuple_histo_rangeTupleHistoRangeTupleHistoRange (Operator)

Name

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

Signature

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

Description

gray_histo_rangegray_histo_rangeGrayHistoRangegray_histo_rangeGrayHistoRangeGrayHistoRange calculates the value distribution HistoHistoHistoHistoHistohisto of the TupleTupleTupleTupleTupletuple within the value range [MinMinMinMinMinmin,MaxMaxMaxMaxMaxmax]. The values for MinMinMinMinMinmin and MaxMaxMaxMaxMaxmax are rounded down to the next integer if all entries of the TupleTupleTupleTupleTupletuple are of type integer. The value range is divided into NumBinsNumBinsNumBinsNumBinsNumBinsnumBins bins of the same size, which is returned in BinSizeBinSizeBinSizeBinSizeBinSizebinSize. If a value lies between two bins the value is assigned to the smaller bin. If the TupleTupleTupleTupleTupletuple 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.

If all the data of the TupleTupleTupleTupleTupletuple are of type integer the value of BinSizeBinSizeBinSizeBinSizeBinSizebinSize may cause the following effects: For BinSizeBinSizeBinSizeBinSizeBinSizebinSize > 1 multiple consecutive numbers are assigned to the same bin. If BinSizeBinSizeBinSizeBinSizeBinSizebinSize is no integer the numbers are distributed uneven among the bins, e.g., for BinSizeBinSizeBinSizeBinSizeBinSizebinSize = 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 HistoHistoHistoHistoHistohisto. If BinSizeBinSizeBinSizeBinSizeBinSizebinSize < 1 some classes are not assigned by any number, e.g., for BinSizeBinSizeBinSizeBinSizeBinSizebinSize = 0.5 the first number is assigned to the first bin and the second number is assigned to the third bin. The histogram HistoHistoHistoHistoHistohisto shows some gaps, which resembles the structure of a comb.

If the TupleTupleTupleTupleTupletuple has entries of type real and MinMinMinMinMinmin = MaxMaxMaxMaxMaxmax, all entries of the corresponding value are assigned only to the first bin.

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

TupleTupleTupleTupleTupletuple (input_control) real-array → (real / integer)

Input tuple.

MinMinMinMinMinmin (input_control) real → (real / integer)

Minimum value.

MaxMaxMaxMaxMaxmax (input_control) real → (real / integer)

Maximum value.

Restriction: Max >= Min

NumBinsNumBinsNumBinsNumBinsNumBinsnumBins (input_control) integer → (integer)

Number of bins.

Restriction: NumBins >= 1

HistoHistoHistoHistoHistohisto (output_control) histogram(-array) → (integer)

Histogram to be calculated.

BinSizeBinSizeBinSizeBinSizeBinSizebinSize (output_control) real → (real)

Bin size.

Result

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