All IOLink symbols are enclosed in this namespace. More...

Classes
class	ArrayX
	A multi dimensionnal array. More...

class	ConstMetadataNodeIterator
	Class represents a const iterator on a list of Metadata nodes. More...

class	DataAccess
	Parent interface of interfaces used to manipulate raw bytes. More...

class	DataConverter
	Handle conversion of data buffers described by an IOLink DataType. More...

class	DataStorage
	Describes a data source, that manages and opens DataAccess instances. More...

class	DataType
	Stores information about a data type. More...

class	DataTypeTraits

class	DataTypeTraits< const char * >

class	DataTypeTraits< double >

class	DataTypeTraits< float >

class	DataTypeTraits< int16_t >

class	DataTypeTraits< int32_t >

class	DataTypeTraits< int64_t >

class	DataTypeTraits< int8_t >

class	DataTypeTraits< std::string >

class	DataTypeTraits< std::u16string >

class	DataTypeTraits< std::u32string >

class	DataTypeTraits< uint16_t >

class	DataTypeTraits< uint32_t >

class	DataTypeTraits< uint64_t >

class	DataTypeTraits< uint8_t >

class	DataTypeTraits< Vector< T, N > >

class	Error
	Error base class. More...

class	Extension
	Parent class for all views extensions. More...

class	FlagSet
	Template class to handle a flags system from an enum. More...

class	HTTPHeaders
	A class used to pass HTTP headers as input of factories methods. More...

class	ImageInfoProperty
	This property describes the way the axes must be interpreted (IMAGE, VOLUME, SEQUENCE...) and also the composition of the image by providing : More...

class	ImageProperties
	Hold additionnal info for ImageView data interpretation. More...

class	ImageType
	A flag system that describes the dimensions of an image. More...

class	ImageTypeId
	Enum for the image type (see ImageType) More...

class	ImageView
	Interface representing an N dimensional image. More...

class	ImageViewFactory
	This factory is aimed at creating dataset views. More...

class	ImageViewProvider
	Utility class to check and convert a View into an ImagevView. More...

class	Indexer
	This class is used to index a classic array into a multi dimensional array. More...

class	InvalidArgument
	'Invalid argument' error raised when an argument is not the one expected in a public method. More...

class	LodImageView
	A view on an image with multiple levels of detail (LOD). More...

class	LodImageViewProvider
	Utility class for LodImageView support. More...

class	Logger
	Manage IOLink logging. More...

class	Matrix
	An arithmetic square matrix. More...

class	MetadataNode
	Class which represents one node from a metadata tree. More...

class	MetadataNodeFactory
	A factory to build MetadataNode instances. More...

class	MetadataNodeHelper
	A collection of functions to handle paths on MetadataNode instances. More...

class	MetadataNodeIterator
	Class represents an iterator on a list of Metadata nodes. More...

class	MultiImageView
	Interface representing a multi-image view, i.e. More...

class	MultiImageViewFactory
	This factory is aimed at creating stack of ImageViews. More...

class	MultiImageViewProvider
	Utility class to check and convert a View into a MultiImagevView. More...

class	NotImplemented
	'Not implemented' error raised when a 'not available' method is called. More...

class	RandomAccess
	Interface representing a generic array-like accessor. More...

class	RandomAccessFactory
	A factory to create RandomAccess instances from various ressources. More...

class	RandomAccessProvider
	Utility class to check and convert a DataAccess into a RandomAccess. More...

class	Region
	A multi-dimensional region defined by its origin and its size. More...

class	RegionCopier
	This class contains the algorithms used to copy data beetween two regions of N dimensionnal data. More...

class	RegionX
	A Region using dynamic vectors. More...

class	SpatialCalibrationProperty
	This Property is used to represent the image properties in world space. More...

class	SpatialDirections
	Describes a spatial axis system, with direction vectors describing the three axes. More...

class	StreamAccess
	Mother interface for all stream-like data accessors. More...

class	StreamAccessFactory
	A factory to create StreamAccess instances from various ressources. More...

class	StreamAccessProvider
	Utility class to check and convert a DataAccess into a StreamAccess. More...

class	Uri
	Class modeling universal resource identifier. More...

class	VariantDataValue
	Stores metadata heterogeneous type value. More...

class	VariantDataValueConverter
	Converter contains a set of method allowing to interpret a VariantDataValue as a determined type. More...

class	VariantDataValueFactory
	A factory to create VariantDataValue instances from a great variety of types. More...

