Name
tuple_histo_rangeT_tuple_histo_rangeTupleHistoRangetuple_histo_rangeTupleHistoRangeTupleHistoRange — Calculate the value distribution of a tuple within a certain value range.
Herror tuple_histo_range(const HTuple& Tuple, const HTuple& Min, const HTuple& Max, const HTuple& NumBins, Hlong* Histo, double* BinSize)
Herror tuple_histo_range(const HTuple& Tuple, const HTuple& Min, const HTuple& Max, const HTuple& NumBins, HTuple* Histo, HTuple* BinSize)
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 devided 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
BinSizeBinSizeBinSizeBinSizeBinSizebinSize = (MaxMaxMaxMaxMaxmax - MinMinMinMinMinmin) / NumBinsNumBinsNumBinsNumBinsNumBinsnumBins
. If all entries are of type integer the size of a bin is
computed with
BinSizeBinSizeBinSizeBinSizeBinSizebinSize = (MaxMaxMaxMaxMaxmax - MinMinMinMinMinmin + 1) /
NumBinsNumBinsNumBinsNumBinsNumBinsnumBins.
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.
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
MinMinMinMinMinmin (input_control) real → HTupleHTupleHTupleVARIANTHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong) (double / Hlong) (double / Hlong)
Minimum value.
MaxMaxMaxMaxMaxmax (input_control) real → HTupleHTupleHTupleVARIANTHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong) (double / Hlong) (double / Hlong)
Maximum value.
Restriction: Max >= Min
Number of bins.
Restriction: NumBins >= 1
Histogram to be calculated.
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.
tuple_mintuple_minTupleMintuple_minTupleMinTupleMin,
tuple_maxtuple_maxTupleMaxtuple_maxTupleMaxTupleMax
create_funct_1d_arraycreate_funct_1d_arrayCreateFunct1dArraycreate_funct_1d_arrayCreateFunct1dArrayCreateFunct1dArray
gray_histogray_histoGrayHistogray_histoGrayHistoGrayHisto,
gray_histo_absgray_histo_absGrayHistoAbsgray_histo_absGrayHistoAbsGrayHistoAbs,
gray_histo_rangegray_histo_rangeGrayHistoRangegray_histo_rangeGrayHistoRangeGrayHistoRange
Foundation