PCL
Public Member Functions | List of all members
pcl::ImageResolution Class Reference

Image resolution data More...

#include <ImageResolution.h>

+ Inheritance diagram for pcl::ImageResolution:

Public Member Functions

 ImageResolution ()=default
 
 ImageResolution (const ImageResolution &)=default
 
void GetResolution (double &x, double &y)
 
double HorizontalResolution () const
 
bool IsMetricResolution () const
 
ImageResolution & operator= (const ImageResolution &)=default
 
double Resolution () const
 
void SetMetricResolution (bool m)
 
void SetResolution (double r)
 
void SetResolution (double x, double y)
 
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 ( )
default

Constructs a default ImageResolution object.

◆ ImageResolution() [2/2]

pcl::ImageResolution::ImageResolution ( const ImageResolution &  )
default

Copy constructor.

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 96 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 106 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 167 of file ImageResolution.h.

◆ operator=()

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

Assignment operator. Returns a reference to this object.

◆ 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 142 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 180 of file ImageResolution.h.

◆ SetResolution() [1/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 155 of file ImageResolution.h.

References pcl::Max().

◆ SetResolution() [2/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 127 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 116 of file ImageResolution.h.

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