class	Vector
	An arithmetic vector. More...

class	VectorX
	A dynamically sized arithmetic vector. More...

struct	VersionInfo
	Simple structure to hold version info. More...

class	Versioning
	Versioning tool to check library infos. More...

class	View
	Interface representing a generic view on data. More...

class	Writer
	Interface to use in order to output a view to another medium. More...

Typedefs
using	ArrayXi8 = ArrayX< int8_t >
	Alias for int8_t arrays.

using	ArrayXi16 = ArrayX< int16_t >
	Alias for int16_t arrays.

using	ArrayXi32 = ArrayX< int32_t >
	Alias for int32_t arrays.

using	ArrayXi64 = ArrayX< int64_t >
	Alias for int64_t arrays.

using	ArrayXu8 = ArrayX< uint8_t >
	Alias for uint8_t arrays.

using	ArrayXu16 = ArrayX< uint16_t >
	Alias for uint16_t arrays.

using	ArrayXu32 = ArrayX< uint32_t >
	Alias for uint32_t arrays.

using	ArrayXu64 = ArrayX< uint64_t >
	Alias for uint64_t arrays.

using	ArrayXf = ArrayX< float >
	Alias for float arrays.

using	ArrayXd = ArrayX< double >
	Alias for double arrays.

using	Matrix3f = Matrix< float, 3 >
	Square matrix of size 3, storing float data.

using	Matrix3d = Matrix< double, 3 >
	Square matrix of size 3, storing double data.

using	Matrix4f = Matrix< float, 4 >
	Square matrix of size 4, storing float data.

using	Matrix4d = Matrix< double, 4 >
	Square matrix of size 4, storing double data.

template<typename T >
using	Region2 = Region< T, 2 >

template<typename T >
using	Region3 = Region< T, 3 >

template<typename T >
using	Region4 = Region< T, 4 >

using	Region2u64 = Region2< uint64_t >
	Alias for uint64_t 2D regions.

using	Region3u64 = Region3< uint64_t >
	Alias for uint64_t 3D regions.

using	Region4u64 = Region4< uint64_t >
	Alias for uint64_t 4D regions.

using	RegionXu64 = RegionX< uint64_t >
	Alias for uint64_t variable size regions.

using	RandomAccessCapabilitySet = FlagSet< RandomAccessCapability >
	FlagSet for RandomAccessCapability enum.

using	StreamAccessCapabilitySet = FlagSet< StreamAccessCapability >
	FlagSet for StreamAccessCapability enum.

using	Vector2u8 = Vector< uint8_t, 2 >
	Alias for uint8_t 2D vectors.

using	Vector2u16 = Vector< uint16_t, 2 >
	Alias for uint16_t 2D vectors.

using	Vector2u32 = Vector< uint32_t, 2 >
	Alias for uint32_t 2D vectors.

using	Vector2u64 = Vector< uint64_t, 2 >
	Alias for uint64_t 2D vectors.

using	Vector2i8 = Vector< int8_t, 2 >
	Alias for int8_t 2D vectors.

using	Vector2i16 = Vector< int16_t, 2 >
	Alias for int16_t 2D vectors.

using	Vector2i32 = Vector< int32_t, 2 >
	Alias for int32_t 2D vectors.

using	Vector2i64 = Vector< int64_t, 2 >
	Alias for int64_t 2D vectors.

using	Vector2f = Vector< float, 2 >
	Alias for float 2D vectors.

using	Vector2d = Vector< double, 2 >
	Alias for double 2D vectors.

using	Vector3u8 = Vector< uint8_t, 3 >
	Alias for uint8_t 3D vectors.

using	Vector3u16 = Vector< uint16_t, 3 >
	Alias for uint16_t 3D vectors.

using	Vector3u32 = Vector< uint32_t, 3 >
	Alias for uint32_t 3D vectors.

using	Vector3u64 = Vector< uint64_t, 3 >
	Alias for uint64_t 3D vectors.

using	Vector3i8 = Vector< int8_t, 3 >
	Alias for int8_t 3D vectors.

using	Vector3i16 = Vector< int16_t, 3 >
	Alias for int16_t 3D vectors.

using	Vector3i32 = Vector< int32_t, 3 >
	Alias for int32_t 3D vectors.

using	Vector3i64 = Vector< int64_t, 3 >
	Alias for int64_t 3D vectors.

using	Vector3f = Vector< float, 3 >
	Alias for float 3D vectors.

using	Vector3d = Vector< double, 3 >
	Alias for double 3D vectors.

