get_class_box_paramT_get_class_box_paramGetClassBoxParamGetClassBoxParamget_class_box_param (Operator)

Name

get_class_box_paramT_get_class_box_paramGetClassBoxParamGetClassBoxParamget_class_box_param — Get information about the current parameter.

Warning

get_class_box_paramget_class_box_paramGetClassBoxParamGetClassBoxParamget_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.

Signature

get_class_box_param( : : ClassifHandle, Flag : Value)

Herror T_get_class_box_param(const Htuple ClassifHandle, const Htuple Flag, Htuple* Value)

void GetClassBoxParam(const HTuple& ClassifHandle, const HTuple& Flag, HTuple* Value)

HTuple HClassBox::GetClassBoxParam(const HString& Flag) const

HTuple HClassBox::GetClassBoxParam(const char* Flag) const

HTuple HClassBox::GetClassBoxParam(const wchar_t* Flag) const   ( Windows only)

static void HOperatorSet.GetClassBoxParam(HTuple classifHandle, HTuple flag, out HTuple value)

HTuple HClassBox.GetClassBoxParam(string flag)

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

Description

get_class_box_paramget_class_box_paramGetClassBoxParamGetClassBoxParamget_class_box_param gets the parameter of the classifier. The meaning of the parameter is explained in set_class_box_paramset_class_box_paramSetClassBoxParamSetClassBoxParamset_class_box_param.

Default values: '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

Parameters

ClassifHandleClassifHandleClassifHandleclassifHandleclassif_handle (input_control)  class_box HClassBox, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the classifier.

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

Name of the system parameter.

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

List of values: 'min_samples_for_split'"min_samples_for_split""min_samples_for_split""min_samples_for_split""min_samples_for_split", 'prop_constant'"prop_constant""prop_constant""prop_constant""prop_constant", 'split_error'"split_error""split_error""split_error""split_error", 'used_memory'"used_memory""used_memory""used_memory""used_memory"

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

Value of the system parameter.

Result

get_class_box_paramget_class_box_paramGetClassBoxParamGetClassBoxParamget_class_box_param returns 2 ( H_MSG_TRUE) . An exception is raised if FlagFlagFlagflagflag has been set with wrong values.

Possible Predecessors

create_class_boxcreate_class_boxCreateClassBoxCreateClassBoxcreate_class_box, enquire_class_boxenquire_class_boxEnquireClassBoxEnquireClassBoxenquire_class_box, learn_class_boxlearn_class_boxLearnClassBoxLearnClassBoxlearn_class_box, write_class_boxwrite_class_boxWriteClassBoxWriteClassBoxwrite_class_box

Possible Successors

set_class_box_paramset_class_box_paramSetClassBoxParamSetClassBoxParamset_class_box_param, learn_class_boxlearn_class_boxLearnClassBoxLearnClassBoxlearn_class_box, enquire_class_boxenquire_class_boxEnquireClassBoxEnquireClassBoxenquire_class_box, write_class_boxwrite_class_boxWriteClassBoxWriteClassBoxwrite_class_box, close_class_boxclose_class_boxCloseClassBoxCloseClassBoxclose_class_box, clear_sampsetclear_sampsetClearSampsetClearSampsetclear_sampset

See also

create_class_boxcreate_class_boxCreateClassBoxCreateClassBoxcreate_class_box, set_class_box_paramset_class_box_paramSetClassBoxParamSetClassBoxParamset_class_box_param

Module

Foundation