JPL::DualShelfFilterBase< TopoType > Class Template Reference

#include <JPLSpatial/Auralization/DualShelfFilter.h>

Inheritance diagram for JPL::DualShelfFilterBase< TopoType >:

Public Types
using	Base = Impl::DSFCommonBase<TopoType>
using	StateType = typename Base::StateType

Public Member Functions
JPL_INLINE void	Prepare (DualShelfFilterParams params)
void	PrepareLinear (const DualShelfFilterParams &params)
JPL_INLINE void	SetFrequencies (float Fl, float Fh)
	Set the desired frequencies of the control points.
JPL_INLINE void	SetGainLinear (float gain, float weight)
void	SetGainLinear (float gain)
	Set the desired filter gain at nyquist.

Member Typedef Documentation

Base

template<Impl::CDSFTopo TopoType>

using JPL::DualShelfFilterBase< TopoType >::Base = Impl::DSFCommonBase<TopoType>

StateType

template<Impl::CDSFTopo TopoType>

using JPL::DualShelfFilterBase< TopoType >::StateType = typename Base::StateType

Member Function Documentation

Prepare()

template<Impl::CDSFTopo TopoType>

JPL_INLINE void JPL::DualShelfFilterBase< TopoType >::Prepare

(

DualShelfFilterParams

params

)

Parameter gain is expected in dB. This must be called at least once before anything else.

PrepareLinear()

template<Impl::CDSFTopo TopoType>

void JPL::DualShelfFilterBase< TopoType >::PrepareLinear ( const DualShelfFilterParams & params )

inline

Prepare DSF with given parameters. Parameter gain is expected to be linear. This must be called at least once before anything else.

SetFrequencies()

template<Impl::CDSFTopo TopoType>

JPL_INLINE void JPL::DualShelfFilterBase< TopoType >::SetFrequencies	(	float	Fl,
		float	Fh )

Set the desired frequencies of the control points.

SetGainLinear() [1/2]

template<Impl::CDSFTopo TopoType>

void JPL::DualShelfFilterBase< TopoType >::SetGainLinear ( float gain )

inline

Set the desired filter gain at nyquist.

SetGainLinear() [2/2]

template<Impl::CDSFTopo TopoType>

JPL_INLINE void JPL::DualShelfFilterBase< TopoType >::SetGainLinear	(	float	gain,
		float	weight )

Set the desired filter gain at nyquist and weight between shelf filters. Weight parameters controlls how much of the gain change goes to lower vs higher shelfs.

---

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

• JPLSpatial/Auralization/DualShelfFilter.h