get_shape_model_paramsGetShapeModelParamsGetShapeModelParamsget_shape_model_paramsT_get_shape_model_params

HALCON ScriptCpp++.NETPythonC

Short description

get_shape_model_paramsGetShapeModelParamsGetShapeModelParamsget_shape_model_paramsT_get_shape_model_params — Return the parameters of a shape model.

Signature

get_shape_model_params( shape_model ModelID, out integer NumLevels, out angle.rad AngleStart, out angle.rad AngleExtent, out angle.rad AngleStep, out number ScaleMin, out number ScaleMax, out number ScaleStep, out string Metric, out number MinContrast )void GetShapeModelParams( const HTuple& ModelID, HTuple* NumLevels, HTuple* AngleStart, HTuple* AngleExtent, HTuple* AngleStep, HTuple* ScaleMin, HTuple* ScaleMax, HTuple* ScaleStep, HTuple* Metric, HTuple* MinContrast )static void HOperatorSet.GetShapeModelParams( HTuple modelID, out HTuple numLevels, out HTuple angleStart, out HTuple angleExtent, out HTuple angleStep, out HTuple scaleMin, out HTuple scaleMax, out HTuple scaleStep, out HTuple metric, out HTuple minContrast )def get_shape_model_params( model_id: HHandle ) -> Tuple[Sequence[int], float, float, float, Sequence[float], Sequence[float], Sequence[float], str, int]

def get_shape_model_params_s( model_id: HHandle ) -> Tuple[int, float, float, float, float, float, float, str, int]Herror T_get_shape_model_params( const Htuple ModelID, Htuple* NumLevels, Htuple* AngleStart, Htuple* AngleExtent, Htuple* AngleStep, Htuple* ScaleMin, Htuple* ScaleMax, Htuple* ScaleStep, Htuple* Metric, Htuple* MinContrast )

HTuple HShapeModel::GetShapeModelParams( double* AngleStart, double* AngleExtent, double* AngleStep, HTuple* ScaleMin, HTuple* ScaleMax, HTuple* ScaleStep, HString* Metric, Hlong* MinContrast ) const

Hlong HShapeModel::GetShapeModelParams( double* AngleStart, double* AngleExtent, double* AngleStep, double* ScaleMin, double* ScaleMax, double* ScaleStep, HString* Metric, Hlong* MinContrast ) const

HTuple HShapeModel.GetShapeModelParams( out double angleStart, out double angleExtent, out double angleStep, out HTuple scaleMin, out HTuple scaleMax, out HTuple scaleStep, out string metric, out int minContrast )

int HShapeModel.GetShapeModelParams( out double angleStart, out double angleExtent, out double angleStep, out double scaleMin, out double scaleMax, out double scaleStep, out string metric, out int minContrast )

Description

The operator get_shape_model_paramsGetShapeModelParams returns the parameters of the shape model ModelIDmodelIDmodel_id that were used to create it using create_shape_modelCreateShapeModel, create_scaled_shape_modelCreateScaledShapeModel, or create_aniso_shape_modelCreateAnisoShapeModel. In particular, this output can be used to check the parameters NumLevelsnumLevelsnum_levels, AngleStepangleStepangle_step, ScaleStepscaleStepscale_step, and MinContrastminContrastmin_contrast if they were determined automatically during the model creation with create_shape_modelCreateShapeModel, create_scaled_shape_modelCreateScaledShapeModel, or create_aniso_shape_modelCreateAnisoShapeModel.

If the ModelIDmodelIDmodel_id was adapted with adapt_shape_model_high_noiseAdaptShapeModelHighNoise, NumLevels contains two values: the highest pyramid level and the estimated lowest pyramid level.

If the shape model was created using create_shape_modelCreateShapeModel or create_scaled_shape_modelCreateScaledShapeModel a single value is returned in ScaleMinscaleMinscale_min, ScaleMaxscaleMaxscale_max, and ScaleStepscaleStepscale_step. This parameters corresponds to the isotropic scaling parameters of the shape model. If the shape model was created using create_aniso_shape_modelCreateAnisoShapeModel two values each are returned in the above three parameters. Here, the first value of the respective parameter refers to the scaling in the row direction, while the second value refers to the scaling in the column direction.

Note that the parameters Optimizationoptimizationoptimization and Contrastcontrastcontrast that also can be determined automatically during the model creation cannot be queried by using get_shape_model_paramsGetShapeModelParams. If their value is of interest determine_shape_model_paramsDetermineShapeModelParams should be used instead.

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.

Parameters

ModelIDmodelIDmodel_id (input_control) shape_model → (handle)HTuple (HHandle)HShapeModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the model.

NumLevelsnumLevelsnum_levels (output_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

Number of pyramid levels.

AngleStartangleStartangle_start (output_control) angle.rad → (real)HTuple (double)HTuple (double)floatHtuple (double)

Smallest rotation of the pattern.

AngleExtentangleExtentangle_extent (output_control) angle.rad → (real)HTuple (double)HTuple (double)floatHtuple (double)

Extent of the rotation angles.

Assertion: AngleExtent >= 0

AngleStepangleStepangle_step (output_control) angle.rad → (real)HTuple (double)HTuple (double)floatHtuple (double)

Step length of the angles (resolution).

Assertion: AngleStep >= 0 && AngleStep <= pi/2

ScaleMinscaleMinscale_min (output_control) number(-array) → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Minimum scale of the pattern.

Assertion: ScaleMin > 0

ScaleMaxscaleMaxscale_max (output_control) number(-array) → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Maximum scale of the pattern.

Assertion: ScaleMax >= ScaleMin

ScaleStepscaleStepscale_step (output_control) number(-array) → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Scale step length (resolution).

Assertion: ScaleStep >= 0

Metricmetricmetric (output_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Match metric.

MinContrastminContrastmin_contrast (output_control) number → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Minimum contrast of the objects in the search images.

Result

If the handle of the model is valid, the operator get_shape_model_paramsGetShapeModelParams returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Combinations with other operators

Combinations

Possible predecessors

create_shape_modelCreateShapeModel, create_scaled_shape_modelCreateScaledShapeModel, create_aniso_shape_modelCreateAnisoShapeModel, read_shape_modelReadShapeModel

Alternatives

get_generic_shape_model_paramGetGenericShapeModelParam

See also

find_shape_modelFindShapeModel, find_scaled_shape_modelFindScaledShapeModel, find_aniso_shape_modelFindAnisoShapeModel, find_shape_modelsFindShapeModels, find_scaled_shape_modelsFindScaledShapeModels, find_aniso_shape_modelsFindAnisoShapeModels

Module

Matching