aimsalgo 6.0.0
Neuroimaging image processing
aims::MovingAverageCascadeKernel Class Reference

1D Cascade of Moving Average Kernel More...

#include <aims/signalfilter/movingaveragefilter.h>

Collaboration diagram for aims::MovingAverageCascadeKernel:

Public Member Functions

 MovingAverageCascadeKernel (unsigned length=3, unsigned n=2, FilterType::Direction symtype=FilterType::Symmetrical)
 Constructor/Destructor/Copy.
 
 MovingAverageCascadeKernel (const MovingAverageCascadeKernel &other)
 
virtual ~MovingAverageCascadeKernel ()
 
MovingAverageCascadeKerneloperator= (const MovingAverageCascadeKernel &other)
 
double operator() (int x) const
 Get value.
 
double at (int x) const
 
const Point2disupport () const
 
void reset (unsigned length=3, unsigned n=2, FilterType::Direction symtype=FilterType::Symmetrical)
 Set parameters.
 
void setLength (unsigned length)
 
void setCascade (unsigned n)
 
void setType (FilterType::Direction symtype)
 
unsigned length () const
 Get parameters.
 
unsigned cascade () const
 
FilterType::Direction type () const
 

Protected Member Functions

void setValues (unsigned length, unsigned n, FilterType::Direction symtype)
 

Protected Attributes

unsigned _n
 
Point2di _support
 
std::vector< double > _values
 

Detailed Description

1D Cascade of Moving Average Kernel

This kernel can be used as basis function in ConvolutionFilter and ConvolutionSubSampler classes.

It is equivalent to a convolution of n Moving Average

The symmetrical version needs n * (length - 1) to be even.

Definition at line 136 of file movingaveragefilter.h.

Constructor & Destructor Documentation

◆ MovingAverageCascadeKernel() [1/2]

aims::MovingAverageCascadeKernel::MovingAverageCascadeKernel ( unsigned length = 3,
unsigned n = 2,
FilterType::Direction symtype = FilterType::Symmetrical )

Constructor/Destructor/Copy.

If symtype == Symmetrical, n * (length - 1) should be even.

References length(), and aims::FilterType::Symmetrical.

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

◆ MovingAverageCascadeKernel() [2/2]

aims::MovingAverageCascadeKernel::MovingAverageCascadeKernel ( const MovingAverageCascadeKernel & other)

◆ ~MovingAverageCascadeKernel()

virtual aims::MovingAverageCascadeKernel::~MovingAverageCascadeKernel ( )
virtual

Member Function Documentation

◆ at()

double aims::MovingAverageCascadeKernel::at ( int x) const

◆ cascade()

unsigned aims::MovingAverageCascadeKernel::cascade ( ) const

◆ length()

unsigned aims::MovingAverageCascadeKernel::length ( ) const

Get parameters.

Referenced by MovingAverageCascadeKernel(), reset(), setLength(), and setValues().

◆ operator()()

double aims::MovingAverageCascadeKernel::operator() ( int x) const

Get value.

◆ operator=()

MovingAverageCascadeKernel & aims::MovingAverageCascadeKernel::operator= ( const MovingAverageCascadeKernel & other)

◆ reset()

void aims::MovingAverageCascadeKernel::reset ( unsigned length = 3,
unsigned n = 2,
FilterType::Direction symtype = FilterType::Symmetrical )

Set parameters.

Be aware that a call to reset, etc. will trigger a reallocation of the array and a recomputing of the values. If several of these values need changing, it is thus avdised to use the reset() method.

(Re)set all parameters

References length(), and aims::FilterType::Symmetrical.

◆ setCascade()

void aims::MovingAverageCascadeKernel::setCascade ( unsigned n)

◆ setLength()

void aims::MovingAverageCascadeKernel::setLength ( unsigned length)

References length().

◆ setType()

void aims::MovingAverageCascadeKernel::setType ( FilterType::Direction symtype)

◆ setValues()

void aims::MovingAverageCascadeKernel::setValues ( unsigned length,
unsigned n,
FilterType::Direction symtype )
protected

References length().

◆ support()

const Point2di & aims::MovingAverageCascadeKernel::support ( ) const

◆ type()

FilterType::Direction aims::MovingAverageCascadeKernel::type ( ) const

Member Data Documentation

◆ _n

unsigned aims::MovingAverageCascadeKernel::_n
protected

Definition at line 188 of file movingaveragefilter.h.

◆ _support

Point2di aims::MovingAverageCascadeKernel::_support
protected

Definition at line 189 of file movingaveragefilter.h.

◆ _values

std::vector<double> aims::MovingAverageCascadeKernel::_values
protected

Definition at line 190 of file movingaveragefilter.h.


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