read_training_componentsT_read_training_componentsReadTrainingComponentsReadTrainingComponentsread_training_components (Operator)

Name

read_training_componentsT_read_training_componentsReadTrainingComponentsReadTrainingComponentsread_training_components — Read a component training result from a file.

Signature

read_training_components( : : FileName : ComponentTrainingID)

Herror T_read_training_components(const Htuple FileName, Htuple* ComponentTrainingID)

void ReadTrainingComponents(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)

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

void HComponentTraining.ReadTrainingComponents(string fileName)

def read_training_components(file_name: str) -> HHandle

Description

The operator read_training_componentsread_training_componentsReadTrainingComponentsReadTrainingComponentsReadTrainingComponentsread_training_components reads a component training result, which has been written with write_training_componentswrite_training_componentsWriteTrainingComponentsWriteTrainingComponentsWriteTrainingComponentswrite_training_components, from the file FileNameFileNameFileNameFileNamefileNamefile_name and returns it in ComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDcomponentTrainingIDcomponent_training_id. The default HALCON file extension for the component training result is 'ct'.

Execution Information

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

FileNameFileNameFileNameFileNamefileNamefile_name (input_control)  filename.read HTuplestrHTupleHtuple (string) (string) (HString) (char*)

File name.

File extension: .ct

ComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDcomponentTrainingIDcomponent_training_id (output_control)  component_training HComponentTraining, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the training result.

Result

If the file name is valid, the operator read_training_componentsread_training_componentsReadTrainingComponentsReadTrainingComponentsReadTrainingComponentsread_training_components returns the value TRUE. If necessary, an exception is raised.

Possible Successors

create_trained_component_modelcreate_trained_component_modelCreateTrainedComponentModelCreateTrainedComponentModelCreateTrainedComponentModelcreate_trained_component_model

See also

train_model_componentstrain_model_componentsTrainModelComponentsTrainModelComponentsTrainModelComponentstrain_model_components, clear_training_componentsclear_training_componentsClearTrainingComponentsClearTrainingComponentsClearTrainingComponentsclear_training_components

Module

Matching