Operator Reference

HALCON Operator Reference / Object / Information
ClassesClasses | | Operators

get_obj_classget_obj_classGetObjClassGetObjClassget_obj_class (Operator)

get_obj_classget_obj_classGetObjClassGetObjClassget_obj_class — Name of the class of an image object.

Signature

get_obj_class(Object : : : Class)

Herror get_obj_class(const Hobject Object, char* Class)

Herror T_get_obj_class(const Hobject Object, Htuple* Class)

void GetObjClass(const HObject& Object, HTuple* Class)

HTuple HObject::GetObjClass() const

static void HOperatorSet.GetObjClass(HObject objectVal, out HTuple classVal)

HTuple HObject.GetObjClass()

def get_obj_class(object: HObject) -> Sequence[str]

def get_obj_class_s(object: HObject) -> str

Description

get_obj_classget_obj_classGetObjClassGetObjClassget_obj_class returns the name of the corresponding class to each object. The following classes are possible:

'image'

Object with region (definition domain) and at least one channel.

'region'

Object with a region without gray values.

'xld_cont'

XLD object as contour

'xld_poly'

XLD object as polygon

'xld_parallel'

XLD object with parallel polygons

For a short description of the iconic objects that are available in HALCON see the introduction of chapter Object.

Execution Information

  • Supports objects on compute devices.
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

ObjectObjectObjectobjectValobject (input_object)  object(-array) → objectHObjectHObjectHObjectHobject

Image objects to be examined.

ClassClassClassclassValclass (output_control)  string(-array) → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Name of class.

Result

If the parameter values are correct the operator get_obj_classget_obj_classGetObjClassGetObjClassget_obj_class returns the value 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

Possible Successors

disp_imagedisp_imageDispImageDispImagedisp_image, disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_xlddisp_xldDispXldDispXlddisp_xld

See also

get_channel_infoget_channel_infoGetChannelInfoGetChannelInfoget_channel_info, count_relationcount_relationCountRelationCountRelationcount_relation

Module

Foundation

ClassesClasses | | Operators