PCL
pcl::ImageOptions Class Reference

Format-independent, fundamental image stream options. More...

#include <ImageOptions.h>

Public Member Functions

 ImageOptions ()
 
 ImageOptions (const ImageOptions &)=default
 
ImageOptionsoperator= (const ImageOptions &)=default
 
void Reset ()
 

Public Attributes

float aperture
 Focal length divided by lens diameter (F/D) (0=unknown)
 
uint8 bitsPerSample: 8
 Number of bits per sample: 8, 16, 32 or 64. The default value is 16.
 
int cfaType
 Color Filter Array type. See CFAType namespace for possible values (0=none).
 
bool complexSample: 1
 Sample type: Complex (true) or real (false) samples. The default value is false.
 
bool embedColorFilterArray: 1
 Embed color filter array (CFA) description. The default value is true.
 
bool embedDisplayFunction: 1
 Embed display function (aka STF) parameters. The default value is true.
 
bool embedICCProfile: 1
 Embed an ICC profile (when available). The default value is true.
 
bool embedPreviewRects: 1
 Embed existing preview rectangles and their identifiers. The default value is false.
 
bool embedProcessingHistory: 1
 Embed existing processing history as an XML document. The default value is false.
 
bool embedProperties: 1
 Embed data properties (when available). The default value is true.
 
bool embedRGBWS: 1
 Embed RGB working space parameters. The default value is true.
 
bool embedThumbnail: 1
 Embed thumbnail images (when available). The default value is false.
 
float exposure
 Exposure in seconds (0=unknown)
 
float focalLength
 Focal length in millimeters (0=unknown)
 
bool ieeefpSampleFormat: 1
 Sample type: IEEE 754 floating point (true) or integers (false). The default value is false.
 
int isoSpeed
 ISO speed as specified in ISO 12232 (0=unknown)
 
double lowerRange
 Lower limit to normalize read floating-point samples. The default value is 0.
 
bool metricResolution: 1
 Resolution units: centimeter (true) or inch (false). The default value is false.
 
bool readNormalized: 1
 Normalize floating-point sample values after reading. The default value is true.
 
bool signedIntegers: 1
 Integer sample values are signed (true) or unsigned (false). The default value is false.
 
double upperRange
 Upper limit to normalize read floating-point samples. The default value is 1.
 
double xResolution
 Horizontal resolution in pixels per resolution unit (0=unknown). The default value is 72.
 
double yResolution
 Vertical resolution in pixels per resolution unit (0=unknown). The default value is 72.
 

Detailed Description

Definition at line 97 of file ImageOptions.h.

Constructor & Destructor Documentation

◆ ImageOptions() [1/2]

pcl::ImageOptions::ImageOptions ( )
inline

Constructs an ImageOptions structure with default values.

Definition at line 132 of file ImageOptions.h.

◆ ImageOptions() [2/2]

pcl::ImageOptions::ImageOptions ( const ImageOptions )
default

Copy constructor.

Member Function Documentation

◆ operator=()

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

Copy assignment operator. Returns a reference to this object.

◆ Reset()

void pcl::ImageOptions::Reset ( )
inline

Initializes all data members to default values.

Definition at line 150 of file ImageOptions.h.


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