iRoCS Toolbox  1.1.0
Static Public Member Functions
atb::InterpolatorFactory< DataT, Dim > Class Template Reference

The InterpolatorFactory class contains a factory method for creating a new Interpolator object using the given InterpolationType and BoundaryTreatmentType with corresponding default boundary value. More...

#include "libArrayToolbox/Interpolator.hh"

Collaboration diagram for atb::InterpolatorFactory< DataT, Dim >:

Static Public Member Functions

static Interpolator< DataT, Dim > * get (InterpolationType ipType, BoundaryTreatmentType btType=ValueBT, DataT const &boundaryValue=traits< DataT >::zero)
 Get e new Interpolator object corresponding to the given InterpolationType enumeration value with specified boundary treatment. More...
 

Detailed Description

template<typename DataT, int Dim>
class atb::InterpolatorFactory< DataT, Dim >

The InterpolatorFactory class contains a factory method for creating a new Interpolator object using the given InterpolationType and BoundaryTreatmentType with corresponding default boundary value.

Definition at line 778 of file Interpolator.hh.

Member Function Documentation

◆ get()

template<typename DataT , int Dim>
static Interpolator<DataT,Dim>* atb::InterpolatorFactory< DataT, Dim >::get ( InterpolationType  ipType,
BoundaryTreatmentType  btType = ValueBT,
DataT const &  boundaryValue = traits< DataT >::zero 
)
static

Get e new Interpolator object corresponding to the given InterpolationType enumeration value with specified boundary treatment.

Ownership of the returned pointer is passed to the caller, who then is responsible for cleaning up the object using delete when the Interpolator object is not needed any more.

Parameters
ipTypeThe type of the interpolator
btTypeThe type of the boundary treatment
boundaryValueIf btType == Value this value is returned when trying to access out-of-Array positions
Returns
A pointer to e newly created Interpolator object
Exceptions
RuntimeErrorIf no Interpolator object could be created this exception is thrown

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