get_shape_model_clutterGetShapeModelClutterGetShapeModelClutterget_shape_model_clutterT_get_shape_model_clutter
Short description
get_shape_model_clutterGetShapeModelClutterGetShapeModelClutterget_shape_model_clutterT_get_shape_model_clutter — Get the clutter parameters of a shape model.
Signature
get_shape_model_clutter( out region ClutterRegion, shape_model ModelID, attribute.name GenParamName, out attribute.name GenParamValue, out hom_mat2d HomMat2D, out number ClutterContrast )void GetShapeModelClutter( HObject* ClutterRegion, const HTuple& ModelID, const HTuple& GenParamName, HTuple* GenParamValue, HTuple* HomMat2D, HTuple* ClutterContrast )static void HOperatorSet.GetShapeModelClutter( out HObject clutterRegion, HTuple modelID, HTuple genParamName, out HTuple genParamValue, out HTuple homMat2D, out HTuple 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]Herror T_get_shape_model_clutter( 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)
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 )
Description
The operator get_shape_model_clutterGetShapeModelClutter can be used to inspect clutter
parameters of the shape model ModelIDmodelIDmodel_id, which have been set
previously using set_shape_model_clutterSetShapeModelClutter. Also, the value of
'use_clutter'"use_clutter", which can be set using
set_shape_model_paramSetShapeModelParam, can be queried by setting
GenParamNamegenParamNamegen_param_name to 'use_clutter'"use_clutter". For a description of the
parameters, please see set_shape_model_clutterSetShapeModelClutter and
set_shape_model_paramSetShapeModelParam.
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
ClutterRegionclutterRegionclutter_region (output_object) region → objectHObjectHRegionHObjectHobject *
Region where no clutter should occur.
ModelIDmodelIDmodel_id (input_control) shape_model → (handle)HTuple (HHandle)HShapeModel, HTuple (IntPtr)HHandleHtuple (handle)
Handle of the model.
GenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)
Parameter names.
Default: 'use_clutter'"use_clutter"
List of values: 'clutter_border_mode', 'use_clutter'"clutter_border_mode", "use_clutter"
GenParamValuegenParamValuegen_param_value (output_control) attribute.name(-array) → (string / real / integer)HTuple (HString / double / Hlong)HTuple (string / double / int / long)Sequence[Union[float, int, str]]Htuple (char* / double / Hlong)
Parameter values.
HomMat2DhomMat2Dhom_mat_2d (output_control) hom_mat2d → (real)HTuple (double)HHomMat2D, HTuple (double)Sequence[float]Htuple (double)
Transformation matrix.
ClutterContrastclutterContrastclutter_contrast (output_control) number → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)
Minimum contrast of clutter in the search images.
Result
If the parameters are valid, the operator get_shape_model_clutterGetShapeModelClutter
returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.
Combinations with other operators
Combinations
Possible predecessors
set_shape_model_clutterSetShapeModelClutter, read_shape_modelReadShapeModel, deserialize_shape_modelDeserializeShapeModel
Possible successors
find_shape_modelFindShapeModel, find_scaled_shape_modelFindScaledShapeModel, find_aniso_shape_modelFindAnisoShapeModel, find_shape_modelsFindShapeModels, find_scaled_shape_modelsFindScaledShapeModels, find_aniso_shape_modelsFindAnisoShapeModels
See also
create_shape_modelCreateShapeModel, create_scaled_shape_modelCreateScaledShapeModel, create_aniso_shape_modelCreateAnisoShapeModel, set_shape_model_paramSetShapeModelParam
Module
Matching