Filter1D Class Reference

#include <filter.h>

Public Member Functions
	Filter1D (float width)
virtual	~Filter1D (void)
float	width (void) const
	Get the width of the filter. More...
virtual float	operator() (float x) const =0
	Evaluate the filter at an x position (relative to filter center) More...
virtual string_view	name (void) const =0
	Return the name of the filter, e.g., "box", "gaussian". More...

Static Public Member Functions
static Filter1D *	create (string_view filtername, float width)
static void	destroy (Filter1D *filt)
	Destroy a filter that was created with create(). More...
static int	num_filters ()
	Get the number of filters supported. More...
static void	get_filterdesc (int filternum, FilterDesc *filterdesc)
	Get the info for a particular index (0..num_filters()-1). More...
static const FilterDesc &	get_filterdesc (int filternum)

Protected Attributes
float	m_w

Detailed Description

Filter1D is the abstract data type for a 1D filter. The filters are NOT expected to have their results normalized.

Definition at line 31 of file filter.h.

Constructor & Destructor Documentation

Filter1D::Filter1D ( float  width )

inline

Definition at line 33 of file filter.h.

virtual Filter1D::~Filter1D ( void  )

inlinevirtual

Definition at line 37 of file filter.h.

Member Function Documentation

static Filter1D* Filter1D::create ( string_view  filtername, float  width  )

static

This static function allocates and returns an instance of the specific filter implementation for the name you provide. Example use: Filter1D *myfilt = Filter1::create ("box", 1); The caller is responsible for deleting it when it's done. If the name is not recognized, return NULL.

static void Filter1D::destroy ( Filter1D *  filt )

static

Destroy a filter that was created with create().

static void Filter1D::get_filterdesc ( int  filternum, FilterDesc *  filterdesc  )

static

Get the info for a particular index (0..num_filters()-1).

static const FilterDesc& Filter1D::get_filterdesc ( int  filternum )

static

virtual string_view Filter1D::name ( void  ) const

pure virtual

Return the name of the filter, e.g., "box", "gaussian".

static int Filter1D::num_filters ( )

static

Get the number of filters supported.

virtual float Filter1D::operator() ( float  x ) const

pure virtual

Evaluate the filter at an x position (relative to filter center)

float Filter1D::width ( void  ) const

inline

Get the width of the filter.

Definition at line 40 of file filter.h.

Member Data Documentation

float Filter1D::m_w

protected

Definition at line 66 of file filter.h.

---

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

• OpenImageIO/filter.h