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

fir_filter_specs holds the parameters for a filter performing a convolution along a single axis. In vspline, the place where the specifications for a filter are fixed and the place where it is finally created are far apart: the filter is created in the separate worker threads. So this structure serves as a vehicle to transport the arguments. Note the specification of 'headroom': this allows for non-symmetrical and even kernels. When applying the kernel to obtain output[i], the kernel is applied to input [ i - headroom ] , ... , input [ i - headroom + ksize - 1 ] More...

#include <convolve.h>

Inheritance diagram for vspline::fir_filter_specs:
vspline::fir_filter< _vtype< _math_ele_type, _vsize > > vspline::fir_filter< in_type, out_type, _math_type > vspline::convolve< _vtype, _math_ele_type, _vsize >

Public Member Functions

 fir_filter_specs (vspline::bc_code _bc, int _ksize, int _headroom, const xlf_type *_kernel)
 

Public Attributes

vspline::bc_code bc
 
int ksize
 
int headroom
 
const xlf_typekernel
 

Detailed Description

fir_filter_specs holds the parameters for a filter performing a convolution along a single axis. In vspline, the place where the specifications for a filter are fixed and the place where it is finally created are far apart: the filter is created in the separate worker threads. So this structure serves as a vehicle to transport the arguments. Note the specification of 'headroom': this allows for non-symmetrical and even kernels. When applying the kernel to obtain output[i], the kernel is applied to input [ i - headroom ] , ... , input [ i - headroom + ksize - 1 ]

Definition at line 92 of file convolve.h.

Constructor & Destructor Documentation

◆ fir_filter_specs()

vspline::fir_filter_specs::fir_filter_specs ( vspline::bc_code  _bc,
int  _ksize,
int  _headroom,
const xlf_type _kernel 
)
inline

Definition at line 99 of file convolve.h.

Member Data Documentation

◆ bc

vspline::bc_code vspline::fir_filter_specs::bc

Definition at line 94 of file convolve.h.

◆ headroom

int vspline::fir_filter_specs::headroom

Definition at line 96 of file convolve.h.

◆ kernel

const xlf_type* vspline::fir_filter_specs::kernel

Definition at line 97 of file convolve.h.

◆ ksize

int vspline::fir_filter_specs::ksize

Definition at line 95 of file convolve.h.


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