obj_to_integerobj_to_integerObjToIntegerObjToIntegerobj_to_integer (Operator)

Name

obj_to_integerobj_to_integerObjToIntegerObjToIntegerobj_to_integer — Convert an iconic object into an “integer number.”

Signature

obj_to_integer(Objects : : Index, Number : SurrogateTuple)

Herror obj_to_integer(const Hobject Objects, const Hlong Index, const Hlong Number, Hlong* SurrogateTuple)

Herror T_obj_to_integer(const Hobject Objects, const Htuple Index, const Htuple Number, Htuple* SurrogateTuple)

void ObjToInteger(const HObject& Objects, const HTuple& Index, const HTuple& Number, HTuple* SurrogateTuple)

HTuple HObject::ObjToInteger(Hlong Index, Hlong Number) const

static void HOperatorSet.ObjToInteger(HObject objects, HTuple index, HTuple number, out HTuple surrogateTuple)

HTuple HObject.ObjToInteger(int index, int number)

def obj_to_integer(objects: HObject, index: int, number: int) -> Sequence[int]

def obj_to_integer_s(objects: HObject, index: int, number: int) -> int

Description

obj_to_integerobj_to_integerObjToIntegerObjToIntegerObjToIntegerobj_to_integer stores NumberNumberNumberNumbernumbernumber, starting at index IndexIndexIndexIndexindexindex, of the database keys of the input object ObjectsObjectsObjectsObjectsobjectsobjects as integer numbers in the output parameter SurrogateTupleSurrogateTupleSurrogateTupleSurrogateTuplesurrogateTuplesurrogate_tuple. If -1 is passed for NumberNumberNumberNumbernumbernumber all objects beginning with IndexIndexIndexIndexindexindex are copied. This facilitates a direct access to an arbitrary element of ObjectsObjectsObjectsObjectsobjectsobjects. In conjunction with count_objcount_objCountObjCountObjCountObjcount_obj (returns the number of objects in ObjectsObjectsObjectsObjectsobjectsobjects) the elements of ObjectsObjectsObjectsObjectsobjectsobjects can be processed successively. The objects are not duplicated by obj_to_integerobj_to_integerObjToIntegerObjToIntegerObjToIntegerobj_to_integer and thus must not be cleared by clear_objclear_objClearObjClearObjClearObjclear_obj.

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

Attention

The objects' data is not duplicated.

Execution Information

Parameters

ObjectsObjectsObjectsObjectsobjectsobjects (input_object)  object(-array) objectHObjectHObjectHObjectHobject

Objects for which the surrogates are to be returned.

IndexIndexIndexIndexindexindex (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Starting index of the surrogates to be returned.

Default value: 1

Typical range of values: 1 ≤ Index Index Index Index index index

NumberNumberNumberNumbernumbernumber (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of surrogates to be returned.

Default value: -1

Restriction: Number == -1 || Number + Index <= number(Objects)

SurrogateTupleSurrogateTupleSurrogateTupleSurrogateTuplesurrogateTuplesurrogate_tuple (output_control)  pointer(-array) HTupleSequence[int]HTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Tuple containing the surrogates.

Example (HDevelop)

* Access the i-th element:
obj_to_integer(Objects,i,1,Surrogat)

Example (C)

/* Access the i-th element: */
Hlong i,Surrogate;
obj_to_integer(Objects,i,1,&Surrogat);

Example (HDevelop)

* Access the i-th element:
obj_to_integer(Objects,i,1,Surrogat)

Example (HDevelop)

* Access the i-th element:
obj_to_integer(Objects,i,1,Surrogat)

Example (HDevelop)

* Access the i-th element:
obj_to_integer(Objects,i,1,Surrogat)

Complexity

Runtime complexity: O(|ObjectsObjectsObjectsObjectsobjectsobjects| + NumberNumberNumberNumbernumbernumber)

Result

obj_to_integerobj_to_integerObjToIntegerObjToIntegerObjToIntegerobj_to_integer returns 2 (H_MSG_TRUE) if all parameters are correct. If the input is empty the behavior can be set via set_system(::'no_object_result',<Result>:)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>). If necessary, an exception is raised.

Alternatives

copy_objcopy_objCopyObjCopyObjCopyObjcopy_obj, select_objselect_objSelectObjSelectObjSelectObjselect_obj, copy_imagecopy_imageCopyImageCopyImageCopyImagecopy_image, gen_image_protogen_image_protoGenImageProtoGenImageProtoGenImageProtogen_image_proto

See also

integer_to_objinteger_to_objIntegerToObjIntegerToObjIntegerToObjinteger_to_obj, count_objcount_objCountObjCountObjCountObjcount_obj

Module

Foundation