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

The BoundaryTreatmentFactory class contains a factory method for creating a BoundaryTreatment object from the given BoundaryTreatment enumeration value. More...

#include "libArrayToolbox/BoundaryTreatment.hh"

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

Static Public Member Functions

static BoundaryTreatment< DataT, Dim > * get (BoundaryTreatmentType type, DataT const &value=traits< DataT >::zero)
 Get a new BoundaryTreatment object corresponding to the given enumeration value. More...
 

Detailed Description

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

The BoundaryTreatmentFactory class contains a factory method for creating a BoundaryTreatment object from the given BoundaryTreatment enumeration value.

Definition at line 1012 of file BoundaryTreatment.hh.

Member Function Documentation

◆ get()

template<typename DataT , int Dim>
static BoundaryTreatment<DataT,Dim>* atb::BoundaryTreatmentFactory< DataT, Dim >::get ( BoundaryTreatmentType  type,
DataT const &  value = traits< DataT >::zero 
)
static

Get a new BoundaryTreatment object corresponding to the given enumeration value.

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

Parameters
typeThe boundary treatment type
valueThe default value of out-of-Array pixels for the ValueBoundaryTreatment class. For all other boundary treatment strategies this parameter is ignored.
Returns
A pointer to a newly created BoundaryTreatment object
Exceptions
RuntimeErrorIf no boundary treatment object could be created this exception is thrown

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