A set of coefficients for use in an FIRFilter object. More...

Inheritance diagram for dsp::FIR::Coefficients< NumericType >:

Public Types
using	Ptr = ReferenceCountedObjectPtr< Coefficients >
	The Coefficients structure is ref-counted, so this is a handy type that can be used as a pointer to one. More...

Public Types inherited from dsp::ProcessorState
using	Ptr = ReferenceCountedObjectPtr< ProcessorState >
	The ProcessorState structure is ref-counted, so this is a handy type that can be used as a pointer to one. More...

Public Member Functions
	Coefficients ()
	Creates a null set of coefficients (which will produce silence). More...

	Coefficients (size_t size)
	Creates a null set of coefficients of a given size. More...

	Coefficients (const NumericType *samples, size_t numSamples)
	Creates a set of coefficients from an array of samples. More...

	Coefficients (const Coefficients &)=default

	Coefficients (Coefficients &&)=default

Coefficients &	operator= (const Coefficients &)=default

Coefficients &	operator= (Coefficients &&)=default

size_t	getFilterOrder () const noexcept
	Returns the filter order associated with the coefficients. More...

double	getMagnitudeForFrequency (double frequency, double sampleRate) const noexcept
	Returns the magnitude frequency response of the filter for a given frequency and sample rate. More...

void	getMagnitudeForFrequencyArray (double frequencies, double magnitudes, size_t numSamples, double sampleRate) const noexcept
	Returns the magnitude frequency response of the filter for a given frequency array and sample rate. More...

double	getPhaseForFrequency (double frequency, double sampleRate) const noexcept
	Returns the phase frequency response of the filter for a given frequency and sample rate. More...

void	getPhaseForFrequencyArray (double frequencies, double phases, size_t numSamples, double sampleRate) const noexcept
	Returns the phase frequency response of the filter for a given frequency array and sample rate. More...

NumericType *	getRawCoefficients () noexcept
	Returns a raw data pointer to the coefficients. More...

const NumericType *	getRawCoefficients () const noexcept
	Returns a raw data pointer to the coefficients. More...

void	normalise () noexcept
	Scales the values of the FIR filter with the sum of the squared coefficients. More...

Public Member Functions inherited from ReferenceCountedObject
void	incReferenceCount () noexcept
	Increments the object's reference count. More...

void	decReferenceCount () noexcept
	Decreases the object's reference count. More...

bool	decReferenceCountWithoutDeleting () noexcept
	Decreases the object's reference count. More...

int	getReferenceCount () const noexcept
	Returns the object's current reference count. More...

Public Attributes
Array< NumericType >	coefficients
	The raw coefficients. More...

Additional Inherited Members
Protected Member Functions inherited from ReferenceCountedObject
	ReferenceCountedObject ()=default
	Creates the reference-counted object (with an initial ref count of zero). More...

	ReferenceCountedObject (const ReferenceCountedObject &) noexcept
	Copying from another object does not affect this one's reference-count. More...

	ReferenceCountedObject (ReferenceCountedObject &&) noexcept
	Copying from another object does not affect this one's reference-count. More...

ReferenceCountedObject &	operator= (const ReferenceCountedObject &) noexcept
	Copying from another object does not affect this one's reference-count. More...

ReferenceCountedObject &	operator= (ReferenceCountedObject &&) noexcept
	Copying from another object does not affect this one's reference-count. More...

virtual	~ReferenceCountedObject ()
	Destructor. More...

void	resetReferenceCount () noexcept
	Resets the reference count to zero without deleting the object. More...

Detailed Description

template<typename NumericType>
struct dsp::FIR::Coefficients< NumericType >

A set of coefficients for use in an FIRFilter object.

See also: FIRFilter