PCL
pcl::PixelInterpolation Class Referenceabstract

Abstract root base class for all pixel interpolation algorithms. More...

#include <PixelInterpolation.h>

+ Inheritance diagram for pcl::PixelInterpolation:

Classes

class  Interpolator
 Generic two-dimensional pixel interpolator. More...
 

Public Member Functions

 PixelInterpolation ()=default
 
 PixelInterpolation (const PixelInterpolation &)=default
 
virtual ~PixelInterpolation ()
 
virtual String Description () const =0
 
virtual bool IsThreadSafe () const
 
template<class P , class T >
Interpolator< P > * NewInterpolator (const T *data, int width, int height, bool unclipped=false) const
 

Detailed Description

PixelInterpolation is the abstract base class of all pixel interpolation PCL classes. A pixel interpolation class is able to generate pixel interpolators (instances of PixelInterpolation::Interpolator), which are generic objects providing a common pixel interpolation interface that is independent on a particular interpolation algorithm.

See also
NearestNeighborPixelInterpolation, BilinearPixelInterpolation, BicubicSplinePixelInterpolation, BicubicBSplinePixelInterpolation, BicubicFilterPixelInterpolation, LanczosPixelInterpolation, Lanczos3LUTPixelInterpolation, Lanczos4LUTPixelInterpolation, Lanczos5LUTPixelInterpolation

Definition at line 97 of file PixelInterpolation.h.

Constructor & Destructor Documentation

◆ PixelInterpolation() [1/2]

pcl::PixelInterpolation::PixelInterpolation ( )
default

Constructs a PixelInterpolation object.

◆ PixelInterpolation() [2/2]

pcl::PixelInterpolation::PixelInterpolation ( const PixelInterpolation )
default

Copy constructor.

◆ ~PixelInterpolation()

virtual pcl::PixelInterpolation::~PixelInterpolation ( )
inlinevirtual

Destroys a PixelInterpolation object.

Definition at line 250 of file PixelInterpolation.h.

Member Function Documentation

◆ Description()

◆ IsThreadSafe()

virtual bool pcl::PixelInterpolation::IsThreadSafe ( ) const
inlinevirtual

Returns true iff this interpolation can be safely used in multithreaded contexts.

A thread-safe interpolator can be used concurrently by multiple threads without needing to lock the interpolated data.

Note
The default implementation returns true, so pixel interpolations are considered thread-safe by default.

Definition at line 269 of file PixelInterpolation.h.

◆ NewInterpolator()

template<class P , class T >
Interpolator<P>* pcl::PixelInterpolation::NewInterpolator ( const T *  data,
int  width,
int  height,
bool  unclipped = false 
) const
inline

Creates a new Interpolator object specialized for a pixel sample type P.

Parameters
dataTwo-dimensional matrix of pixel sample values that will be interpolated.
widthHorizontal dimension (most rapidly varying matrix subscript) of the source data matrix.
heightVertical dimension (most slowly varying matrix subscript) of the source data matrix.

Definition at line 287 of file PixelInterpolation.h.


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