|
JUCE
|
A set of coefficients for use in an FIRFilter object. More...
#include <juce_FIRFilter.h>
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. | |
Public Types inherited from juce::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. | |
Public Member Functions | |
| Coefficients () | |
| Creates a null set of coefficients (which will produce silence). | |
| Coefficients (size_t size) | |
| Creates a null set of coefficients of a given size. | |
| Coefficients (const NumericType *samples, size_t numSamples) | |
| Creates a set of coefficients from an array of samples. | |
| 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. | |
| double | getMagnitudeForFrequency (double frequency, double sampleRate) const noexcept |
| Returns the magnitude frequency response of the filter for a given frequency and sample rate. | |
| 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. | |
| double | getPhaseForFrequency (double frequency, double sampleRate) const noexcept |
| Returns the phase frequency response of the filter for a given frequency and sample rate. | |
| 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. | |
| NumericType * | getRawCoefficients () noexcept |
| Returns a raw data pointer to the coefficients. | |
| const NumericType * | getRawCoefficients () const noexcept |
| Returns a raw data pointer to the coefficients. | |
| void | normalise () noexcept |
| Scales the values of the FIR filter with the sum of the squared coefficients. | |
Public Member Functions inherited from ReferenceCountedObject | |
| void | incReferenceCount () noexcept |
| Increments the object's reference count. | |
| void | decReferenceCount () noexcept |
| Decreases the object's reference count. | |
| bool | decReferenceCountWithoutDeleting () noexcept |
| Decreases the object's reference count. | |
| int | getReferenceCount () const noexcept |
| Returns the object's current reference count. | |
Public Attributes | |
| Array< NumericType > | coefficients |
| The raw coefficients. | |
Additional Inherited Members | |
Protected Member Functions inherited from ReferenceCountedObject | |
| ReferenceCountedObject ()=default | |
| Creates the reference-counted object (with an initial ref count of zero). | |
| ReferenceCountedObject (const ReferenceCountedObject &) noexcept | |
| Copying from another object does not affect this one's reference-count. | |
| ReferenceCountedObject (ReferenceCountedObject &&) noexcept | |
| Copying from another object does not affect this one's reference-count. | |
| ReferenceCountedObject & | operator= (const ReferenceCountedObject &) noexcept |
| Copying from another object does not affect this one's reference-count. | |
| ReferenceCountedObject & | operator= (ReferenceCountedObject &&) noexcept |
| Copying from another object does not affect this one's reference-count. | |
| virtual | ~ReferenceCountedObject () |
| Destructor. | |
| void | resetReferenceCount () noexcept |
| Resets the reference count to zero without deleting the object. | |
A set of coefficients for use in an FIRFilter object.
| using juce::dsp::FIR::Coefficients< NumericType >::Ptr = ReferenceCountedObjectPtr<Coefficients> |
The Coefficients structure is ref-counted, so this is a handy type that can be used as a pointer to one.
| juce::dsp::FIR::Coefficients< NumericType >::Coefficients | ( | ) |
Creates a null set of coefficients (which will produce silence).
| juce::dsp::FIR::Coefficients< NumericType >::Coefficients | ( | size_t | size | ) |
Creates a null set of coefficients of a given size.
References juce::dsp::FIR::Coefficients< NumericType >::coefficients, and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::resize().
| juce::dsp::FIR::Coefficients< NumericType >::Coefficients | ( | const NumericType * | samples, |
| size_t | numSamples ) |
Creates a set of coefficients from an array of samples.
|
default |
|
default |
|
default |
|
default |
|
noexcept |
Returns the filter order associated with the coefficients.
References juce::dsp::FIR::Coefficients< NumericType >::coefficients, and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().
|
noexcept |
Returns the magnitude frequency response of the filter for a given frequency and sample rate.
|
noexcept |
Returns the magnitude frequency response of the filter for a given frequency array and sample rate.
|
noexcept |
Returns the phase frequency response of the filter for a given frequency and sample rate.
|
noexcept |
Returns the phase frequency response of the filter for a given frequency array and sample rate.
|
noexcept |
Returns a raw data pointer to the coefficients.
References juce::dsp::FIR::Coefficients< NumericType >::coefficients, and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getRawDataPointer().
|
noexcept |
Returns a raw data pointer to the coefficients.
References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::begin(), and juce::dsp::FIR::Coefficients< NumericType >::coefficients.
|
noexcept |
Scales the values of the FIR filter with the sum of the squared coefficients.
| Array<NumericType> juce::dsp::FIR::Coefficients< NumericType >::coefficients |
The raw coefficients.
You should leave these numbers alone unless you really know what you're doing.
Referenced by juce::dsp::FIR::Coefficients< NumericType >::Coefficients(), juce::dsp::FIR::Coefficients< NumericType >::getFilterOrder(), juce::dsp::FIR::Coefficients< NumericType >::getRawCoefficients(), and juce::dsp::FIR::Coefficients< NumericType >::getRawCoefficients().