IOLink
IOL_v1.2.0_release
|
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 | ExtensionProvider |
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 | Serialization |
Serialization class which provides methods to serialize and unserialize most of IOLink objects. 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 | TilingInfoExtension |
ImageView extension to describe how an image is tiled. 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. | |
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) |
All IOLink symbols are enclosed in this namespace.
|
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. |
|
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 | |
|
strong |
Define capabilities of an ImageView.
|
strong |
Enum used in ImageType to represent each dimension of an Image.
|
strong |
Interpretation of an Image.
|
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.
|
strong |
This enum indicates how a multidimensionnal array is stored in continuous memory.
|
strong |
Define capabilities of an MultiImageView.
Enumerator | |
---|---|
READ | frames access |
WRITE | frames addition and modification |
READ_WRITE | Combines READ and WRITE. |
|
strong |
Enum to describe the primitive family of a data type.
Some examples:
|
strong |
Capabilities of a RandomAccess.
|
strong |
|
strong |
Capabilities of a StreamAccess.