Type definitions for data components. More...

Typedefs
typedef enum MVDataComponentType_t	MVDataComponentType_t

typedef struct _MVDataComponent_t *	MVDataComponent_t
	Opaque data type which holds a data component. More...

typedef struct _MVDataComponentDescriptor_t *	MVDataComponentDescriptor_t
	Opaque data type which holds options for a data component. More...

Enumerations
enum	MVDataComponentType_t { eMVDataComponentType_Null = 0, eMVDataComponentType_Error = 1, eMVDataComponentType_ImagePNG = 2, eMVDataComponentType_ImageJPEG = 3, eMVDataComponentType_HSerializedItem = 4 }

Detailed Description

Type definitions for data components.

DataComponentDescriptor Parameter Table

DataComponentType	Parameter	Semantics	Parameter Type	Domain
all image types	MV_PARAM_IMAGE_WIDTH	image width	UInt64	positive integers
all image types	MV_PARAM_IMAGE_HEIGHT	image height	UInt64	positive integers
eMVDataComponentType_ImagePNG	MV_PARAM_IMAGE_PNG_COMPRESSION	PNG compression level	UInt8	[0, 9]
eMVDataComponentType_ImageJPEG	MV_PARAM_IMAGE_JPEG_PROGRESSIVE	JPEG progressive flag	Bool
eMVDataComponentType_ImageJPEG	MV_PARAM_IMAGE_JPEG_QUALITY	JPEG quality percentage	UInt8	[0, 100]
eMVDataComponentType_HSerializedItem	none

Typedef Documentation

◆ MVDataComponent_t

typedef struct _MVDataComponent_t* MVDataComponent_t

Opaque data type which holds a data component.

MVDataComponent_t is a pointer to an opaque data structure. Data components can be obtained either directly through MV_DataContainer_Next() or indirectly through the use of the macro MV_DataContainer_foreach(). In both cases, only non-owning references are obtained and the underlying data is owned by the associated data container.

A data component represents a single binary datum (i.e. an image) or an error in its place. The type of the data component can be queried with MV_DataComponent_GetType() and will correspond to the type of the corresponding data component descriptor or eMVDataComponentType_Error if the data component corresponding to the requested descriptor could not be retrieved. See mv_data_component.h for functions for working with data components.

◆ MVDataComponentDescriptor_t

typedef struct _MVDataComponentDescriptor_t* MVDataComponentDescriptor_t

Opaque data type which holds options for a data component.

MVDataComponentDescriptor_t is a pointer to an opaque data structure. Data component descriptors can only be obtained through data container descriptors from the corresponding results, either directly through MV_DataContainerDescriptor_Next() or through the use of the macro MV_DataContainerDescriptor_foreach(). In both cases, only non-owning references are obtained. It is not possible to create new data component descriptors but it is possible to duplicate them and append them to new data container descriptors using MV_DataContainerDescriptor_AddComponent().

Data component descriptors have a type and parameters associated with them. Initially, their respective values reflect the "native" format, image size, etc., in which the data are present in the vision system. These can be overwritten to satisfy the individual requirements of the plug-in. See mv_data_component.h for functions to query and modify them.

Enumeration Type Documentation

◆ MVDataComponentType_t

enum MVDataComponentType_t

Enumerator
eMVDataComponentType_Null	Placeholder for an invalid data component type.
eMVDataComponentType_Error	Placeholder for a data component which could not be retrieved.
eMVDataComponentType_ImagePNG	2D image PNG data component
eMVDataComponentType_ImageJPEG	2D image JPEG data component
eMVDataComponentType_HSerializedItem	HALCON serialized item data component.

Typedefs