using	Vector4u8 = Vector< uint8_t, 4 >
	Alias for uint8_t 4D vectors.

using	Vector4u16 = Vector< uint16_t, 4 >
	Alias for uint16_t 4D vectors.

using	Vector4u32 = Vector< uint32_t, 4 >
	Alias for uint32_t 4D vectors.

using	Vector4u64 = Vector< uint64_t, 4 >
	Alias for uint64_t 4D vectors.

using	Vector4i8 = Vector< int8_t, 4 >
	Alias for int8_t 4D vectors.

using	Vector4i16 = Vector< int16_t, 4 >
	Alias for int16_t 4D vectors.

using	Vector4i32 = Vector< int32_t, 4 >
	Alias for int32_t 4D vectors.

using	Vector4i64 = Vector< int64_t, 4 >
	Alias for int64_t 4D vectors.

using	Vector4f = Vector< float, 4 >
	Alias for float 4D vectors.

using	Vector4d = Vector< double, 4 >
	Alias for double 4D vectors.

using	VectorXu8 = VectorX< uint8_t >
	Alias for uint8_t variable size vectors.

using	VectorXu16 = VectorX< uint16_t >
	Alias for uint16_t variable size vectors.

using	VectorXu32 = VectorX< uint32_t >
	Alias for uint32_t variable size vectors.

using	VectorXu64 = VectorX< uint64_t >
	Alias for uint64_t variable size vectors.

using	VectorXi8 = VectorX< int8_t >
	Alias for int8_t variable size vectors.

using	VectorXi16 = VectorX< int16_t >
	Alias for int16_t variable size vectors.

using	VectorXi32 = VectorX< int32_t >
	Alias for int32_t variable size vectors.

using	VectorXi64 = VectorX< int64_t >
	Alias for int64_t variable size vectors.

using	VectorXf = VectorX< float >
	Alias for float variable size vectors.

using	VectorXd = VectorX< double >
	Alias for double variable size vectors.

using	ImageCapabilitySet = FlagSet< ImageCapability >
	FlagSet to handle ImageView capabilities.

using	MultiImageCapabilitySet = FlagSet< MultiImageCapability >
	FlagSet to handle MultiImageView capabilities.

Enumerations
enum	PrimitiveTypeId : uint16_t { PrimitiveTypeId::UNKNOWN = 0x0000, PrimitiveTypeId::UNSIGNED_INTEGER = 0x0001, PrimitiveTypeId::SIGNED_INTEGER = 0x0002, PrimitiveTypeId::FLOATING_POINT = 0x0003, PrimitiveTypeId::UNICODE_STRING = 0x0004 }
	Enum to describe the primitive family of a data type. More...

enum	DataTypeInterpretation : uint32_t { DataTypeInterpretation::RAW = 0, DataTypeInterpretation::COMPLEX, DataTypeInterpretation::SQUARE_MATRIX, DataTypeInterpretation::SYMMETRIC_MATRIX }
	An enumeration to describe how the data should be interpreted. More...

