vspline 1.1.0
Generic C++11 Code for Uniform B-Splines
Public Member Functions | Public Attributes | List of all members
vspline::iir_filter_specs Struct Reference

structure to hold specifications for an iir_filter object. This set of parameters has to be passed through from the calling code through the multithreading code to the worker threads where the filter objects are finally constructed. Rather than passing the parameters via some variadic mechanism, it's more concise and expressive to contain them in a structure and pass that around. The filter itself inherits its specification type, and if the code knows the handler's type, it can derive the spec type. This way the argument passing can be formalized, allowing for uniform handling of several different filter types with the same code. Here we have the concrete parameter set needed for b-spline prefiltering. We'll pass one set of 'specs' per axis; it contains: More...

#include <prefilter.h>

Inheritance diagram for vspline::iir_filter_specs:
vspline::iir_filter< _vtype< _math_ele_type, vspline::vector_traits< _math_ele_type >::size > > vspline::iir_filter< in_type, out_type, _math_type > vspline::bspl_prefilter< _vtype, _math_ele_type, _vsize >

Public Member Functions

 iir_filter_specs (vspline::bc_code _bc, int _npoles, const xlf_type *_pole, xlf_type _tolerance, xlf_type _boost=xlf_type(1))
 

Public Attributes

vspline::bc_code bc
 
int npoles
 
const xlf_typepole
 
xlf_type tolerance
 
xlf_type boost
 

Detailed Description

structure to hold specifications for an iir_filter object. This set of parameters has to be passed through from the calling code through the multithreading code to the worker threads where the filter objects are finally constructed. Rather than passing the parameters via some variadic mechanism, it's more concise and expressive to contain them in a structure and pass that around. The filter itself inherits its specification type, and if the code knows the handler's type, it can derive the spec type. This way the argument passing can be formalized, allowing for uniform handling of several different filter types with the same code. Here we have the concrete parameter set needed for b-spline prefiltering. We'll pass one set of 'specs' per axis; it contains:

Definition at line 162 of file prefilter.h.

Constructor & Destructor Documentation

◆ iir_filter_specs()

vspline::iir_filter_specs::iir_filter_specs ( vspline::bc_code  _bc,
int  _npoles,
const xlf_type _pole,
xlf_type  _tolerance,
xlf_type  _boost = xlf_type ( 1 ) 
)
inline

Definition at line 170 of file prefilter.h.

Member Data Documentation

◆ bc

vspline::bc_code vspline::iir_filter_specs::bc

Definition at line 164 of file prefilter.h.

◆ boost

xlf_type vspline::iir_filter_specs::boost

Definition at line 168 of file prefilter.h.

◆ npoles

int vspline::iir_filter_specs::npoles

Definition at line 165 of file prefilter.h.

◆ pole

const xlf_type* vspline::iir_filter_specs::pole

Definition at line 166 of file prefilter.h.

◆ tolerance

xlf_type vspline::iir_filter_specs::tolerance

Definition at line 167 of file prefilter.h.


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