Skip to content

set_ncc_model_paramSetNccModelParamSetNccModelParamset_ncc_model_paramT_set_ncc_model_param🔗

Short description🔗

set_ncc_model_paramSetNccModelParamSetNccModelParamset_ncc_model_paramT_set_ncc_model_param — Set selected parameters of the NCC model.

Signature🔗

set_ncc_model_param( ncc_model ModelID, attribute.name GenParamName, attribute.value GenParamValue )void SetNccModelParam( const HTuple& ModelID, const HTuple& GenParamName, const HTuple& GenParamValue )static void HOperatorSet.SetNccModelParam( HTuple modelID, HTuple genParamName, HTuple genParamValue )def set_ncc_model_param( model_id: HHandle, gen_param_name: Sequence[str], gen_param_value: Sequence[Union[float, int, str]] ) -> None

Herror T_set_ncc_model_param( const Htuple ModelID, const Htuple GenParamName, const Htuple GenParamValue )

void HNCCModel::SetNccModelParam( const HTuple& GenParamName, const HTuple& GenParamValue ) const

static void HImage::SetNccModelParam( const HNCCModel& ModelID, const HTuple& GenParamName, const HTuple& GenParamValue )

void HNCCModel.SetNccModelParam( HTuple genParamName, HTuple genParamValue )

static void HImage.SetNccModelParam( HNCCModel modelID, HTuple genParamName, HTuple genParamValue )

Description🔗

The operator set_ncc_model_paramSetNccModelParam sets the selected parameters GenParamNamegenParamNamegen_param_name in the NCC model ModelIDmodelIDmodel_id. The following parameters can be modified:

'timeout'"timeout"

Sets the maximum runtime of the operators used to find the NCC model ModelIDmodelIDmodel_id (using find_ncc_modelFindNccModel). This is especially useful in cases where a maximum cycle time has to be ensured. The 'timeout'"timeout" must be given in milliseconds. The temporal accuracy depends on several factors including the size of the model, the speed of your computer, and the 'timer_mode'"timer_mode" set via set_systemSetSystem. Be aware that the runtime of the search increases by up to 10 percent with activated timeout. To disable the timeout you can either use a negative value or 'false'"false".

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters🔗

ModelIDmodelIDmodel_id (input_control, state is modified) ncc_model → (handle)HTuple (HHandle)HNCCModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the model.

GenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Parameter names.

List of values: 'timeout'"timeout"

GenParamValuegenParamValuegen_param_value (input_control) attribute.value-array → (real / integer / string)HTuple (double / Hlong / HString)HTuple (double / int / long / string)Sequence[Union[float, int, str]]Htuple (double / Hlong / char*)

Parameter values.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_ncc_modelCreateNccModel

Possible successors

find_ncc_modelFindNccModel

Module🔗

Matching