aimsalgo 6.0.0
Neuroimaging image processing
Protected Attributes | List of all members
aims::ConvolutionSubSampler< BasisFunction > Class Template Reference

Convolution Filter. More...

#include <aims/pyramid/convolutionsubsampler.h>

Inheritance diagram for aims::ConvolutionSubSampler< BasisFunction >:
Inheritance graph
[legend]
Collaboration diagram for aims::ConvolutionSubSampler< BasisFunction >:
Collaboration graph
[legend]

Public Member Functions

 ConvolutionSubSampler (unsigned r=2)
 Constructor / Destructor / Copy.
 
 ConvolutionSubSampler (const Point4du &r)
 
 ConvolutionSubSampler (const BasisFunction &bfunc, unsigned r)
 
 ConvolutionSubSampler (const std::vector< BasisFunction > &bfunc=std::vector< BasisFunction >(), const Point4du &r=Point4du(2, 2, 2, 2))
 
 ConvolutionSubSampler (const ConvolutionSubSampler &other)
 
virtual ~ConvolutionSubSampler ()
 
ConvolutionSubSampler & operator= (const ConvolutionSubSampler &other)
 
template<typename OUT, typename IN>
carto::VolumeRef< OUT > execute (const carto::VolumeRef< IN > &in) const
 Execution.
 
template<typename OUT, typename IN>
carto::VolumeRef< OUT > execute (const carto::VolumeRef< IN > &in, carto::VolumeRef< OUT > &out) const
 Write result in an existing volume.
 
const std::vector< bool > & directions () const
 Parameters.
 
const Point4du & factor () const
 
void setBasisFunction (const BasisFunction &func)
 
void setBasisFunction (const std::vector< BasisFunction > &func)
 
void setFactor (unsigned r)
 
void setFactor (const Point4du &r)
 
void setDirections (const std::vector< bool > &dir)
 
void setDirections (bool dirx, bool diry, bool dirz, bool dirt)
 
void setVerbose (int verbose=1)
 
void setQuiet ()
 

Protected Attributes

std::vector< BasisFunction > _func
 
int _verbose
 
std::vector< bool > _dir
 
Point4du _factor
 

Detailed Description

template<typename BasisFunction>
class aims::ConvolutionSubSampler< BasisFunction >

Convolution Filter.

Interpolate a discrete signal with a separable kernel of finite support. The basis function must possess:

  • U operator() ( T )
  • V support() with V[0] and v[1]

Definition at line 53 of file convolutionsubsampler.h.

Constructor & Destructor Documentation

◆ ConvolutionSubSampler() [1/5]

template<typename F>
aims::ConvolutionSubSampler< F >::ConvolutionSubSampler ( unsigned r = 2)

Constructor / Destructor / Copy.

Definition at line 48 of file convolutionsubsampler_d.h.

References _dir, _factor, and _verbose.

Referenced by ConvolutionSubSampler(), and operator=().

◆ ConvolutionSubSampler() [2/5]

template<typename F>
aims::ConvolutionSubSampler< F >::ConvolutionSubSampler ( const Point4du & r)

Definition at line 57 of file convolutionsubsampler_d.h.

References _dir, and _verbose.

◆ ConvolutionSubSampler() [3/5]

template<typename BasisFunction>
aims::ConvolutionSubSampler< BasisFunction >::ConvolutionSubSampler ( const BasisFunction & bfunc,
unsigned r )

◆ ConvolutionSubSampler() [4/5]

template<typename BasisFunction>
aims::ConvolutionSubSampler< BasisFunction >::ConvolutionSubSampler ( const std::vector< BasisFunction > & bfunc = std::vector< BasisFunction >(),
const Point4du & r = Point4du(2, 2, 2, 2) )

◆ ConvolutionSubSampler() [5/5]

template<typename BasisFunction>
aims::ConvolutionSubSampler< BasisFunction >::ConvolutionSubSampler ( const ConvolutionSubSampler< BasisFunction > & other)

References ConvolutionSubSampler().

◆ ~ConvolutionSubSampler()

template<typename F>
aims::ConvolutionSubSampler< F >::~ConvolutionSubSampler ( )
virtual

Definition at line 94 of file convolutionsubsampler_d.h.

Member Function Documentation

◆ directions()

template<typename F>
const std::vector< bool > & aims::ConvolutionSubSampler< F >::directions ( ) const

Parameters.

Definition at line 272 of file convolutionsubsampler_d.h.

References _dir.

◆ execute() [1/2]

template<typename F>
template<typename OUT, typename IN>
carto::VolumeRef< OUT > aims::ConvolutionSubSampler< F >::execute ( const carto::VolumeRef< IN > & in) const

Execution.

Function-like operator that filters a given volume

Note
1 copy
Warning
This call risks causing additional precision errors

Definition at line 159 of file convolutionsubsampler_d.h.

References _dir, _factor, carto::VolumeRef< typename T >::copyHeaderFrom(), execute(), carto::PropertySet::getProperty(), carto::VolumeRef< typename T >::getSizeT(), carto::VolumeRef< typename T >::getSizeX(), carto::VolumeRef< typename T >::getSizeY(), carto::VolumeRef< typename T >::getSizeZ(), carto::VolumeRef< typename T >::header(), and carto::PropertySet::setProperty().

