Operator Reference

HALCON Operator Reference / Legacy / Matching

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

ClassesClasses | | Operators

read_templateT_read_templateReadTemplateReadTemplateread_template (Operator)

read_templateT_read_templateReadTemplateReadTemplateread_template — Reading a template from file.

Warning

read_templateread_templateReadTemplateReadTemplateread_template is obsolete and is only provided for reasons of backward compatibility. The operator will be removed with HALCON 25.11. New applications should use the shape-based or NCC-based operators instead.

Signature

read_template( : : FileName : TemplateID)

Herror T_read_template(const Htuple FileName, Htuple* TemplateID)

void ReadTemplate(const HTuple& FileName, HTuple* TemplateID)

void HTemplate::HTemplate(const HString& FileName)

void HTemplate::HTemplate(const char* FileName)

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

void HTemplate::ReadTemplate(const HString& FileName)

void HTemplate::ReadTemplate(const char* FileName)

void HTemplate::ReadTemplate(const wchar_t* FileName)   ( Windows only)

static void HOperatorSet.ReadTemplate(HTuple fileName, out HTuple templateID)

public HTemplate(string fileName)

void HTemplate.ReadTemplate(string fileName)

def read_template(file_name: str) -> HHandle

Description

The operator read_templateread_templateReadTemplateReadTemplateread_template reads a matching template from file which has been written with write_templatewrite_templateWriteTemplateWriteTemplatewrite_template. The default HALCON file extension for a template is 'gvt'.

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

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

file name.

File extension: .gvt

TemplateIDTemplateIDTemplateIDtemplateIDtemplate_id (output_control)  template → HTemplate, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Template number.

Result

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

Possible Successors

adapt_templateadapt_templateAdaptTemplateAdaptTemplateadapt_template, set_reference_templateset_reference_templateSetReferenceTemplateSetReferenceTemplateset_reference_template, set_offset_templateset_offset_templateSetOffsetTemplateSetOffsetTemplateset_offset_template, best_matchbest_matchBestMatchBestMatchbest_match, fast_matchfast_matchFastMatchFastMatchfast_match, best_match_rotbest_match_rotBestMatchRotBestMatchRotbest_match_rot

Module

Matching

---

ClassesClasses | | Operators