translate_measuretranslate_measureTranslateMeasureTranslateMeasure (Operator)

Name

translate_measuretranslate_measureTranslateMeasureTranslateMeasure — Translate a measure object.

Signature

translate_measure( : : MeasureHandle, Row, Column : )

Description

translate_measuretranslate_measureTranslateMeasureTranslateMeasureTranslateMeasure translates the reference point of the measure object given by MeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandle to the point (RowRowRowRowrow,ColumnColumnColumnColumncolumn). If the measure object and the translated measure object lie completely within the image, the measure object is shifted to the new reference point in an efficient manner. Otherwise, the measure object is generated anew with gen_measure_rectangle2gen_measure_rectangle2GenMeasureRectangle2GenMeasureRectangle2GenMeasureRectangle2 or gen_measure_arcgen_measure_arcGenMeasureArcGenMeasureArcGenMeasureArc using the parameters that were specified when the measure object was created and the new reference point.

For an explanation of the concept of 1D measuring see the introduction of chapter 1D Measuring.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator modifies the state of the following input parameter:

MeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandle

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

MeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandle (input_control, state is modified) measure_id → (integer)

Measure object handle.

RowRowRowRowrow (input_control) point.y → (real / integer)

Row coordinate of the new reference point.

Default value: 50.0

Suggested values: 10.0, 20.0, 50.0, 100.0, 200.0, 300.0, 400.0, 500.0

Typical range of values: 0.0 ≤ Row Row Row Row row ≤ 511.0 (lin)

Minimum increment: 1.0

Recommended increment: 10.0

ColumnColumnColumnColumncolumn (input_control) point.x → (real / integer)

Column coordinate of the new reference point.

Default value: 100.0

Suggested values: 10.0, 20.0, 50.0, 100.0, 200.0, 300.0, 400.0, 500.0

Typical range of values: 0.0 ≤ Column Column Column Column column ≤ 511.0 (lin)

Minimum increment: 1.0

Recommended increment: 10.0

If the parameter values are correct the operator translate_measuretranslate_measureTranslateMeasureTranslateMeasureTranslateMeasure returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.