Skip to content

read_variation_modelReadVariationModelReadVariationModelread_variation_modelT_read_variation_model🔗

Short description🔗

read_variation_modelReadVariationModelReadVariationModelread_variation_modelT_read_variation_model — Read a variation model from a file.

Signature🔗

read_variation_model( filename.read FileName, out variation_model ModelID )void ReadVariationModel( const HTuple& FileName, HTuple* ModelID )static void HOperatorSet.ReadVariationModel( HTuple fileName, out HTuple modelID )def read_variation_model( file_name: str ) -> HHandle

Herror T_read_variation_model( const Htuple FileName, Htuple* ModelID )

void HVariationModel::HVariationModel( const HString& FileName )

void HVariationModel::HVariationModel( const char* FileName )

void HVariationModel::HVariationModel( const wchar_t* FileName ) (Windows only)

public HVariationModel( string fileName )

void HVariationModel::ReadVariationModel( const HString& FileName )

void HVariationModel::ReadVariationModel( const char* FileName )

void HVariationModel::ReadVariationModel( const wchar_t* FileName ) (Windows only)

void HVariationModel.ReadVariationModel( string fileName )

Description🔗

The operator read_variation_modelReadVariationModel reads a variation model, which has been written with write_variation_modelWriteVariationModel, from the file FileNamefileNamefile_name. The default HALCON file extension for a variation model is 'vam'.

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: .vam

ModelIDmodelIDmodel_id (output_control) variation_model → (handle)HTuple (HHandle)HVariationModel, HTuple (IntPtr)HHandleHtuple (handle)

ID of the variation model.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible successors

compare_variation_modelCompareVariationModel, compare_ext_variation_modelCompareExtVariationModel

See also

write_variation_modelWriteVariationModel

Module🔗

Matching