enum	DataTypeId : uint64_t { DataTypeId::UNKNOWN = 0x0000000000000000, DataTypeId::UINT8 = 0x0000000000010108, DataTypeId::UINT16 = 0x0000000000010110, DataTypeId::UINT32 = 0x0000000000010120, DataTypeId::UINT64 = 0x0000000000010140, DataTypeId::INT8 = 0x0000000000020108, DataTypeId::INT16 = 0x0000000000020110, DataTypeId::INT32 = 0x0000000000020120, DataTypeId::INT64 = 0x0000000000020140, DataTypeId::FLOAT = 0x0000000000030120, DataTypeId::DOUBLE = 0x0000000000030140, DataTypeId::UTF8_STRING = 0x0000000000040108, DataTypeId::UTF16_STRING = 0x0000000000040110, DataTypeId::UTF32_STRING = 0x0000000000040120, DataTypeId::VEC2_UINT8 = 0x0000000000010208, DataTypeId::VEC2_UINT16 = 0x0000000000010210, DataTypeId::VEC2_UINT32 = 0x0000000000010220, DataTypeId::VEC2_UINT64 = 0x0000000000010240, DataTypeId::VEC2_INT8 = 0x0000000000020208, DataTypeId::VEC2_INT16 = 0x0000000000020210, DataTypeId::VEC2_INT32 = 0x0000000000020220, DataTypeId::VEC2_INT64 = 0x0000000000020240, DataTypeId::VEC2_FLOAT = 0x0000000000030220, DataTypeId::VEC2_DOUBLE = 0x0000000000030240, DataTypeId::VEC3_UINT8 = 0x0000000000010308, DataTypeId::VEC3_UINT16 = 0x0000000000010310, DataTypeId::VEC3_UINT32 = 0x0000000000010320, DataTypeId::VEC3_UINT64 = 0x0000000000010340, DataTypeId::VEC3_INT8 = 0x0000000000020308, DataTypeId::VEC3_INT16 = 0x0000000000020310, DataTypeId::VEC3_INT32 = 0x0000000000020320, DataTypeId::VEC3_INT64 = 0x0000000000020340, DataTypeId::VEC3_FLOAT = 0x0000000000030320, DataTypeId::VEC3_DOUBLE = 0x0000000000030340, DataTypeId::VEC4_UINT8 = 0x0000000000010408, DataTypeId::VEC4_UINT16 = 0x0000000000010410, DataTypeId::VEC4_UINT32 = 0x0000000000010420, DataTypeId::VEC4_UINT64 = 0x0000000000010440, DataTypeId::VEC4_INT8 = 0x0000000000020408, DataTypeId::VEC4_INT16 = 0x0000000000020410, DataTypeId::VEC4_INT32 = 0x0000000000020420, DataTypeId::VEC4_INT64 = 0x0000000000020440, DataTypeId::VEC4_FLOAT = 0x0000000000030420, DataTypeId::VEC4_DOUBLE = 0x0000000000030440, DataTypeId::COMPLEX_FLOAT = 0x0000000100030220, DataTypeId::COMPLEX_DOUBLE = 0x0000000100030240, DataTypeId::MATRIX2_FLOAT = 0x0000000200030420, DataTypeId::MATRIX2_DOUBLE = 0x0000000200030440, DataTypeId::MATRIX3_FLOAT = 0x0000000200030920, DataTypeId::MATRIX3_DOUBLE = 0x0000000200030940, DataTypeId::MATRIX4_FLOAT = 0x0000000200031020, DataTypeId::MATRIX4_DOUBLE = 0x0000000200031040, DataTypeId::SYM_MATRIX2_FLOAT = 0x0000000300030320, DataTypeId::SYM_MATRIX2_DOUBLE = 0x0000000300030340, DataTypeId::SYM_MATRIX3_FLOAT = 0x0000000300030620, DataTypeId::SYM_MATRIX3_DOUBLE = 0x0000000300030640 }
	A collection of built-in data types. More...

enum	ImageDimension { ImageDimension::COLUMN = 0, ImageDimension::ROW = 1, ImageDimension::SLICE = 2, ImageDimension::CHANNEL = 3, ImageDimension::SEQUENCE = 4 }
	Enum used in ImageType to represent each dimension of an Image. More...

enum	LogLevel { LogLevel::LOG_OFF, LogLevel::LOG_CRITICAL, LogLevel::LOG_ERR, LogLevel::LOG_WARNING, LogLevel::LOG_INFO, LogLevel::LOG_DEBUG, LogLevel::LOG_TRACE }
	The level of logs to display. More...

enum	MemoryLayout { MemoryLayout::UNKNOWN = 0, MemoryLayout::C, MemoryLayout::FORTRAN }
	This enum indicates how a multidimensionnal array is stored in continuous memory. More...

enum	ImageInterpretation { ImageInterpretation::UNKNOWN = 0x00, ImageInterpretation::GRAYSCALE = 0x01, ImageInterpretation::LABEL = 0x02, ImageInterpretation::BINARY = 0x03, ImageInterpretation::CIE_XYZ = 0x11, ImageInterpretation::CIE_XYZ_CHROMATICITY = 0x12, ImageInterpretation::CIE_UVW = 0x14, ImageInterpretation::CIE_LUV = 0x15, ImageInterpretation::CIE_LAB = 0x16, ImageInterpretation::RGB = 0x21, ImageInterpretation::RGB_CHROMATICITY = 0x22, ImageInterpretation::SRGB = 0x23, ImageInterpretation::YUV = 0x31, ImageInterpretation::YCC = 0x32, ImageInterpretation::YIQ = 0x33, ImageInterpretation::YDD = 0x34, ImageInterpretation::HSL = 0x41, ImageInterpretation::HSV = 0x42, ImageInterpretation::CMYK = 0x51, ImageInterpretation::MULTISPECTRAL = 0xFF }
	Interpretation of an Image. More...

