Operator Reference

get_shape_model_clutterT_get_shape_model_clutterGetShapeModelClutterGetShapeModelClutterget_shape_model_clutter (Operator)

get_shape_model_clutterT_get_shape_model_clutterGetShapeModelClutterGetShapeModelClutterget_shape_model_clutter — Get the clutter parameters of a shape model.

Signature

Herror T_get_shape_model_clutter(Hobject* ClutterRegion, const Htuple ModelID, const Htuple GenParamName, Htuple* GenParamValue, Htuple* HomMat2D, Htuple* ClutterContrast)

void GetShapeModelClutter(HObject* ClutterRegion, const HTuple& ModelID, const HTuple& GenParamName, HTuple* GenParamValue, HTuple* HomMat2D, HTuple* ClutterContrast)

HRegion HShapeModel::GetShapeModelClutter(const HTuple& GenParamName, HTuple* GenParamValue, HHomMat2D* HomMat2D, Hlong* ClutterContrast) const

HRegion HShapeModel::GetShapeModelClutter(const HString& GenParamName, HString* GenParamValue, HHomMat2D* HomMat2D, Hlong* ClutterContrast) const

HRegion HShapeModel::GetShapeModelClutter(const char* GenParamName, HString* GenParamValue, HHomMat2D* HomMat2D, Hlong* ClutterContrast) const

HRegion HShapeModel::GetShapeModelClutter(const wchar_t* GenParamName, HString* GenParamValue, HHomMat2D* HomMat2D, Hlong* ClutterContrast) const   ( Windows only)

static HRegion HImage::GetShapeModelClutter(const HShapeModel& ModelID, const HTuple& GenParamName, HTuple* GenParamValue, HHomMat2D* HomMat2D, Hlong* ClutterContrast)

static HRegion HImage::GetShapeModelClutter(const HShapeModel& ModelID, const HString& GenParamName, HString* GenParamValue, HHomMat2D* HomMat2D, Hlong* ClutterContrast)

static HRegion HImage::GetShapeModelClutter(const HShapeModel& ModelID, const char* GenParamName, HString* GenParamValue, HHomMat2D* HomMat2D, Hlong* ClutterContrast)

static HRegion HImage::GetShapeModelClutter(const HShapeModel& ModelID, const wchar_t* GenParamName, HString* GenParamValue, HHomMat2D* HomMat2D, Hlong* ClutterContrast)   ( Windows only)

static void HOperatorSet.GetShapeModelClutter(out HObject clutterRegion, HTuple modelID, HTuple genParamName, out HTuple genParamValue, out HTuple homMat2D, out HTuple clutterContrast)

HRegion HShapeModel.GetShapeModelClutter(HTuple genParamName, out HTuple genParamValue, out HHomMat2D homMat2D, out int clutterContrast)

HRegion HShapeModel.GetShapeModelClutter(string genParamName, out string genParamValue, out HHomMat2D homMat2D, out int clutterContrast)

static HRegion HImage.GetShapeModelClutter(HShapeModel modelID, HTuple genParamName, out HTuple genParamValue, out HHomMat2D homMat2D, out int clutterContrast)

static HRegion HImage.GetShapeModelClutter(HShapeModel modelID, string genParamName, out string genParamValue, out HHomMat2D homMat2D, out int clutterContrast)

def get_shape_model_clutter(model_id: HHandle, gen_param_name: MaybeSequence[str]) -> Tuple[HObject, Sequence[Union[float, int, str]], Sequence[float], int]

def get_shape_model_clutter_s(model_id: HHandle, gen_param_name: MaybeSequence[str]) -> Tuple[HObject, Union[float, int, str], Sequence[float], int]

Description

The operator get_shape_model_clutterget_shape_model_clutterGetShapeModelClutterGetShapeModelClutterget_shape_model_clutter can be used to inspect clutter parameters of the shape model ModelIDModelIDModelIDmodelIDmodel_id, which have been set previously using set_shape_model_clutterset_shape_model_clutterSetShapeModelClutterSetShapeModelClutterset_shape_model_clutter. Also, the value of 'use_clutter'"use_clutter""use_clutter""use_clutter""use_clutter", which can be set using set_shape_model_paramset_shape_model_paramSetShapeModelParamSetShapeModelParamset_shape_model_param, can be queried by setting GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name to 'use_clutter'"use_clutter""use_clutter""use_clutter""use_clutter". For a description of the parameters, please see set_shape_model_clutterset_shape_model_clutterSetShapeModelClutterSetShapeModelClutterset_shape_model_clutter and set_shape_model_paramset_shape_model_paramSetShapeModelParamSetShapeModelParamset_shape_model_param.

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

ClutterRegionClutterRegionClutterRegionclutterRegionclutter_region (output_object)  region objectHRegionHObjectHObjectHobject *

Region where no clutter should occur.

ModelIDModelIDModelIDmodelIDmodel_id (input_control)  shape_model HShapeModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the model.

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

Parameter names.

Default: 'use_clutter' "use_clutter" "use_clutter" "use_clutter" "use_clutter"

List of values: 'clutter_border_mode'"clutter_border_mode""clutter_border_mode""clutter_border_mode""clutter_border_mode", 'use_clutter'"use_clutter""use_clutter""use_clutter""use_clutter"

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

Parameter values.

HomMat2DHomMat2DHomMat2DhomMat2Dhom_mat_2d (output_control)  hom_mat2d HHomMat2D, HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Transformation matrix.

ClutterContrastClutterContrastClutterContrastclutterContrastclutter_contrast (output_control)  number HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Minimum contrast of clutter in the search images.

Result

If the parameters are valid, the operator get_shape_model_clutterget_shape_model_clutterGetShapeModelClutterGetShapeModelClutterget_shape_model_clutter returns the value 2 ( H_MSG_TRUE) . If necessary an exception is raised.

Possible Predecessors

set_shape_model_clutterset_shape_model_clutterSetShapeModelClutterSetShapeModelClutterset_shape_model_clutter, read_shape_modelread_shape_modelReadShapeModelReadShapeModelread_shape_model, deserialize_shape_modeldeserialize_shape_modelDeserializeShapeModelDeserializeShapeModeldeserialize_shape_model

Possible Successors

find_shape_modelfind_shape_modelFindShapeModelFindShapeModelfind_shape_model, find_scaled_shape_modelfind_scaled_shape_modelFindScaledShapeModelFindScaledShapeModelfind_scaled_shape_model, find_aniso_shape_modelfind_aniso_shape_modelFindAnisoShapeModelFindAnisoShapeModelfind_aniso_shape_model, find_shape_modelsfind_shape_modelsFindShapeModelsFindShapeModelsfind_shape_models, find_scaled_shape_modelsfind_scaled_shape_modelsFindScaledShapeModelsFindScaledShapeModelsfind_scaled_shape_models, find_aniso_shape_modelsfind_aniso_shape_modelsFindAnisoShapeModelsFindAnisoShapeModelsfind_aniso_shape_models

See also

create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelcreate_shape_model, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model, create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model, set_shape_model_paramset_shape_model_paramSetShapeModelParamSetShapeModelParamset_shape_model_param

Module

Matching