PCL
pcl::ImageDescription Class Reference

A structure to transport basic information and options for an image stored in an image file. More...

#include <ImageDescription.h>

Public Member Functions

 ImageDescription ()=default
 
 ImageDescription (const ImageDescription &)=default
 
 ImageDescription (const ImageInfo &i)
 
 ImageDescription (const ImageInfo &i, const ImageOptions &o, const IsoString &s=IsoString())
 
ImageDescriptionoperator= (const ImageDescription &)=default
 

Public Attributes

IsoString id
 Identifier of this image. Usually a running counter starting from zero.
 
ImageInfo info
 Basic image information: dimensions and color space.
 
ImageOptions options
 Format-independent image file options.
 

Detailed Description

This structure is used (instantiated in ImageDescriptionArray containers) by the FileFormatImplementation and FileFormaInstance classes to describe individual images stored in image files.

See also
ImageInfo, ImageOptions, FileFormatImplementation, FileFormatInstance

Definition at line 79 of file ImageDescription.h.

Constructor & Destructor Documentation

◆ ImageDescription() [1/4]

pcl::ImageDescription::ImageDescription ( )
default

Default constructor.

◆ ImageDescription() [2/4]

pcl::ImageDescription::ImageDescription ( const ImageInfo i,
const ImageOptions o,
const IsoString s = IsoString() 
)
inline

Constructs an ImageDescription object from the specified ImageInfo, ImageOptions and image identifier.

Definition at line 94 of file ImageDescription.h.

◆ ImageDescription() [3/4]

pcl::ImageDescription::ImageDescription ( const ImageInfo i)
inline

Constructs an ImageDescription object from the specified ImageInfo structure with default format-independent options and an empty image identifier.

Definition at line 109 of file ImageDescription.h.

◆ ImageDescription() [4/4]

pcl::ImageDescription::ImageDescription ( const ImageDescription )
default

Copy constructor.

Member Function Documentation

◆ operator=()

ImageDescription& pcl::ImageDescription::operator= ( const ImageDescription )
default

Cop assignment operator. Returns a reference to this object.


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