Operator Reference

set_class_box_paramT_set_class_box_paramSetClassBoxParamSetClassBoxParamset_class_box_param (Operator)

set_class_box_paramT_set_class_box_paramSetClassBoxParamSetClassBoxParamset_class_box_param — Set system parameters for classification.

Warning

set_class_box_paramset_class_box_paramSetClassBoxParamSetClassBoxParamset_class_box_param is obsolete and is only provided for reasons of backward compatibility. New applications should use the MLP, SVM, KNN or GMM operators instead. The operator will be removed with HALCON 25.11.

Signature

set_class_box_param( : : ClassifHandle, Flag, Value : )

Herror T_set_class_box_param(const Htuple ClassifHandle, const Htuple Flag, const Htuple Value)

void SetClassBoxParam(const HTuple& ClassifHandle, const HTuple& Flag, const HTuple& Value)

void HClassBox::SetClassBoxParam(const HString& Flag, const HTuple& Value) const

void HClassBox::SetClassBoxParam(const HString& Flag, double Value) const

void HClassBox::SetClassBoxParam(const char* Flag, double Value) const

void HClassBox::SetClassBoxParam(const wchar_t* Flag, double Value) const   ( Windows only)

static void HOperatorSet.SetClassBoxParam(HTuple classifHandle, HTuple flag, HTuple value)

void HClassBox.SetClassBoxParam(string flag, HTuple value)

void HClassBox.SetClassBoxParam(string flag, double value)

def set_class_box_param(classif_handle: HHandle, flag: str, value: Union[int, float]) -> None

Description

set_class_box_paramset_class_box_paramSetClassBoxParamSetClassBoxParamset_class_box_param modifies parameter which manipulate the training sequence while calling learn_class_boxlearn_class_boxLearnClassBoxLearnClassBoxlearn_class_box. Only parameters of the classifier are modified, all other classifiers remain unmodified. 'min_samples_for_split'"min_samples_for_split""min_samples_for_split""min_samples_for_split""min_samples_for_split" is the number of examples at least which have to train in one cuboid of this classifier, before the cuboid is allowed to divide itself. 'split_error'"split_error""split_error""split_error""split_error" indicates the critical error. By its exceeding the cuboid divides itself, if there are more than 'min_samples_for_split'"min_samples_for_split""min_samples_for_split""min_samples_for_split""min_samples_for_split" examples to train. 'prop_constant'"prop_constant""prop_constant""prop_constant""prop_constant" manipulates the extension of the cuboids. It is proportional to the average distance of the training examples in this cuboid to the center of the cuboid. More detailed:

extension x prop = average distance of the expectation value. This relation is valid in every dimension. Hence inside a cuboid the dimensions of the feature space are supposed to be independent.

The parameters are set with problem independent default values, which must not modified without any reason. Parameters are only important during a learning sequence. They do not influence on the behavior of enquire_class_boxenquire_class_boxEnquireClassBoxEnquireClassBoxenquire_class_box.

Default: 'min_samples_for_split'"min_samples_for_split""min_samples_for_split""min_samples_for_split""min_samples_for_split" = 80, 'split_error'"split_error""split_error""split_error""split_error" = 0.1, 'prop_constant'"prop_constant""prop_constant""prop_constant""prop_constant" = 0.25.

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

ClassifHandleClassifHandleClassifHandleclassifHandleclassif_handle (input_control, state is modified)  class_box HClassBox, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the classifier.

FlagFlagFlagflagflag (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the wanted parameter.

Default: 'split_error' "split_error" "split_error" "split_error" "split_error"

Suggested values: 'min_samples_for_split'"min_samples_for_split""min_samples_for_split""min_samples_for_split""min_samples_for_split", 'split_error'"split_error""split_error""split_error""split_error", 'prop_constant'"prop_constant""prop_constant""prop_constant""prop_constant"

ValueValueValuevaluevalue (input_control)  number HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Value of the parameter.

Default: 0.1

Result

read_sampsetread_sampsetReadSampsetReadSampsetread_sampset returns 2 ( H_MSG_TRUE) .

Possible Predecessors

create_class_boxcreate_class_boxCreateClassBoxCreateClassBoxcreate_class_box, enquire_class_boxenquire_class_boxEnquireClassBoxEnquireClassBoxenquire_class_box

Possible Successors

learn_class_boxlearn_class_boxLearnClassBoxLearnClassBoxlearn_class_box, test_sampset_boxtest_sampset_boxTestSampsetBoxTestSampsetBoxtest_sampset_box, write_class_boxwrite_class_boxWriteClassBoxWriteClassBoxwrite_class_box, close_class_boxclose_class_boxCloseClassBoxCloseClassBoxclose_class_box, clear_sampsetclear_sampsetClearSampsetClearSampsetclear_sampset

See also

enquire_class_boxenquire_class_boxEnquireClassBoxEnquireClassBoxenquire_class_box, get_class_box_paramget_class_box_paramGetClassBoxParamGetClassBoxParamget_class_box_param, learn_class_boxlearn_class_boxLearnClassBoxLearnClassBoxlearn_class_box

Module

Foundation