IOLink  IOL_v1.2.0_release
iolink::ImageProperties Class Reference

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

#include <iolink/property/ImageProperties.h>

Public Member Functions

 ImageProperties (const SpatialCalibrationProperty &calibration, const ImageInfoProperty &imageInfo)
 Build a ImageProperties by directly specifying SpatialCalibration and imageInfo properties. More...
 
 ImageProperties (const ImageProperties &other)
 
ImagePropertiesoperator= (const ImageProperties &other)
 
 ImageProperties (ImageProperties &&other) noexcept
 
ImagePropertiesoperator= (ImageProperties &&other) noexcept
 
std::string toString () const
 Return string representation.
 
std::shared_ptr< ImagePropertiesclone () const
 Create a copy of the properties instance.
 
const SpatialCalibrationPropertycalibration () const
 Return the calibration associated with these properties. More...
 
const ImageInfoPropertyimageInfo () const
 Return the image information associated with these properties. More...
 
SpatialCalibrationPropertycalibration ()
 Return the calibration associated with these properties.
 
ImageInfoPropertyimageInfo ()
 Return the image information associated with these properties.
 
bool isCompatibleWith (const VectorXu64 &shape, DataType type) const
 Check if the current properties are compatible with given shape and type. More...
 
bool operator== (const ImageProperties &other) const
 Equality operator.
 

Static Public Member Functions

static std::shared_ptr< ImagePropertiesfromDataType (DataType dataType)
 Create a property set with all values defaulted, according to a data type.
 
static std::shared_ptr< ImagePropertiesfromProperties (const SpatialCalibrationProperty &calibration, const ImageInfoProperty &imageInfo)
 Build a ImageProperties from a set of properties. More...
 
static std::shared_ptr< ImagePropertiesfromProperties (std::shared_ptr< const ImageProperties > properties, const SpatialCalibrationProperty &calibration)
 Build a ImageProperties by copying properties from another, except the calibration.
 
static std::shared_ptr< ImagePropertiesfromProperties (std::shared_ptr< const ImageProperties > properties, const ImageInfoProperty &imageInfo)
 Build a ImageProperties by copying properties from another, except the Image info.
 

Detailed Description

Hold additionnal info for ImageView data interpretation.

Constructor & Destructor Documentation

◆ ImageProperties()

iolink::ImageProperties::ImageProperties ( const SpatialCalibrationProperty calibration,
const ImageInfoProperty imageInfo 
)

Build a ImageProperties by directly specifying SpatialCalibration and imageInfo properties.

Parameters
calibrationSpatialCalibrationProperty to use to initialize ImageProperties
imageInfoImageInfoProperty to use to initialize ImageProperties

Member Function Documentation

◆ calibration()

const SpatialCalibrationProperty& iolink::ImageProperties::calibration ( ) const

Return the calibration associated with these properties.

This constant variation is provided in order to be called on constant properties.

◆ fromProperties()

static std::shared_ptr<ImageProperties> iolink::ImageProperties::fromProperties ( const SpatialCalibrationProperty calibration,
const ImageInfoProperty imageInfo 
)
static

Build a ImageProperties from a set of properties.

Shortcut for:

std::make_shared<ImageProperties>(calibration, imageInfo )

◆ imageInfo()

const ImageInfoProperty& iolink::ImageProperties::imageInfo ( ) const

Return the image information associated with these properties.

This constant variation is provided in order to be called on constant properties.

◆ isCompatibleWith()

bool iolink::ImageProperties::isCompatibleWith ( const VectorXu64 shape,
DataType  type 
) const

Check if the current properties are compatible with given shape and type.

Parameters
shapeshape of an ImageView
typetype of an ImageView
Returns
TRUE if shape and type are compatible with ImageView

The documentation for this class was generated from the following file: