ClassesClassesClassesClasses | | | | Operators

read_training_componentsread_training_componentsReadTrainingComponentsread_training_componentsReadTrainingComponentsReadTrainingComponents (Operator)

Name

read_training_componentsread_training_componentsReadTrainingComponentsread_training_componentsReadTrainingComponentsReadTrainingComponents — Read a component training result from a file.

Signature

read_training_components( : : FileName : ComponentTrainingID)

Herror read_training_components(const char* FileName, Hlong* ComponentTrainingID)

Herror T_read_training_components(const Htuple FileName, Htuple* ComponentTrainingID)

Herror read_training_components(const HTuple& FileName, Hlong* ComponentTrainingID)

void HComponentTraining::ReadTrainingComponents(const HTuple& FileName)

void ReadTrainingComponents(const HTuple& FileName, HTuple* ComponentTrainingID)

void HComponentTraining::ReadTrainingComponents(const HString& FileName)

void HComponentTraining::ReadTrainingComponents(const char* FileName)

void HOperatorSetX.ReadTrainingComponents(
[in] VARIANT FileName, [out] VARIANT* ComponentTrainingID)

void HComponentTrainingX.ReadTrainingComponents([in] BSTR FileName)

static void HOperatorSet.ReadTrainingComponents(HTuple fileName, out HTuple componentTrainingID)

void HComponentTraining.ReadTrainingComponents(string fileName)

Description

The operator read_training_componentsread_training_componentsReadTrainingComponentsread_training_componentsReadTrainingComponentsReadTrainingComponents reads a component training result, which has been written with write_training_componentswrite_training_componentsWriteTrainingComponentswrite_training_componentsWriteTrainingComponentsWriteTrainingComponents, from the file FileNameFileNameFileNameFileNameFileNamefileName and returns it in ComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDcomponentTrainingID. The default HALCON file extension for the component training result is 'ct'.

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

FileNameFileNameFileNameFileNameFileNamefileName (input_control)  filename.read HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

File name.

File extension: .ct

ComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDcomponentTrainingID (output_control)  component_training HComponentTraining, HTupleHTupleHComponentTraining, HTupleHComponentTrainingX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the training result.

Result

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

Possible Successors

create_trained_component_modelcreate_trained_component_modelCreateTrainedComponentModelcreate_trained_component_modelCreateTrainedComponentModelCreateTrainedComponentModel

See also

train_model_componentstrain_model_componentsTrainModelComponentstrain_model_componentsTrainModelComponentsTrainModelComponents, clear_training_componentsclear_training_componentsClearTrainingComponentsclear_training_componentsClearTrainingComponentsClearTrainingComponents

Module

Matching


ClassesClassesClassesClasses | | | | Operators