PCL
pcl::ImageResolution Class Reference

Image resolution data More...

#include <ImageResolution.h>

+ Inheritance diagram for pcl::ImageResolution:

Public Member Functions

 ImageResolution ()
 
 ImageResolution (const ImageResolution &x)
 
void GetResolution (double &x, double &y)
 
double HorizontalResolution () const
 
bool IsMetricResolution () const
 
ImageResolutionoperator= (const ImageResolution &x)
 
double Resolution () const
 
void SetMetricResolution (bool m)
 
void SetResolution (double x, double y)
 
void SetResolution (double r)
 
double VerticalResolution () const
 

Detailed Description

TODO: Write a detailed description for ImageResolution.

Definition at line 71 of file ImageResolution.h.

Constructor & Destructor Documentation

◆ ImageResolution() [1/2]

pcl::ImageResolution::ImageResolution ( )
inline

Constructs a default ImageResolution object.

Definition at line 78 of file ImageResolution.h.

◆ ImageResolution() [2/2]

pcl::ImageResolution::ImageResolution ( const ImageResolution x)
inline

Copy constructor.

Definition at line 85 of file ImageResolution.h.

Member Function Documentation

◆ GetResolution()

void pcl::ImageResolution::GetResolution ( double &  x,
double &  y 
)
inline

Gets resolution values for both x and y axes in pixels per resolution unit.

See also
HorizontalResolution(), VerticalResolution()

Definition at line 107 of file ImageResolution.h.

◆ HorizontalResolution()

double pcl::ImageResolution::HorizontalResolution ( ) const
inline

Returns the horizontal (X-axis) resolution in pixels per resolution unit.

See also
VerticalResolution(), GetResolution()

Definition at line 117 of file ImageResolution.h.

◆ IsMetricResolution()

bool pcl::ImageResolution::IsMetricResolution ( ) const
inline

Returns true iff this object express resolution in pixels per centimeter; false if it express resolution in pixels per inch.

See also
SetMetricResolution()

Definition at line 178 of file ImageResolution.h.

◆ operator=()

ImageResolution& pcl::ImageResolution::operator= ( const ImageResolution x)
inline

Assignment operator. Returns a reference to this object.

Definition at line 93 of file ImageResolution.h.

◆ Resolution()

double pcl::ImageResolution::Resolution ( ) const
inline

Returns the resolution for both axes, in pixels per resolution unit.

This member function is more meaningful for contexts where separate horizontal and vertical resolutions are not supported.

See also
GetResolution(), SetResolution( double ), SetResolution( double, double )

Definition at line 153 of file ImageResolution.h.

◆ SetMetricResolution()

void pcl::ImageResolution::SetMetricResolution ( bool  m)
inline

Sets the resolution unit for this ImageResolution object.

Parameters
mIf true, enables resolution in pixels per centimeter (metric resolution). If false, enables resolution in pixels per inch.
See also
IsMetricResolution()

Definition at line 191 of file ImageResolution.h.

◆ SetResolution() [1/2]

void pcl::ImageResolution::SetResolution ( double  x,
double  y 
)
inline

Sets resolution values for both x and y axes in pixels per resolution unit.

See also
GetResolution(), SetResolution( double )

Definition at line 138 of file ImageResolution.h.

References pcl::Max().

◆ SetResolution() [2/2]

void pcl::ImageResolution::SetResolution ( double  r)
inline

Sets the resolution for both axes, in pixels per resolution unit.

This member function is more meaningful for contexts where separate horizontal and vertical resolutions are not supported.

See also
Resolution(), HorizontalResolution(), VerticalResolution(), GetResolution()

Definition at line 166 of file ImageResolution.h.

References pcl::Max().

◆ VerticalResolution()

double pcl::ImageResolution::VerticalResolution ( ) const
inline

Returns the vertical (Y-axis) resolution in pixels per resolution unit.

See also
HorizontalResolution(), GetResolution()

Definition at line 127 of file ImageResolution.h.


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