enum	AccessCapabilities { READ_ONLY = 0x1, WRITE_ONLY = 0x2, READ_WRITE = 0x3 }
	Used to request capabilities for accessors.

enum	RandomAccessCapability { RandomAccessCapability::READ = 0x1, RandomAccessCapability::WRITE = 0x2, RandomAccessCapability::RESIZE = 0x4, RandomAccessCapability::MEMORY_ACCESS = 0x8, RandomAccessCapability::READ_WRITE = 0x3, RandomAccessCapability::WRITE_RESIZE = 0x6 }
	Capabilities of a RandomAccess. More...

enum	StreamAccessCapability { StreamAccessCapability::READ = 0x1, StreamAccessCapability::WRITE = 0x2, StreamAccessCapability::SEEK = 0x4, StreamAccessCapability::MEMORY_ACCESS = 0x8, StreamAccessCapability::READ_WRITE = 0x3, StreamAccessCapability::READ_SEEK = 0x5, StreamAccessCapability::WRITE_SEEK = 0x6 }
	Capabilities of a StreamAccess. More...

enum	SeekOrigin { SeekOrigin::BEGIN = 1, SeekOrigin::CURRENT = 2, SeekOrigin::END = 3 }
	Position indicator for seek method. More...

enum	ImageCapability { ImageCapability::READ = 0x1, ImageCapability::WRITE = 0x2, ImageCapability::RESHAPE = 0x4, ImageCapability::MEMORY_ACCESS = 0x8, ImageCapability::READ_WRITE = 0x3 }
	Define capabilities of an ImageView. More...

enum	MultiImageCapability { MultiImageCapability::READ = 0x1, MultiImageCapability::WRITE = 0x2, MultiImageCapability::READ_WRITE = 0x3 }
	Define capabilities of an MultiImageView. More...

Functions
std::ostream &	operator<< (std::ostream &os, const DataType datatype)

template<typename T , size_t N>
std::ostream &	operator<< (std::ostream &os, const Matrix< T, N > &m)
	Stream operator to be able to print matrices in standard streams.

template<typename T , size_t N>
std::ostream &	operator<< (std::ostream &os, const Vector< T, N > &v)

template<typename T >
std::ostream &	operator<< (std::ostream &os, const VectorX< T > &v)

Variables
template class IOLINK_API_IMPORT	ArrayX< int8_t >

template class IOLINK_API_IMPORT	ArrayX< int16_t >

template class IOLINK_API_IMPORT	ArrayX< int32_t >

template class IOLINK_API_IMPORT	ArrayX< int64_t >

template class IOLINK_API_IMPORT	ArrayX< uint8_t >

template class IOLINK_API_IMPORT	ArrayX< uint16_t >

template class IOLINK_API_IMPORT	ArrayX< uint32_t >

template class IOLINK_API_IMPORT	ArrayX< uint64_t >

template class IOLINK_API_IMPORT	ArrayX< float >

template class IOLINK_API_IMPORT	ArrayX< double >

template class IOLINK_API_IMPORT	Matrix< float, 3 >

template class IOLINK_API_IMPORT	Matrix< double, 3 >

template class IOLINK_API_IMPORT	Matrix< float, 4 >

template class IOLINK_API_IMPORT	Matrix< double, 4 >

template class IOLINK_API_IMPORT	Region< uint64_t, 2 >

template class IOLINK_API_IMPORT	Region< uint64_t, 3 >

template class IOLINK_API_IMPORT	Region< uint64_t, 4 >

template class IOLINK_API_IMPORT	RegionX< uint64_t >

template class IOLINK_API_IMPORT	FlagSet< RandomAccessCapability >

template class IOLINK_API_IMPORT	FlagSet< StreamAccessCapability >

template class IOLINK_API_IMPORT	Vector< int8_t, 2 >

template class IOLINK_API_IMPORT	Vector< int16_t, 2 >

template class IOLINK_API_IMPORT	Vector< int32_t, 2 >

template class IOLINK_API_IMPORT	Vector< int64_t, 2 >

template class IOLINK_API_IMPORT	Vector< uint8_t, 2 >

template class IOLINK_API_IMPORT	Vector< uint16_t, 2 >

template class IOLINK_API_IMPORT	Vector< uint32_t, 2 >

template class IOLINK_API_IMPORT	Vector< uint64_t, 2 >

template class IOLINK_API_IMPORT	Vector< float, 2 >

template class IOLINK_API_IMPORT	Vector< double, 2 >

