Skip to content

read_training_componentsReadTrainingComponentsReadTrainingComponentsread_training_componentsT_read_training_components🔗

Short description🔗

read_training_componentsReadTrainingComponentsReadTrainingComponentsread_training_componentsT_read_training_components — Read a component training result from a file.

Warning🔗

read_training_componentsReadTrainingComponents is obsolete and is only provided for reasons of backward compatibility. The operator will be removed with HALCON 26.11.

Signature🔗

read_training_components( filename.read FileName, out component_training ComponentTrainingID )void ReadTrainingComponents( const HTuple& FileName, HTuple* ComponentTrainingID )static void HOperatorSet.ReadTrainingComponents( HTuple fileName, out HTuple componentTrainingID )def read_training_components( file_name: str ) -> HHandle

Herror T_read_training_components( const Htuple FileName, Htuple* ComponentTrainingID )

void HComponentTraining::ReadTrainingComponents( const HString& FileName )

void HComponentTraining::ReadTrainingComponents( const char* FileName )

void HComponentTraining::ReadTrainingComponents( const wchar_t* FileName ) (Windows only)

void HComponentTraining.ReadTrainingComponents( string fileName )

Description🔗

The operator read_training_componentsReadTrainingComponents reads a component training result, which has been written with write_training_componentsWriteTrainingComponents, from the file FileNamefileNamefile_name and returns it in ComponentTrainingIDcomponentTrainingIDcomponent_training_id. The default HALCON file extension for the component training result is 'ct'.

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 returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters🔗

FileNamefileNamefile_name (input_control) filename.read → (string)HTuple (HString)HTuple (string)strHtuple (char*)

File name.

File extension: .ct

ComponentTrainingIDcomponentTrainingIDcomponent_training_id (output_control) component_training → (handle)HTuple (HHandle)HComponentTraining, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the training result.

Result🔗

If the file name is valid, the operator read_training_componentsReadTrainingComponents returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Module🔗

Matching