Skip to content

translate_measuretranslate_measureTranslateMeasureTranslateMeasuretranslate_measureT_translate_measure🔗

Short description🔗

translate_measuretranslate_measureTranslateMeasureTranslateMeasuretranslate_measureT_translate_measure — Translate a measure object.

Signature🔗

translate_measure( measure MeasureHandle, point.y Row, point.x Column )translate_measure( : : MeasureHandle, Row, Column : )void TranslateMeasure( const HTuple& MeasureHandle, const HTuple& Row, const HTuple& Column )static void HOperatorSet.TranslateMeasure( HTuple measureHandle, HTuple row, HTuple column )def translate_measure( measure_handle: HHandle, row: Union[int, float], column: Union[int, float] ) -> None

Herror T_translate_measure( const Htuple MeasureHandle, const Htuple Row, const Htuple Column )

void HMeasure::TranslateMeasure( const HTuple& Row, const HTuple& Column ) const

void HMeasure::TranslateMeasure( double Row, double Column ) const

void HMeasure.TranslateMeasure( HTuple row, HTuple column )

void HMeasure.TranslateMeasure( double row, double column )

Description🔗

translate_measureTranslateMeasure translates the reference point of the measure object given by MeasureHandlemeasureHandlemeasure_handle to the point (Rowrowrow, Columncolumncolumn). 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_rectangle2GenMeasureRectangle2 or gen_measure_arcGenMeasureArc 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🔗

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:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters🔗

MeasureHandlemeasureHandlemeasure_handle (input_control, state is modified) measure → (handle)(handle)HTuple (HHandle)HMeasure, HTuple (IntPtr)HHandleHtuple (handle)

Measure object handle.

Rowrowrow (input_control) point.y → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)Union[int, float]Htuple (double / Hlong)

Row coordinate of the new reference point.

Default: 50.050.0
Suggested values: 10.0, 20.0, 50.0, 100.0, 200.0, 300.0, 400.0, 500.010.0, 20.0, 50.0, 100.0, 200.0, 300.0, 400.0, 500.0
Value range: 0.0 ≤ Row ≤ 511.0 (lin)
Minimum increment: 1.0
Recommended increment: 10.0

Columncolumncolumn (input_control) point.x → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)Union[int, float]Htuple (double / Hlong)

Column coordinate of the new reference point.

Default: 100.0100.0
Suggested values: 10.0, 20.0, 50.0, 100.0, 200.0, 300.0, 400.0, 500.010.0, 20.0, 50.0, 100.0, 200.0, 300.0, 400.0, 500.0
Value range: 0.0 ≤ Column ≤ 511.0 (lin)
Minimum increment: 1.0
Recommended increment: 10.0

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

gen_measure_rectangle2GenMeasureRectangle2, gen_measure_arcGenMeasureArc

Possible successors

measure_posMeasurePos, measure_pairsMeasurePairs, fuzzy_measure_posFuzzyMeasurePos, fuzzy_measure_pairsFuzzyMeasurePairs, fuzzy_measure_pairingFuzzyMeasurePairing, measure_threshMeasureThresh

Alternatives

gen_measure_rectangle2GenMeasureRectangle2, gen_measure_arcGenMeasureArc

See also

close_measureCloseMeasure

Module🔗

1D Metrology