gen_region_histoT_gen_region_histoGenRegionHistoGenRegionHisto (Operator)

Name

gen_region_histoT_gen_region_histoGenRegionHistoGenRegionHisto — Convert a histogram into a region.

Signature

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

Description

gen_region_histogen_region_histoGenRegionHistoGenRegionHistoGenRegionHisto converts a histogram created with gray_histogray_histoGrayHistoGrayHistoGrayHisto, gray_histo_rangegray_histo_rangeGrayHistoRangeGrayHistoRangeGrayHistoRange ,or tuple_histo_rangetuple_histo_rangeTupleHistoRangeTupleHistoRangeTupleHistoRange into a region. The effect of the three control parameters is the same as in disp_imagedisp_imageDispImageDispImageDispImage and set_paintset_paintSetPaintSetPaintSetPaint.

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 value: 255

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

Typical range of values: 0 ≤ Row Row Row Row row ≤ 511

ColumnColumnColumnColumncolumn (input_control) point.x → (integer)

Column coordinate of the center of the histogram.

Default value: 255

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

Typical range of values: 0 ≤ Column Column Column Column column ≤ 511

ScaleScaleScaleScalescale (input_control) integer → (integer)

Scale factor for the histogram.

Default value: 1

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

Typical range of values: 1 ≤ Scale Scale Scale Scale scale ≤ 10 (lin)

Minimum increment: 1

Recommended increment: 1

Result

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

Possible Predecessors

gray_histogray_histoGrayHistoGrayHistoGrayHisto, gray_histo_rangegray_histo_rangeGrayHistoRangeGrayHistoRangeGrayHistoRange, tuple_histo_rangetuple_histo_rangeTupleHistoRangeTupleHistoRangeTupleHistoRange

See also

disp_channeldisp_channelDispChannelDispChannelDispChannel, set_paintset_paintSetPaintSetPaintSetPaint

Module

Foundation