template class IOLINK_API_IMPORT	Vector< int8_t, 3 >

template class IOLINK_API_IMPORT	Vector< int16_t, 3 >

template class IOLINK_API_IMPORT	Vector< int32_t, 3 >

template class IOLINK_API_IMPORT	Vector< int64_t, 3 >

template class IOLINK_API_IMPORT	Vector< uint8_t, 3 >

template class IOLINK_API_IMPORT	Vector< uint16_t, 3 >

template class IOLINK_API_IMPORT	Vector< uint32_t, 3 >

template class IOLINK_API_IMPORT	Vector< uint64_t, 3 >

template class IOLINK_API_IMPORT	Vector< float, 3 >

template class IOLINK_API_IMPORT	Vector< double, 3 >

template class IOLINK_API_IMPORT	Vector< int8_t, 4 >

template class IOLINK_API_IMPORT	Vector< int16_t, 4 >

template class IOLINK_API_IMPORT	Vector< int32_t, 4 >

template class IOLINK_API_IMPORT	Vector< int64_t, 4 >

template class IOLINK_API_IMPORT	Vector< uint8_t, 4 >

template class IOLINK_API_IMPORT	Vector< uint16_t, 4 >

template class IOLINK_API_IMPORT	Vector< uint32_t, 4 >

template class IOLINK_API_IMPORT	Vector< uint64_t, 4 >

template class IOLINK_API_IMPORT	Vector< float, 4 >

template class IOLINK_API_IMPORT	Vector< double, 4 >

template class IOLINK_API_IMPORT	VectorX< uint8_t >

template class IOLINK_API_IMPORT	VectorX< int8_t >

template class IOLINK_API_IMPORT	VectorX< uint16_t >

template class IOLINK_API_IMPORT	VectorX< int16_t >

template class IOLINK_API_IMPORT	VectorX< uint32_t >

template class IOLINK_API_IMPORT	VectorX< int32_t >

template class IOLINK_API_IMPORT	VectorX< uint64_t >

template class IOLINK_API_IMPORT	VectorX< int64_t >

template class IOLINK_API_IMPORT	VectorX< float >

template class IOLINK_API_IMPORT	VectorX< double >

template class IOLINK_API_IMPORT	FlagSet< ImageCapability >

template class IOLINK_API_IMPORT	FlagSet< MultiImageCapability >

Detailed Description

All IOLink symbols are enclosed in this namespace.

Enumeration Type Documentation

◆ DataTypeId

enum iolink::DataTypeId : uint64_t

strong

A collection of built-in data types.

