get_generic_shape_model_objectT_get_generic_shape_model_objectGetGenericShapeModelObjectGetGenericShapeModelObjectget_generic_shape_model_object (Operator)

Name

get_generic_shape_model_objectT_get_generic_shape_model_objectGetGenericShapeModelObjectGetGenericShapeModelObjectget_generic_shape_model_object — Get iconic objects of the shape model.

Signature

get_generic_shape_model_object( : Object : ModelID, GenParamName : )

Herror T_get_generic_shape_model_object(Hobject* Object, const Htuple ModelID, const Htuple GenParamName)

void GetGenericShapeModelObject(HObject* Object, const HTuple& ModelID, const HTuple& GenParamName)

HObject HShapeModel::GetGenericShapeModelObject(const HTuple& GenParamName) const

static void HOperatorSet.GetGenericShapeModelObject(out HObject objectVal, HTuple modelID, HTuple genParamName)

HObject HShapeModel.GetGenericShapeModelObject(HTuple genParamName)

def get_generic_shape_model_object(model_id: HHandle, gen_param_name: Sequence[str]) -> HObject

Description

The operator get_generic_shape_model_objectget_generic_shape_model_objectGetGenericShapeModelObjectGetGenericShapeModelObjectGetGenericShapeModelObjectget_generic_shape_model_object reads out objects of the shape model ModelIDModelIDModelIDModelIDmodelIDmodel_id and returns them in ObjectObjectObjectObjectobjectValobject.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name specifies which iconic object will be returned. The following values are possible:

'clutter_region'"clutter_region""clutter_region""clutter_region""clutter_region""clutter_region":

The clutter region of the shape model.

Execution Information

Parameters

ObjectObjectObjectObjectobjectValobject (output_object)  (multichannel-)object(-array) objectHObjectHObjectHObjectHobject *

Iconic object to be returned.

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

Handle of the shape model.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  string-array HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Parameter names.

Default value: 'clutter_region' "clutter_region" "clutter_region" "clutter_region" "clutter_region" "clutter_region"

List of values: 'clutter_region'"clutter_region""clutter_region""clutter_region""clutter_region""clutter_region"

Result

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

Possible Predecessors

create_generic_shape_modelcreate_generic_shape_modelCreateGenericShapeModelCreateGenericShapeModelCreateGenericShapeModelcreate_generic_shape_model, set_generic_shape_model_objectset_generic_shape_model_objectSetGenericShapeModelObjectSetGenericShapeModelObjectSetGenericShapeModelObjectset_generic_shape_model_object, train_generic_shape_modeltrain_generic_shape_modelTrainGenericShapeModelTrainGenericShapeModelTrainGenericShapeModeltrain_generic_shape_model

Module

Matching