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.


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]


tuple_histo_rangetuple_histo_rangeTupleHistoRangeTupleHistoRangeTupleHistoRangetuple_histo_range 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 NumBinsNumBinsNumBinsNumBinsnumBinsnum_bins bins of the same size, which is returned in BinSizeBinSizeBinSizeBinSizebinSizebin_size. 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 BinSizeBinSizeBinSizeBinSizebinSizebin_size may cause the following effects: For BinSizeBinSizeBinSizeBinSizebinSizebin_size > 1 multiple consecutive numbers are assigned to the same bin. If BinSizeBinSizeBinSizeBinSizebinSizebin_size is no integer the numbers are distributed uneven among the bins, e.g., for BinSizeBinSizeBinSizeBinSizebinSizebin_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 HistoHistoHistoHistohistohisto. If BinSizeBinSizeBinSizeBinSizebinSizebin_size < 1 some classes are not assigned by any number, e.g., for BinSizeBinSizeBinSizeBinSizebinSizebin_size = 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.

Execution Information


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

Input tuple.

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

Minimum value.

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

Maximum value.

Restriction: Max >= Min

NumBinsNumBinsNumBinsNumBinsnumBinsnum_bins (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of bins.

Restriction: NumBins >= 1

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

Histogram to be calculated.

BinSizeBinSizeBinSizeBinSizebinSizebin_size (output_control)  real HTuplefloatHTupleHtuple (real) (double) (double) (double)

Bin size.


If the parameters are valid, the operator tuple_histo_rangetuple_histo_rangeTupleHistoRangeTupleHistoRangeTupleHistoRangetuple_histo_range returns the value TRUE. If necessary an exception is raised.

Possible Predecessors

tuple_mintuple_minTupleMinTupleMinTupleMintuple_min, tuple_maxtuple_maxTupleMaxTupleMaxTupleMaxtuple_max

Possible Successors


See also

gray_histogray_histoGrayHistoGrayHistoGrayHistogray_histo, gray_histo_absgray_histo_absGrayHistoAbsGrayHistoAbsGrayHistoAbsgray_histo_abs, gray_histo_rangegray_histo_rangeGrayHistoRangeGrayHistoRangeGrayHistoRangegray_histo_range