Enumerator
UNKNOWN	An opaque type.
UINT8	8 bits unsigned integer
UINT16	16 bits unsigned integer
UINT32	32 bits unsigned integer
UINT64	64 bits unsigned integer
INT8	8 bits signed integer
INT16	16 bits signed integer
INT32	32 bits signed integer
INT64	64 bits signed integer
FLOAT	Single precision floating point.
DOUBLE	Double precision floating point.
UTF8_STRING	Unicode string encoded in UTF-8.
UTF16_STRING	Unicode string encoded in UTF-16.
UTF32_STRING	Unicode string encoded in UTF-32.
VEC2_UINT8	A vector of 2 elements that are 8 bits unsigned integer.
VEC2_UINT16	A vector of 2 elements that are 16 bits unsigned integer.
VEC2_UINT32	A vector of 2 elements that are 32 bits unsigned integer.
VEC2_UINT64	A vector of 2 elements that are 64 bits unsigned integer.
VEC2_INT8	A vector of 2 elements that are 8 bits signed integer.
VEC2_INT16	A vector of 2 elements that are 16 bits signed integer.
VEC2_INT32	A vector of 2 elements that are 32 bits signed integer.
VEC2_INT64	A vector of 2 elements that are 64 bits signed integer.
VEC2_FLOAT	A vector of 2 elements that are single precision floating point.
VEC2_DOUBLE	A vector of 2 elements that are double precision floating point.
VEC3_UINT8	A vector of 2 elements that are 8 bits unsigned integer.
VEC3_UINT16	A vector of 3 elements that are 16 bits unsigned integer.
VEC3_UINT32	A vector of 3 elements that are 32 bits unsigned integer.
VEC3_UINT64	A vector of 3 elements that are 64 bits unsigned integer.
VEC3_INT8	A vector of 3 elements that are 8 bits signed integer.
VEC3_INT16	A vector of 3 elements that are 16 bits signed integer.
VEC3_INT32	A vector of 3 elements that are 32 bits signed integer.
VEC3_INT64	A vector of 3 elements that are 64 bits signed integer.
VEC3_FLOAT	A vector of 3 elements that are single precision floating point.
VEC3_DOUBLE	A vector of 3 elements that are double precision floating point.
VEC4_UINT8	A vector of 4 elements that are 8 bits unsigned integer.
VEC4_UINT16	A vector of 4 elements that are 16 bits unsigned integer.
VEC4_UINT32	A vector of 4 elements that are 32 bits unsigned integer.
VEC4_UINT64	A vector of 4 elements that are 64 bits unsigned integer.
VEC4_INT8	A vector of 4 elements that are 8 bits signed integer.
VEC4_INT16	A vector of 4 elements that are 16 bits signed integer.
VEC4_INT32	A vector of 4 elements that are 32 bits signed integer.
VEC4_INT64	A vector of 4 elements that are 64 bits signed integer.
VEC4_FLOAT	A vector of 4 elements that are single precision floating point.
VEC4_DOUBLE	A vector of 4 elements that are double precision floating point.
COMPLEX_FLOAT	A single precision floating point complex number.
COMPLEX_DOUBLE	A double precision floating point complex number.
MATRIX2_FLOAT	A single precision floating point 2x2 Matrix.
MATRIX2_DOUBLE	A double precision floating point 2x2 Matrix.
MATRIX3_FLOAT	A single precision floating point 3x3 Matrix.
MATRIX3_DOUBLE	A double precision floating point 3x3 Matrix.
MATRIX4_FLOAT	A single precision floating point 4x4 Matrix.
MATRIX4_DOUBLE	A double precision floating point 4x4 Matrix.
SYM_MATRIX2_FLOAT	A single precision floating point 2x2 symmetric Matrix.
SYM_MATRIX2_DOUBLE	A double precision floating point 2x2 symmetric Matrix.
SYM_MATRIX3_FLOAT	A single precision floating point 3x3 symmetric Matrix.
SYM_MATRIX3_DOUBLE	A double precision floating point 3x3 symmetric Matrix.

◆ DataTypeInterpretation

enum iolink::DataTypeInterpretation : uint32_t

strong

An enumeration to describe how the data should be interpreted.

Enumerator
RAW	No particular interpretation, classic vectors and scalars.
COMPLEX	A complex number. A DataType intance with this interpretation should always have a dimension of 2. The first element will be the real part and the second one the imaginary part.
SQUARE_MATRIX	A square matrix. The dimension of DataType instances with this interpretation is the number of element in that matrix. For example, in the case of a square matrix of size 3, its dimension will be 9. Example of layout: \| 0 \| 1 \| 2 \| \| 3 \| 4 \| 5 \| \| 6 \| 7 \| 8 \|
SYMMETRIC_MATRIX	A symmetric matrix. The dimension of DataType instances with this interpretation is the number of element in that matrix. For example, in the case of a symmetric matrix of size 3, its dimension will be 6. Example of layout: \| 0 \| 1 \| 2 \| \| \| 3 \| 4 \| \| \| \| 5 \|

◆ ImageCapability

enum iolink::ImageCapability

strong

Define capabilities of an ImageView.

Enumerator
READ	Data and metadata read capability.
WRITE	Data, metadata, and properties write capability.
RESHAPE	Reshaping capabilities.
MEMORY_ACCESS	Accessing internal memory buffer.
READ_WRITE	Combines READ and WRITE.

◆ ImageDimension

enum iolink::ImageDimension

strong

Enum used in ImageType to represent each dimension of an Image.

Enumerator
COLUMN	represents a image width
ROW	represents a image height
SLICE	represents depth for a volumetric image
CHANNEL	represents channel planes of a multi-spectral image
SEQUENCE	represents the temporality for a sequence of images

◆ ImageInterpretation

enum iolink::ImageInterpretation

strong

Interpretation of an Image.