Referenced by execute(), aims::DirectBSplineSubSampler::execute(), and aims::SplinePyramidBuilder::execute().

◆ execute() [2/2]

template<typename F>
template<typename OUT, typename IN>
carto::VolumeRef< OUT > aims::ConvolutionSubSampler< F >::execute ( const carto::VolumeRef< IN > & in,
carto::VolumeRef< OUT > & out ) const

Write result in an existing volume.

If the allocated size differs from the needed resulting size, the volume is reallocated.

Note
1 copy
Warning
This call risks causing additional precision errors

Definition at line 189 of file convolutionsubsampler_d.h.

References _dir, _factor, _func, _verbose, aims::convolutionsubsampler::at(), carto::VolumeRef< typename T >::getBorders(), carto::VolumeRef< typename T >::getSize(), carto::VolumeRef< typename T >::getSizeT(), carto::VolumeRef< typename T >::getSizeX(), carto::VolumeRef< typename T >::getSizeY(), carto::VolumeRef< typename T >::getSizeZ(), aims::ProgressInfo< class T1, class T2 >::print(), and carto::toString().

◆ factor()

template<typename F>
const Point4du & aims::ConvolutionSubSampler< F >::factor ( ) const

Definition at line 278 of file convolutionsubsampler_d.h.

References _factor.

◆ operator=()

template<typename BasisFunction>
ConvolutionSubSampler< F > & aims::ConvolutionSubSampler< F >::operator= ( const ConvolutionSubSampler< BasisFunction > & other)

Definition at line 98 of file convolutionsubsampler_d.h.

References ConvolutionSubSampler().

Referenced by aims::DirectBSplineSubSampler::operator=().

◆ setBasisFunction() [1/2]

template<typename BasisFunction>
void aims::ConvolutionSubSampler< BasisFunction >::setBasisFunction ( const BasisFunction & func)

Referenced by aims::DirectBSplineSubSampler::setFunctions().

◆ setBasisFunction() [2/2]

template<typename BasisFunction>
void aims::ConvolutionSubSampler< BasisFunction >::setBasisFunction ( const std::vector< BasisFunction > & func)

◆ setDirections() [1/2]

template<typename F>
void aims::ConvolutionSubSampler< F >::setDirections ( bool dirx,
bool diry,
bool dirz,
bool dirt )

Definition at line 317 of file convolutionsubsampler_d.h.

References _dir.

◆ setDirections() [2/2]

template<typename F>
void aims::ConvolutionSubSampler< F >::setDirections ( const std::vector< bool > & dir)

Definition at line 308 of file convolutionsubsampler_d.h.

References _dir.

Referenced by aims::SplinePyramidBuilder::execute().

◆ setFactor() [1/2]

template<typename F>
void aims::ConvolutionSubSampler< F >::setFactor ( const Point4du & r)

Definition at line 302 of file convolutionsubsampler_d.h.

References _factor.

◆ setFactor() [2/2]

template<typename F>
void aims::ConvolutionSubSampler< F >::setFactor ( unsigned r)

Definition at line 296 of file convolutionsubsampler_d.h.

References _factor.

Referenced by aims::DirectBSplineSubSampler::setFactor(), and aims::DirectBSplineSubSampler::setFactor().

◆ setQuiet()

template<typename F>
void aims::ConvolutionSubSampler< F >::setQuiet ( )

Definition at line 332 of file convolutionsubsampler_d.h.

References _verbose.

◆ setVerbose()

template<typename F>
void aims::ConvolutionSubSampler< F >::setVerbose ( int verbose = 1)

Definition at line 326 of file convolutionsubsampler_d.h.

References _verbose.

Referenced by aims::SplinePyramidBuilder::execute().

Member Data Documentation

◆ _dir

template<typename BasisFunction>
std::vector<bool> aims::ConvolutionSubSampler< BasisFunction >::_dir
protected

Definition at line 108 of file convolutionsubsampler.h.

Referenced by ConvolutionSubSampler(), ConvolutionSubSampler(), directions(), execute(), execute(), setDirections(), and setDirections().

◆ _factor

template<typename BasisFunction>
Point4du aims::ConvolutionSubSampler< BasisFunction >::_factor
protected

Definition at line 109 of file convolutionsubsampler.h.

Referenced by ConvolutionSubSampler(), execute(), execute(), factor(), setFactor(), and setFactor().

◆ _func

template<typename BasisFunction>
std::vector<BasisFunction> aims::ConvolutionSubSampler< BasisFunction >::_func
protected

Definition at line 106 of file convolutionsubsampler.h.

Referenced by execute().

◆ _verbose

template<typename BasisFunction>
int aims::ConvolutionSubSampler< BasisFunction >::_verbose
protected

Definition at line 107 of file convolutionsubsampler.h.

Referenced by ConvolutionSubSampler(), ConvolutionSubSampler(), execute(), setQuiet(), and setVerbose().

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