select_objSelectObjSelectObjselect_objselect_obj
Short description
select_objSelectObjSelectObjselect_objselect_obj — Select objects from an object tuple.
Signature
select_obj( object Objects, out object ObjectSelected, integer Index )void SelectObj( const HObject& Objects, HObject* ObjectSelected, const HTuple& Index )static void HOperatorSet.SelectObj( HObject objects, out HObject objectSelected, HTuple index )def select_obj( objects: HObject, index: MaybeSequence[int] ) -> HObject
Herror select_obj( const Hobject Objects, Hobject* ObjectSelected, const Hlong Index )
Herror T_select_obj( const Hobject Objects, Hobject* ObjectSelected, const Htuple Index )
HObject HObject::SelectObj( const HTuple& Index ) const
HObject HObject::SelectObj( Hlong Index ) const
HImage HImage::SelectObj( const HTuple& Index ) const
HImage HImage::SelectObj( Hlong Index ) const
HRegion HRegion::SelectObj( const HTuple& Index ) const
HRegion HRegion::SelectObj( Hlong Index ) const
HXLD HXLD::SelectObj( const HTuple& Index ) const
HXLD HXLD::SelectObj( Hlong Index ) const
HXLDCont HXLDCont::SelectObj( const HTuple& Index ) const
HXLDCont HXLDCont::SelectObj( Hlong Index ) const
HXLDPoly HXLDPoly::SelectObj( const HTuple& Index ) const
HXLDPoly HXLDPoly::SelectObj( Hlong Index ) const
HXLDPara HXLDPara::SelectObj( const HTuple& Index ) const
HXLDPara HXLDPara::SelectObj( Hlong Index ) const
HXLDModPara HXLDModPara::SelectObj( const HTuple& Index ) const
HXLDModPara HXLDModPara::SelectObj( Hlong Index ) const
HXLDExtPara HXLDExtPara::SelectObj( const HTuple& Index ) const
HXLDExtPara HXLDExtPara::SelectObj( Hlong Index ) const
HObject HObject.SelectObj( HTuple index )
HObject HObject.SelectObj( int index )
HImage HImage.SelectObj( HTuple index )
HImage HImage.SelectObj( int index )
HRegion HRegion.SelectObj( HTuple index )
HRegion HRegion.SelectObj( int index )
HXLD HXLD.SelectObj( HTuple index )
HXLD HXLD.SelectObj( int index )
HXLDCont HXLDCont.SelectObj( HTuple index )
HXLDCont HXLDCont.SelectObj( int index )
HXLDPoly HXLDPoly.SelectObj( HTuple index )
HXLDPoly HXLDPoly.SelectObj( int index )
HXLDPara HXLDPara.SelectObj( HTuple index )
HXLDPara HXLDPara.SelectObj( int index )
HXLDModPara HXLDModPara.SelectObj( HTuple index )
HXLDModPara HXLDModPara.SelectObj( int index )
HXLDExtPara HXLDExtPara.SelectObj( HTuple index )
HXLDExtPara HXLDExtPara.SelectObj( int index )
Description
select_objSelectObj copies the iconic objects with the indices given
by Indexindexindex (starting with 1) from the iconic input object
tuple Objectsobjectsobjects to the output object ObjectSelectedobjectSelectedobject_selected.
No new storage is allocated for the regions and images. Instead,
new objects containing references to the existing objects are
created. The number of objects in an object tuple can be queried
with the operator count_objCountObj.
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
Objectsobjectsobjects (input_object) object(-array) → objectHObjectHObjectHObjectHobject
Input objects.
ObjectSelectedobjectSelectedobject_selected (output_object) object(-array) → objectHObjectHObjectHObjectHobject *
Selected objects.
Indexindexindex (input_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)
Indices of the objects to be selected.
Default: 11
Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 50, 100, 200, 500, 1000, 2000, 50001, 2, 3, 4, 5, 6, 7, 8, 9, 10, 50, 100, 200, 500, 1000, 2000, 5000
Restriction: Index >= 1
Example
(C)
/* Access to all Regions */
count_obj(Regions,&Num)\;
for (i=1\; i<=Num\; i++)
{
select_obj(Regions,&Single,i)\;
T_get_region_polygon(Single,5.0,&Row,&Column)\;
T_disp_polygon(WindowHandleTuple,Row,Column)\;
destroy_tuple(Row)\;
destroy_tuple(Column)\;
}
Complexity
Runtime complexity: \(O(|\textrm{Objects}|)\)
Result
select_objSelectObj returns 2 (H_MSG_TRUE) if all objects are contained in
the HALCON database and all parameters are correct. If the input
is empty the behavior can be set via
set_system(::'no_object_result',<Result>:).
If necessary, an exception is raised.
Combinations with other operators
Combinations
Possible predecessors
count_objCountObj
Alternatives
copy_objCopyObj
See also
count_objCountObj, concat_objConcatObj, obj_to_integerObjToInteger
Module
Foundation