A dynamic list with a CVCCompositePurpose to group **OBJ**s. More...
Typedefs | |
typedef void * | CVCOMPOSITE |
CVB composite handle. More... | |
Enumerations | |
enum | CVCCompositePurpose { CVCCP_Custom = -1 , CVCCP_Image = 0 , CVCCP_ImageList , CVCCP_MultiAoi , CVCCP_RangeMap , CVCCP_PointCloud , CVCCP_ImageCube } |
The purpose for grouping other CVB OBJs. More... | |
Functions | |
cvbres_t | CVCCompositeGetAt (CVCOMPOSITE hComposite, cvbdim_t Index, OBJ &hObj) |
Gets the stored element hObj at the given Index in the given composite object. More... | |
cvbres_t | CVCCompositeGetCount (CVCOMPOSITE hComposite, cvbdim_t &NumElements) |
Gets the number of elements in the given composite object. More... | |
cvbres_t | CVCCompositeGetPurpose (CVCOMPOSITE hComposite, CVCCompositePurpose &Purpose) |
Gets the Purpose of the given composite object. More... | |
cvbres_t | CVCCompositeInsertAt (CVCOMPOSITE hComposite, cvbdim_t Index, OBJ hObj) |
Inserts the hObj at the given Index into the given object list. More... | |
cvbres_t | CVCCompositeRemoveAt (CVCOMPOSITE hComposite, cvbdim_t Index) |
Removes the element at the given Index in the given composite object. More... | |
CVCOMPOSITE | CVCCreateComposite (CVCCompositePurpose Purpose) |
Creates a CVB Composite. More... | |
cvbbool_t | CVCIsComposite (CVCOMPOSITE hComposite) |
Gets whether the given hComposite really is a composite object. More... | |
A dynamic list with a CVCCompositePurpose to group **OBJ**s.
IComposite objects are used to group an arbitrary list of **OBJ**s (i.e. IDisposableTypes, see CVCImg library documentation). As it is itself a IDisposableType, tree like structures are possible. But normally they are used as lists.
The Purpose attribute specifies the grouping reason. You can find additional information about the exact usage of these objects in the libraries using them. For example see CVCore3D library documentation on the CVCCP_PointCloud Purpose.
CVB composite handle.
The CVCOMPOSITE is a reference counted OBJ handle. CVCOMPOSITE objects at least implement the IComposite interface.
enum CVCCompositePurpose |
The purpose for grouping other CVB OBJs.
Enumerator | |
---|---|
CVCCP_Custom | Not generically defined use case. |
CVCCP_Image | A single image with (possibly distributed) plane buffers. See IBuffer and IPFNCBuffer. |
CVCCP_ImageList | Multiple images for e.g. stereo vision. |
CVCCP_MultiAoi | Multiple AOIs (images) from a single sensor. |
CVCCP_RangeMap | 2D image containing depth (Z) instead of luminance. |
CVCCP_PointCloud | Sparse point cloud (list of points). See CVCore3D library documentation for more details. |
CVCCP_ImageCube | A logical stack of images. The planes of the IImageVPA do not correspond to color, but to different data like spectral frequencies. |
cvbres_t CVCCompositeGetAt | ( | CVCOMPOSITE | hComposite, |
cvbdim_t | Index, | ||
OBJ & | hObj | ||
) |
Gets the stored element hObj at the given Index in the given composite object.
[in] | hComposite | Handle of composite object to query. |
[in] | Index | Zero based index of element to be retrieved. |
[out] | hObj | Variable to receive the element handle. |
cvbres_t CVCCompositeGetCount | ( | CVCOMPOSITE | hComposite, |
cvbdim_t & | NumElements | ||
) |
Gets the number of elements in the given composite object.
[in] | hComposite | Handle of composite object to query. |
[out] | NumElements | Number of elements in the hComposite object. |
cvbres_t CVCCompositeGetPurpose | ( | CVCOMPOSITE | hComposite, |
CVCCompositePurpose & | Purpose | ||
) |
Gets the Purpose of the given composite object.
[in] | hComposite | Handle of the composite object to query. |
[out] | Purpose | The purpose of the given hComposite |
cvbres_t CVCCompositeInsertAt | ( | CVCOMPOSITE | hComposite, |
cvbdim_t | Index, | ||
OBJ | hObj | ||
) |
Inserts the hObj at the given Index into the given object list.
If you want to append to the composite object, insert at the index equaling the number of elements in the list:
[in] | hComposite | Handle of composite object to insert into. |
[in] | Index | Zero based index of where to insert the element. |
[out] | hObj | Variable to receive the element handle |
cvbres_t CVCCompositeRemoveAt | ( | CVCOMPOSITE | hComposite, |
cvbdim_t | Index | ||
) |
Removes the element at the given Index in the given composite object.
[in] | hComposite | Handle of composite object to remove from. |
[in] | Index | Zero based index of where to remove the element. |
CVCOMPOSITE CVCCreateComposite | ( | CVCCompositePurpose | Purpose | ) |
Creates a CVB Composite.
A composite aggregates several other CVB OBJ handles and shares their life time.
[in] | Purpose | The purpose of the composite to be created. |
cvbbool_t CVCIsComposite | ( | CVCOMPOSITE | hComposite | ) |
Gets whether the given hComposite really is a composite object.
[in] | hComposite | Handle to check. |