Skip to content

gen_region_histogen_region_histoGenRegionHistoGenRegionHistogen_region_histoT_gen_region_histo🔗

Short description🔗

gen_region_histogen_region_histoGenRegionHistoGenRegionHistogen_region_histoT_gen_region_histo — Convert a histogram into a region.

Signature🔗

gen_region_histo( out region Region, histogram Histogram, point.y Row, point.x Column, integer Scale )gen_region_histo( : Region : Histogram, Row, Column, Scale : )void GenRegionHisto( HObject* Region, const HTuple& Histogram, const HTuple& Row, const HTuple& Column, const HTuple& Scale )static void HOperatorSet.GenRegionHisto( out HObject region, HTuple histogram, HTuple row, HTuple column, HTuple scale )def gen_region_histo( histogram: Sequence[int], row: int, column: int, scale: int ) -> HObject

Herror T_gen_region_histo( Hobject* Region, const Htuple Histogram, const Htuple Row, const Htuple Column, const Htuple Scale )

void HRegion::GenRegionHisto( const HTuple& Histogram, Hlong Row, Hlong Column, Hlong Scale )

void HRegion.GenRegionHisto( HTuple histogram, int row, int column, int scale )

Description🔗

gen_region_histoGenRegionHisto converts a histogram created with gray_histoGrayHisto, gray_histo_rangeGrayHistoRange ,or tuple_histo_rangeTupleHistoRange into a region. Rowrowrow and Columncolumncolumn define the position of the center of the graphic. Scalescalescale allows scaling of the graphic, whereby 11 means displaying all 256 values, 22 means displaying 128 values, 33 means displaying only 64 values, etc.

Execution information🔗

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🔗

Regionregionregion (output_object) region → objectobjectHObjectHRegionHObjectHobject *

Region containing the histogram.

Histogramhistogramhistogram (input_control) histogram-array → (integer)(integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

Input histogram.

Rowrowrow (input_control) point.y → (integer)(integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Row coordinate of the center of the histogram.

Default: 255255
Suggested values: 100, 200, 255, 300, 400100, 200, 255, 300, 400
Value range: 0 ≤ Row ≤ 511

Columncolumncolumn (input_control) point.x → (integer)(integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Column coordinate of the center of the histogram.

Default: 255255
Suggested values: 100, 200, 255, 300, 400100, 200, 255, 300, 400
Value range: 0 ≤ Column ≤ 511

Scalescalescale (input_control) integer → (integer)(integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Scale factor for the histogram.

Default: 11
Suggested values: 1, 2, 3, 4, 5, 6, 71, 2, 3, 4, 5, 6, 7
Value range: 1 ≤ Scale ≤ 10 (lin)
Minimum increment: 1
Recommended increment: 1

Result🔗

gen_region_histoGenRegionHisto returns 2 (H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

gray_histoGrayHisto, gray_histo_rangeGrayHistoRange, tuple_histo_rangeTupleHistoRange

See also

disp_channelDispChannel

Module🔗

Foundation