Enumerator
UNKNOWN	No interpretation at all, only raw data.
GRAYSCALE	A shade of grey, from black to white.
LABEL	Indices corresponding to a label.
BINARY	A boolean.
CIE_XYZ	CIE XYZ color space (CIE 1931)
CIE_XYZ_CHROMATICITY	CIE XYZ color with chromaticity coordinates.
CIE_UVW	CIE UVW* color space (CIE 1964)
CIE_LUV	CIE Luv* color space (CIE 1976)
CIE_LAB	CIE Lab* color space (CIE 1976)
RGB	RGB color (CIE 1931)
RGB_CHROMATICITY	RGB color with chromaticity coordinates.
SRGB	Standard RGB color.
YUV	YUV color.
YCC	YCbCr color (PAL) Alias: YPbPr
YIQ	YIQ color (NTSC)
YDD	YDbDr color (SECAM & PAL-N)
HSL	HSL color (Hue, Saturation, Lightness) Aliases: HLS, HSI
HSV	HSV color (Hue, Saturation, Value) Alias: HSB
CMYK	CMYK color (Cyan, Magenta, Yellow, blacK)
MULTISPECTRAL	Multiple layers of spectral data.

◆ LogLevel

enum iolink::LogLevel

strong

The level of logs to display.

When a level is activated, all levels above will be displayed too.

Example: activating WARNING level will display CRITICAL, ERROR, and WARNING logs.

Enumerator
LOG_OFF	No logging at all.
LOG_CRITICAL	Severe errors that cause premature termination.
LOG_ERR	Runtime errors or unexpected conditions.
LOG_WARNING	Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
LOG_INFO	Interesting runtime events (startup/shutdown).
LOG_DEBUG	Detailed information on the flow through the system.
LOG_TRACE	Only for "tracing" the code and trying to find one part of a function specifically.

◆ MemoryLayout

enum iolink::MemoryLayout

strong

This enum indicates how a multidimensionnal array is stored in continuous memory.

Enumerator

UNKNOWN

Unknown layout.

C

In the C layout the first dimension will have the bigger stride.

It is often called row major.

The dimensions' indices are in reverse order when accessing memory in that layout: array[j][i]

| 11 | 12 | 13 |
| 21 | 22 | 23 |

Would be stored as such: {11, 21, 12, 22, 13, 23}

FORTRAN

In the Fortran layout the first dimension will have the lesser stride.

It is often called column major.

The dimensions' indices are in normal order when accessing memory in that layout: array[i][j]

| 11 | 12 | 13 |
| 21 | 22 | 23 |

Would be stored as such: {11, 12, 13, 21, 22, 23}

◆ MultiImageCapability

enum iolink::MultiImageCapability

strong

Define capabilities of an MultiImageView.

Enumerator
READ	frames access
WRITE	frames addition and modification
READ_WRITE	Combines READ and WRITE.

◆ PrimitiveTypeId

enum iolink::PrimitiveTypeId : uint16_t

strong

Enum to describe the primitive family of a data type.

Some examples:

UINT16, UINT32, and VEC3_UINT8 are all USIGNED_INTEGER
FLOAT and DOUBLE are FLOATING_POINT
UTF8_STRING and UTF16_STRING are UNICODE_STRING

Enumerator
UNKNOWN	An opaque type, that the no one knows about.
UNSIGNED_INTEGER	A classic integer number.
SIGNED_INTEGER	An integer number, using the two complement for negative numbers.
FLOATING_POINT	A floating point number, encoded according to IEEE 754.
UNICODE_STRING	A text string, using the Unicode coding system.

◆ RandomAccessCapability

enum iolink::RandomAccessCapability

strong

Capabilities of a RandomAccess.

Enumerator
READ	Data can be read.
WRITE	Data can be written.
RESIZE	Data can be resized.
MEMORY_ACCESS	Accessing internal memory buffer.
READ_WRITE	combination of READ and WRITE
WRITE_RESIZE	combination of WRITE and RESIZE

◆ SeekOrigin

enum iolink::SeekOrigin

strong

Position indicator for seek method.

Enumerator
BEGIN	Begining of the stream.
CURRENT	Current position of the stream.
END	End of the stream.

◆ StreamAccessCapability

enum iolink::StreamAccessCapability

strong

Capabilities of a StreamAccess.

Enumerator
READ	Data can be read.
WRITE	Data can be written.
SEEK	Cursor for read/write can be moved.
MEMORY_ACCESS	Accessing internal memory buffer.
READ_WRITE	combination of READ and WRITE
READ_SEEK	combination of READ and SEEK
WRITE_SEEK	combination of WRITE and SEEK

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ DataTypeId

◆ DataTypeInterpretation

◆ ImageCapability

◆ ImageDimension

◆ ImageInterpretation

◆ LogLevel

◆ MemoryLayout

◆ MultiImageCapability

◆ PrimitiveTypeId

◆ RandomAccessCapability

◆ SeekOrigin

◆ StreamAccessCapability