get_shape_model_paramsT_get_shape_model_paramsGetShapeModelParamsGetShapeModelParamsget_shape_model_params (Operator)
Name
get_shape_model_paramsT_get_shape_model_paramsGetShapeModelParamsGetShapeModelParamsget_shape_model_params — Return the parameters of a shape model.
Signature
void GetShapeModelParams(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
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)
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)
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]
Description
The operator get_shape_model_paramsget_shape_model_paramsGetShapeModelParamsGetShapeModelParamsGetShapeModelParamsget_shape_model_params returns the parameters
of the shape model ModelIDModelIDModelIDModelIDmodelIDmodel_id that were used to create it
using create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModelcreate_shape_model, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model,
or create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model. In particular, this output can
be used to check the parameters NumLevelsNumLevelsNumLevelsNumLevelsnumLevelsnum_levels,
AngleStepAngleStepAngleStepAngleStepangleStepangle_step, ScaleStepScaleStepScaleStepScaleStepscaleStepscale_step, and MinContrastMinContrastMinContrastMinContrastminContrastmin_contrast if
they were determined automatically during the model creation with
create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModelcreate_shape_model, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model, or
create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model.
If the ModelIDModelIDModelIDModelIDmodelIDmodel_id was adapted with
adapt_shape_model_high_noiseadapt_shape_model_high_noiseAdaptShapeModelHighNoiseAdaptShapeModelHighNoiseAdaptShapeModelHighNoiseadapt_shape_model_high_noise, NumLevels contains two values: the
highest pyramid level and the estimated lowest pyramid level.
If the shape model was created using create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModelcreate_shape_model or
create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model a single value is returned in
ScaleMinScaleMinScaleMinScaleMinscaleMinscale_min, ScaleMaxScaleMaxScaleMaxScaleMaxscaleMaxscale_max, and ScaleStepScaleStepScaleStepScaleStepscaleStepscale_step. 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_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model 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 OptimizationOptimizationOptimizationOptimizationoptimizationoptimization and
ContrastContrastContrastContrastcontrastcontrast that also can be determined automatically during
the model creation cannot be queried by using
get_shape_model_paramsget_shape_model_paramsGetShapeModelParamsGetShapeModelParamsGetShapeModelParamsget_shape_model_params. If their value is of interest
determine_shape_model_paramsdetermine_shape_model_paramsDetermineShapeModelParamsDetermineShapeModelParamsDetermineShapeModelParamsdetermine_shape_model_params should be used instead.
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
ModelIDModelIDModelIDModelIDmodelIDmodel_id (input_control) shape_model → HShapeModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the model.
NumLevelsNumLevelsNumLevelsNumLevelsnumLevelsnum_levels (output_control) integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of pyramid levels.
AngleStartAngleStartAngleStartAngleStartangleStartangle_start (output_control) angle.rad → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Smallest rotation of the pattern.
AngleExtentAngleExtentAngleExtentAngleExtentangleExtentangle_extent (output_control) angle.rad → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Extent of the rotation angles.
Assertion: AngleExtent >= 0
AngleStepAngleStepAngleStepAngleStepangleStepangle_step (output_control) angle.rad → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Step length of the angles (resolution).
Assertion: AngleStep >= 0 && AngleStep <= pi / 16
ScaleMinScaleMinScaleMinScaleMinscaleMinscale_min (output_control) number(-array) → HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)
Minimum scale of the pattern.
Assertion: ScaleMin > 0
ScaleMaxScaleMaxScaleMaxScaleMaxscaleMaxscale_max (output_control) number(-array) → HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)
Maximum scale of the pattern.
Assertion: ScaleMax >= ScaleMin
ScaleStepScaleStepScaleStepScaleStepscaleStepscale_step (output_control) number(-array) → HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)
Scale step length (resolution).
Assertion: ScaleStep >= 0
MetricMetricMetricMetricmetricmetric (output_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Match metric.
MinContrastMinContrastMinContrastMinContrastminContrastmin_contrast (output_control) number → HTupleintHTupleHtuple (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_paramsGetShapeModelParamsGetShapeModelParamsGetShapeModelParamsget_shape_model_params returns the value TRUE. If necessary
an exception is raised.
Possible Predecessors
create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModelcreate_shape_model,
create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model,
create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model,
read_shape_modelread_shape_modelReadShapeModelReadShapeModelReadShapeModelread_shape_model
Alternatives
get_generic_shape_model_paramget_generic_shape_model_paramGetGenericShapeModelParamGetGenericShapeModelParamGetGenericShapeModelParamget_generic_shape_model_param
See also
find_shape_modelfind_shape_modelFindShapeModelFindShapeModelFindShapeModelfind_shape_model,
find_scaled_shape_modelfind_scaled_shape_modelFindScaledShapeModelFindScaledShapeModelFindScaledShapeModelfind_scaled_shape_model,
find_aniso_shape_modelfind_aniso_shape_modelFindAnisoShapeModelFindAnisoShapeModelFindAnisoShapeModelfind_aniso_shape_model,
find_shape_modelsfind_shape_modelsFindShapeModelsFindShapeModelsFindShapeModelsfind_shape_models,
find_scaled_shape_modelsfind_scaled_shape_modelsFindScaledShapeModelsFindScaledShapeModelsFindScaledShapeModelsfind_scaled_shape_models,
find_aniso_shape_modelsfind_aniso_shape_modelsFindAnisoShapeModelsFindAnisoShapeModelsFindAnisoShapeModelsfind_aniso_shape_models
Module
Matching