Filter< N, T > Class Template Reference

Templated representation of a symmetric N-dimensional filter function in T^N centered at zero with known max support (where the function is zero outside of that radius of that support; ie, support is equivalent to diameter). More...

#include <Filter.h>

Inheritance diagram for Filter< N, T >:

PropertyMap KernelFilter BoxFilter GaussianFilter LanczosSincFilter MitchellFilter TriangleFilter

List of all members.

Public Member Functions

Constructors
 Filter (real_t support=2)
virtual ~Filter ()
Initialization
virtual void init ()
 Performs any initialization which may be necessary before filter evaluation.
Main usage interface
virtual T evaluate (const Vector2 &pt)=0
Accessors / Mutators
real_t getSupport () const

Protected Attributes

real_t m_support


Detailed Description

template<unsigned N = 2, typename T = real_t>
class Filter< N, T >

Templated representation of a symmetric N-dimensional filter function in T^N centered at zero with known max support (where the function is zero outside of that radius of that support; ie, support is equivalent to diameter).

Author:
Travis Fischer (fisch0920@gmail.com)

Matthew Jacobs (jacobs.mh@gmail.com)

Date:
Fall 2008

Definition at line 21 of file Filter.h.


Constructor & Destructor Documentation

template<unsigned N = 2, typename T = real_t>
Filter< N, T >::Filter ( real_t  support = 2  )  [inline]

Definition at line 26 of file Filter.h.

template<unsigned N = 2, typename T = real_t>
virtual Filter< N, T >::~Filter (  )  [inline, virtual]

Definition at line 30 of file Filter.h.


Member Function Documentation

template<unsigned N = 2, typename T = real_t>
virtual void Filter< N, T >::init (  )  [inline, virtual]

Performs any initialization which may be necessary before filter evaluation.

Note:
Default implementation initializes the filter support based on its PropertyMap

Reimplemented in GaussianFilter, KernelFilter, LanczosSincFilter, and MitchellFilter.

Definition at line 47 of file Filter.h.

template<unsigned N = 2, typename T = real_t>
virtual T Filter< N, T >::evaluate ( const Vector2 pt  )  [pure virtual]

Returns:
the value of this filter function evaluated at the given point

Implemented in BoxFilter, GaussianFilter, KernelFilter, LanczosSincFilter, MitchellFilter, and TriangleFilter.

template<unsigned N = 2, typename T = real_t>
real_t Filter< N, T >::getSupport (  )  const [inline]

Returns:
the size of the support of this filter (symmetric)

Definition at line 68 of file Filter.h.


Member Data Documentation

template<unsigned N = 2, typename T = real_t>
real_t Filter< N, T >::m_support [protected]

Definition at line 76 of file Filter.h.


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

Generated on 28 Feb 2009 for Milton by doxygen 1.5.6