ClassesClasses | | Operators

get_shape_model_paramsget_shape_model_paramsGetShapeModelParamsGetShapeModelParams (Operator)

Name

get_shape_model_paramsget_shape_model_paramsGetShapeModelParamsGetShapeModelParams — Return the parameters of a shape model.

Signature

get_shape_model_params( : : ModelID : NumLevels, AngleStart, AngleExtent, AngleStep, ScaleMin, ScaleMax, ScaleStep, Metric, MinContrast)

Herror get_shape_model_params(const Hlong ModelID, Hlong* NumLevels, double* AngleStart, double* AngleExtent, double* AngleStep, double* ScaleMin, double* ScaleMax, double* ScaleStep, char* Metric, Hlong* MinContrast)

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)

void GetShapeModelParams(const HTuple& ModelID, HTuple* NumLevels, HTuple* AngleStart, HTuple* AngleExtent, HTuple* AngleStep, HTuple* ScaleMin, HTuple* ScaleMax, HTuple* ScaleStep, HTuple* Metric, HTuple* MinContrast)

Hlong 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

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)

int 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_paramsget_shape_model_paramsGetShapeModelParamsGetShapeModelParamsGetShapeModelParams returns the parameters of the shape model ModelIDModelIDModelIDModelIDmodelID that were used to create it using create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModel, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModel, or create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModel. In particular, this output can be used to check the parameters NumLevelsNumLevelsNumLevelsNumLevelsnumLevels, AngleStepAngleStepAngleStepAngleStepangleStep, ScaleStepScaleStepScaleStepScaleStepscaleStep, and MinContrastMinContrastMinContrastMinContrastminContrast if they were determined automatically during the model creation with create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModel, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModel, or create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModel.

If the shape model was created using create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModel or create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModel a single value is returned in ScaleMinScaleMinScaleMinScaleMinscaleMin, ScaleMaxScaleMaxScaleMaxScaleMaxscaleMax, and ScaleStepScaleStepScaleStepScaleStepscaleStep. This parameters corresponds to the isotropic scaling parameters of the shape model. If the shape model was created using create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModel 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 OptimizationOptimizationOptimizationOptimizationoptimization and ContrastContrastContrastContrastcontrast that also can be determined automatically during the model creation cannot be queried by using get_shape_model_paramsget_shape_model_paramsGetShapeModelParamsGetShapeModelParamsGetShapeModelParams. If their value is of interest determine_shape_model_paramsdetermine_shape_model_paramsDetermineShapeModelParamsDetermineShapeModelParamsDetermineShapeModelParams should be used instead.

Execution Information

Parameters

ModelIDModelIDModelIDModelIDmodelID (input_control)  shape_model HShapeModel, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handle of the model.

NumLevelsNumLevelsNumLevelsNumLevelsnumLevels (output_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of pyramid levels.

AngleStartAngleStartAngleStartAngleStartangleStart (output_control)  angle.rad HTupleHTupleHtuple (real) (double) (double) (double)

Smallest rotation of the pattern.

AngleExtentAngleExtentAngleExtentAngleExtentangleExtent (output_control)  angle.rad HTupleHTupleHtuple (real) (double) (double) (double)

Extent of the rotation angles.

Assertion: AngleExtent >= 0

AngleStepAngleStepAngleStepAngleStepangleStep (output_control)  angle.rad HTupleHTupleHtuple (real) (double) (double) (double)

Step length of the angles (resolution).

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

ScaleMinScaleMinScaleMinScaleMinscaleMin (output_control)  number(-array) HTupleHTupleHtuple (real) (double) (double) (double)

Minimum scale of the pattern.

Assertion: ScaleMin > 0

ScaleMaxScaleMaxScaleMaxScaleMaxscaleMax (output_control)  number(-array) HTupleHTupleHtuple (real) (double) (double) (double)

Maximum scale of the pattern.

Assertion: ScaleMax >= ScaleMin

ScaleStepScaleStepScaleStepScaleStepscaleStep (output_control)  number(-array) HTupleHTupleHtuple (real) (double) (double) (double)

Scale step length (resolution).

Assertion: ScaleStep >= 0

MetricMetricMetricMetricmetric (output_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Match metric.

MinContrastMinContrastMinContrastMinContrastminContrast (output_control)  number HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Minimum contrast of the objects in the search images.

Result

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

Possible Predecessors

create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModel, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModel, create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModel, read_shape_modelread_shape_modelReadShapeModelReadShapeModelReadShapeModel

See also

find_shape_modelfind_shape_modelFindShapeModelFindShapeModelFindShapeModel, find_scaled_shape_modelfind_scaled_shape_modelFindScaledShapeModelFindScaledShapeModelFindScaledShapeModel, find_aniso_shape_modelfind_aniso_shape_modelFindAnisoShapeModelFindAnisoShapeModelFindAnisoShapeModel, find_shape_modelsfind_shape_modelsFindShapeModelsFindShapeModelsFindShapeModels, find_scaled_shape_modelsfind_scaled_shape_modelsFindScaledShapeModelsFindScaledShapeModelsFindScaledShapeModels, find_aniso_shape_modelsfind_aniso_shape_modelsFindAnisoShapeModelsFindAnisoShapeModelsFindAnisoShapeModels

Module

Matching


ClassesClasses | | Operators