Operator Reference

HALCON Operator Reference / Legacy / Matching
ClassesClasses | | Operators

clear_templateT_clear_templateClearTemplateClearTemplateclear_template (Operator)

clear_templateT_clear_templateClearTemplateClearTemplateclear_template — Deallocation of the memory of a template.

Warning

clear_templateclear_templateClearTemplateClearTemplateclear_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

clear_template( : : TemplateID : )

Herror T_clear_template(const Htuple TemplateID)

void ClearTemplate(const HTuple& TemplateID)

void HTemplate::ClearTemplate() const

static void HOperatorSet.ClearTemplate(HTuple templateID)

void HTemplate.ClearTemplate()

def clear_template(template_id: HHandle) -> None

Description

The operator clear_templateclear_templateClearTemplateClearTemplateclear_template deallocates the memory of a template which has been created by create_templatecreate_templateCreateTemplateCreateTemplatecreate_template or create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotcreate_template_rot. After execution of the operator clear_templateclear_templateClearTemplateClearTemplateclear_template the template can no longer be used. The value of TemplateIDTemplateIDTemplateIDtemplateIDtemplate_id is not valid. However, the number can be used again by further calls of create_templatecreate_templateCreateTemplateCreateTemplatecreate_template or create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotcreate_template_rot.

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 modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

TemplateIDTemplateIDTemplateIDtemplateIDtemplate_id (input_control, state is modified)  template → HTemplate, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Template number.

Result

If the number of the template is valid, the operator clear_templateclear_templateClearTemplateClearTemplateclear_template returns the value 2 ( H_MSG_TRUE) . If necessary an exception is raised.

Possible Predecessors

create_templatecreate_templateCreateTemplateCreateTemplatecreate_template, create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotcreate_template_rot, read_templateread_templateReadTemplateReadTemplateread_template, write_templatewrite_templateWriteTemplateWriteTemplatewrite_template

Module

Matching

ClassesClasses | | Operators