HALCON 24.05.0.0 / HALCON Operator Reference / 1D Measuring
ClassesClasses | | Operators

get_measure_paramT_get_measure_paramGetMeasureParamGetMeasureParamget_measure_param (Operator)

Name

get_measure_paramT_get_measure_paramGetMeasureParamGetMeasureParamget_measure_param — Return the parameters and properties of a measure object.

Signature

get_measure_param( : : MeasureHandle, GenParamName : GenParamValue)

Herror T_get_measure_param(const Htuple MeasureHandle, const Htuple GenParamName, Htuple* GenParamValue)

void GetMeasureParam(const HTuple& MeasureHandle, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HMeasure::GetMeasureParam(const HTuple& GenParamName) const

HTuple HMeasure::GetMeasureParam(const HString& GenParamName) const

HTuple HMeasure::GetMeasureParam(const char* GenParamName) const

HTuple HMeasure::GetMeasureParam(const wchar_t* GenParamName) const   ( Windows only)

static HTuple HImage::GetMeasureParam(const HMeasure& MeasureHandle, const HTuple& GenParamName)

static HTuple HImage::GetMeasureParam(const HMeasure& MeasureHandle, const HString& GenParamName)

static HTuple HImage::GetMeasureParam(const HMeasure& MeasureHandle, const char* GenParamName)

static HTuple HImage::GetMeasureParam(const HMeasure& MeasureHandle, const wchar_t* GenParamName)   ( Windows only)

static void HOperatorSet.GetMeasureParam(HTuple measureHandle, HTuple genParamName, out HTuple genParamValue)

HTuple HMeasure.GetMeasureParam(HTuple genParamName)

HTuple HMeasure.GetMeasureParam(string genParamName)

static HTuple HImage.GetMeasureParam(HMeasure measureHandle, HTuple genParamName)

static HTuple HImage.GetMeasureParam(HMeasure measureHandle, string genParamName)

def get_measure_param(measure_handle: HHandle, gen_param_name: MaybeSequence[str]) -> Sequence[Union[str, float, int]]

def get_measure_param_s(measure_handle: HHandle, gen_param_name: MaybeSequence[str]) -> Union[str, float, int]

Description

The operator get_measure_paramget_measure_paramGetMeasureParamGetMeasureParamget_measure_param returns parameters and properties of the measure object MeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle. The names of the desired properties are passed in the generic parameter GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding values are returned in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value.

The properties that can be passed to GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name depend on the kind of measure object as well as its parameters. If a property is not available, get_measure_paramget_measure_paramGetMeasureParamGetMeasureParamget_measure_param returns an error.

Properties for all measure objects

  • 'type'"type""type""type""type": Type of the measure object, either 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2" if the object was created with gen_measure_rectangle2gen_measure_rectangle2GenMeasureRectangle2GenMeasureRectangle2gen_measure_rectangle2, or 'arc'"arc""arc""arc""arc" if it was created with gen_measure_arcgen_measure_arcGenMeasureArcGenMeasureArcgen_measure_arc.

  • 'image_width'"image_width""image_width""image_width""image_width", 'image_height'"image_height""image_height""image_height""image_height": Image width and height, respectively, for which the measure object was created.

  • 'interpolation'"interpolation""interpolation""interpolation""interpolation": Used interpolation mode: 'nearest_neighbor'"nearest_neighbor""nearest_neighbor""nearest_neighbor""nearest_neighbor", 'bilinear'"bilinear""bilinear""bilinear""bilinear" or 'bicubic'"bicubic""bicubic""bicubic""bicubic".

Properties for rectangular measure objects

Properties for measure objects that were created with gen_measure_rectangle2gen_measure_rectangle2GenMeasureRectangle2GenMeasureRectangle2gen_measure_rectangle2.

  • 'row'"row""row""row""row", 'column'"column""column""column""column": Row and column, respectively, of the center of the measurement rectangle.

  • 'phi'"phi""phi""phi""phi": Rotation angle of the measurement rectangle.

  • 'length1'"length1""length1""length1""length1", 'length2'"length2""length2""length2""length2": Side lengths of the measurement rectangle.

Properties for annular-shaped measure objects

Properties for measure objects that were created with gen_measure_arcgen_measure_arcGenMeasureArcGenMeasureArcgen_measure_arc.

  • 'row'"row""row""row""row", 'column'"column""column""column""column": Row and column, respectively, of the center of the annular arc.

  • 'radius'"radius""radius""radius""radius": Radius of the annular arc.

  • 'angle_start'"angle_start""angle_start""angle_start""angle_start", 'angle_extent'"angle_extent""angle_extent""angle_extent""angle_extent": Starting angle and angular extent of annular arc.

  • 'annulus_radius'"annulus_radius""annulus_radius""annulus_radius""annulus_radius": Radius of the angular arc.

Properties for measure objects with fuzzy functions

Properties for measure objects, for which fuzzy functions have been set with set_fuzzy_measureset_fuzzy_measureSetFuzzyMeasureSetFuzzyMeasureset_fuzzy_measure or set_fuzzy_measure_norm_pairset_fuzzy_measure_norm_pairSetFuzzyMeasureNormPairSetFuzzyMeasureNormPairset_fuzzy_measure_norm_pair.

  • 'fuzzy_contrast'"fuzzy_contrast""fuzzy_contrast""fuzzy_contrast""fuzzy_contrast": Fuzzy function for evaluation of the edge amplitudes.

  • 'fuzzy_position'"fuzzy_position""fuzzy_position""fuzzy_position""fuzzy_position", 'fuzzy_position_center'"fuzzy_position_center""fuzzy_position_center""fuzzy_position_center""fuzzy_position_center", 'fuzzy_position_end'"fuzzy_position_end""fuzzy_position_end""fuzzy_position_end""fuzzy_position_end", 'fuzzy_position_first_edge'"fuzzy_position_first_edge""fuzzy_position_first_edge""fuzzy_position_first_edge""fuzzy_position_first_edge", 'fuzzy_position_last_edge'"fuzzy_position_last_edge""fuzzy_position_last_edge""fuzzy_position_last_edge""fuzzy_position_last_edge": Fuzzy function for evaluation of the distance of edge candidates to the reference point on the measure object.

  • 'fuzzy_position_pair'"fuzzy_position_pair""fuzzy_position_pair""fuzzy_position_pair""fuzzy_position_pair", 'fuzzy_position_pair_center'"fuzzy_position_pair_center""fuzzy_position_pair_center""fuzzy_position_pair_center""fuzzy_position_pair_center", 'fuzzy_position_pair_end'"fuzzy_position_pair_end""fuzzy_position_pair_end""fuzzy_position_pair_end""fuzzy_position_pair_end", 'fuzzy_position_first_pair'"fuzzy_position_first_pair""fuzzy_position_first_pair""fuzzy_position_first_pair""fuzzy_position_first_pair", 'fuzzy_position_last_pair'"fuzzy_position_last_pair""fuzzy_position_last_pair""fuzzy_position_last_pair""fuzzy_position_last_pair": Fuzzy function for evaluation of of the distance of edge pairs to the reference point on the measure object.

  • 'fuzzy_size'"fuzzy_size""fuzzy_size""fuzzy_size""fuzzy_size", 'fuzzy_size_diff'"fuzzy_size_diff""fuzzy_size_diff""fuzzy_size_diff""fuzzy_size_diff", 'fuzzy_size_abs_diff'"fuzzy_size_abs_diff""fuzzy_size_abs_diff""fuzzy_size_abs_diff""fuzzy_size_abs_diff": Fuzzy function for evaluation of the distance between two edges of a pair.

  • 'fuzzy_gray'"fuzzy_gray""fuzzy_gray""fuzzy_gray""fuzzy_gray": Fuzzy function for weighting the mean projected gray value between two edges of a pair.

Execution Information

Parameters

MeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle (input_control)  measure → HMeasure, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Measure object handle.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Name of the parameter to be returned.

Default: 'type' "type" "type" "type" "type"

List of values: 'angle_extent'"angle_extent""angle_extent""angle_extent""angle_extent", 'angle_start'"angle_start""angle_start""angle_start""angle_start", 'annulus_radius'"annulus_radius""annulus_radius""annulus_radius""annulus_radius", 'column'"column""column""column""column", 'fuzzy_contrast'"fuzzy_contrast""fuzzy_contrast""fuzzy_contrast""fuzzy_contrast", 'fuzzy_gray'"fuzzy_gray""fuzzy_gray""fuzzy_gray""fuzzy_gray", 'fuzzy_position'"fuzzy_position""fuzzy_position""fuzzy_position""fuzzy_position", 'fuzzy_position_center'"fuzzy_position_center""fuzzy_position_center""fuzzy_position_center""fuzzy_position_center", 'fuzzy_position_end'"fuzzy_position_end""fuzzy_position_end""fuzzy_position_end""fuzzy_position_end", 'fuzzy_position_first_edge'"fuzzy_position_first_edge""fuzzy_position_first_edge""fuzzy_position_first_edge""fuzzy_position_first_edge", 'fuzzy_position_first_pair'"fuzzy_position_first_pair""fuzzy_position_first_pair""fuzzy_position_first_pair""fuzzy_position_first_pair", 'fuzzy_position_last_edge'"fuzzy_position_last_edge""fuzzy_position_last_edge""fuzzy_position_last_edge""fuzzy_position_last_edge", 'fuzzy_position_last_pair'"fuzzy_position_last_pair""fuzzy_position_last_pair""fuzzy_position_last_pair""fuzzy_position_last_pair", 'fuzzy_position_pair'"fuzzy_position_pair""fuzzy_position_pair""fuzzy_position_pair""fuzzy_position_pair", 'fuzzy_position_pair_center'"fuzzy_position_pair_center""fuzzy_position_pair_center""fuzzy_position_pair_center""fuzzy_position_pair_center", 'fuzzy_position_pair_end'"fuzzy_position_pair_end""fuzzy_position_pair_end""fuzzy_position_pair_end""fuzzy_position_pair_end", 'fuzzy_size'"fuzzy_size""fuzzy_size""fuzzy_size""fuzzy_size", 'fuzzy_size_abs_diff'"fuzzy_size_abs_diff""fuzzy_size_abs_diff""fuzzy_size_abs_diff""fuzzy_size_abs_diff", 'fuzzy_size_diff'"fuzzy_size_diff""fuzzy_size_diff""fuzzy_size_diff""fuzzy_size_diff", 'image_height'"image_height""image_height""image_height""image_height", 'image_width'"image_width""image_width""image_width""image_width", 'interpolation'"interpolation""interpolation""interpolation""interpolation", 'length1'"length1""length1""length1""length1", 'length2'"length2""length2""length2""length2", 'phi'"phi""phi""phi""phi", 'radius'"radius""radius""radius""radius", 'row'"row""row""row""row", 'type'"type""type""type""type"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control)  attribute.value(-array) → HTupleSequence[Union[str, float, int]]HTupleHtuple (real / string / integer) (double / string / int / long) (double / HString / Hlong) (double / char* / Hlong)

Value of the parameter.

Result

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

Possible Predecessors

gen_measure_rectangle2gen_measure_rectangle2GenMeasureRectangle2GenMeasureRectangle2gen_measure_rectangle2, gen_measure_arcgen_measure_arcGenMeasureArcGenMeasureArcgen_measure_arc

See also

gen_measure_rectangle2gen_measure_rectangle2GenMeasureRectangle2GenMeasureRectangle2gen_measure_rectangle2, gen_measure_arcgen_measure_arcGenMeasureArcGenMeasureArcgen_measure_arc, translate_measuretranslate_measureTranslateMeasureTranslateMeasuretranslate_measure

Module

1D Metrology

ClassesClasses | | Operators
HALCON Operator Reference 24.05.0.0 Copyright © 1996-2024 MVTec Software GmbH