Operator Reference

HALCON Operator Reference / Legacy / Classification

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

read_class_boxT_read_class_boxReadClassBoxReadClassBoxread_class_box (Operator)

read_class_boxT_read_class_boxReadClassBoxReadClassBoxread_class_box — Read a classifier from a file.

Warning

read_class_boxread_class_boxReadClassBoxReadClassBoxread_class_box 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

read_class_box( : : ClassifHandle, FileName : )

Herror T_read_class_box(const Htuple ClassifHandle, const Htuple FileName)

void ReadClassBox(const HTuple& ClassifHandle, const HTuple& FileName)

void HClassBox::ReadClassBox(const HString& FileName) const

void HClassBox::ReadClassBox(const char* FileName) const

void HClassBox::ReadClassBox(const wchar_t* FileName) const   ( Windows only)

static void HOperatorSet.ReadClassBox(HTuple classifHandle, HTuple fileName)

void HClassBox.ReadClassBox(string fileName)

def read_class_box(classif_handle: HHandle, file_name: str) -> None

Description

read_class_boxread_class_boxReadClassBoxReadClassBoxread_class_box reads the saved classifier from the file FileNameFileNameFileNamefileNamefile_name (see write_class_boxwrite_class_boxWriteClassBoxWriteClassBoxwrite_class_box). The values of the current classifier are overwritten. The default HALCON file extension for the box classifier is 'gbc'.

Attention

All values of the classifier are going to be overwritten.

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:

• ClassifHandleClassifHandleClassifHandleclassifHandleclassif_handle

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.

FileNameFileNameFileNamefileNamefile_name (input_control)  filename.read → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Filename of the classifier.

File extension: .gbc

Result

read_class_boxread_class_boxReadClassBoxReadClassBoxread_class_box returns 2 ( H_MSG_TRUE) . An exception is raised if it was not possible to open file FileNameFileNameFileNamefileNamefile_name or the file has the wrong format.

Possible Predecessors

create_class_boxcreate_class_boxCreateClassBoxCreateClassBoxcreate_class_box

Possible Successors

test_sampset_boxtest_sampset_boxTestSampsetBoxTestSampsetBoxtest_sampset_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, write_class_boxwrite_class_boxWriteClassBoxWriteClassBoxwrite_class_box

Module

Foundation

---

ClassesClasses | | Operators