gen_region_histoT_gen_region_histoGenRegionHistoGenRegionHistogen_region_histo (Operator)

Name

gen_region_histoT_gen_region_histoGenRegionHistoGenRegionHistogen_region_histo — Convert a histogram into a region.

Signature

gen_region_histo( : Region : Histogram, Row, Column, Scale : )

Description

gen_region_histogen_region_histoGenRegionHistoGenRegionHistogen_region_histo converts a histogram created with gray_histogray_histoGrayHistoGrayHistogray_histo, gray_histo_rangegray_histo_rangeGrayHistoRangeGrayHistoRangegray_histo_range ,or tuple_histo_rangetuple_histo_rangeTupleHistoRangeTupleHistoRangetuple_histo_range into a region. RowRowRowrowrow and ColumnColumnColumncolumncolumn define the position of the center of the graphic. ScaleScaleScalescalescale allows scaling of the graphic, whereby 1 means displaying all 256 values, 2 means displaying 128 values, 3 means displaying only 64 values, etc.

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

RegionRegionRegionregionregion (output_object) region → object

Region containing the histogram.

HistogramHistogramHistogramhistogramhistogram (input_control) histogram-array → (integer)

Input histogram.

RowRowRowrowrow (input_control) point.y → (integer)

Row coordinate of the center of the histogram.

Default: 255

Suggested values: 100, 200, 255, 300, 400

Value range: 0 ≤ Row Row Row row row ≤ 511

ColumnColumnColumncolumncolumn (input_control) point.x → (integer)

Column coordinate of the center of the histogram.

Default: 255

Suggested values: 100, 200, 255, 300, 400

Value range: 0 ≤ Column Column Column column column ≤ 511

ScaleScaleScalescalescale (input_control) integer → (integer)

Scale factor for the histogram.

Default: 1

Suggested values: 1, 2, 3, 4, 5, 6, 7

Value range: 1 ≤ Scale Scale Scale scale scale ≤ 10 (lin)

Minimum increment: 1

Recommended increment: 1

Result

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

Possible Predecessors

gray_histogray_histoGrayHistoGrayHistogray_histo, gray_histo_rangegray_histo_rangeGrayHistoRangeGrayHistoRangegray_histo_range, tuple_histo_rangetuple_histo_rangeTupleHistoRangeTupleHistoRangetuple_histo_range

Module

Foundation

Operators