jsa::cicuetea::NsgfCqtSparse Class Reference

Sparse implementation of the NSGF-CQT. More...

#include <CQT.hpp>

Inheritance diagram for jsa::cicuetea::NsgfCqtSparse:

Classes
struct	Span
	Represents a span of indices for a band. More...

Public Types
using	Coefs = std::vector<Eigen::ArrayXcd>
	Type alias for coefficients.
using	Frame = std::vector<Eigen::ArrayXd>
	Type alias for frame.
using	SpanList = std::vector<Span>
	Type alias for span list.

Public Member Functions
	NsgfCqtSparse (double sampleRate, Eigen::Index nSamps, double fraction, double minFrequency, double maxFrequency, double refFrequency)
	Constructor for NsgfCqtSparse.
void	forward (const Eigen::ArrayXd &x, Coefs &Xcq)
	Performs the forward NSGF-CQT transformation.
void	inverse (const Coefs &Xcq, Eigen::ArrayXd &x)
	Performs the inverse NSGF-CQT transformation.
const Frame &	getFrame () const
const Eigen::ArrayXd &	getAtom (Eigen::Index k) const
const Frame &	getDualFrame () const
const Eigen::ArrayXd &	getDualAtom (Eigen::Index k) const
const Coefs &	getPhaseCoefs () const
Span	getBandSpan (Eigen::Index k) const
Eigen::ArrayXd	getFrequencyAxis (Eigen::Index k) const
Eigen::Index	getLength (Eigen::Index k) const
double	getCoeffRate (Eigen::Index k) const
Frame	getRealCoefs () const
Coefs	getCoefs () const
Coefs	getValidCoefs () const
Public Member Functions inherited from jsa::cicuetea::NsgfCqtCommon
	NsgfCqtCommon (double sampleRate, Eigen::Index numSamples, double fraction, double minFrequency, double maxFrequency, double refFrequency)
	Constructor for NsgfCqtCommon.
bool	isValid () const
	True when the object is usable: the configuration passed validate() and the constructed frame passed the measured health check (see checkFrameHealth()).
double	getFrameConditionNumber () const
	Condition number of the painless frame operator, max(d)/min(d) up to Nyquist. Advisory: reconstruction error amplifies by roughly cond·ε, so values ≲ 1e6 keep double-precision round trips near 1e-10. Returns +inf when the object is invalid.
double	getSampleRate () const
Eigen::Index	getBlockSize () const
	Synonym of getNumSamps().
Eigen::Index	getNumSamps () const
	Synonym of getBlockSize().
double	getFraction () const
double	getPpo () const
double	getMinFreq () const
double	getMaxFreq () const
double	getRefFreq () const
Eigen::Index	getNumFreqs () const
Eigen::Index	getNumBands () const
const Eigen::ArrayXd &	getFrequencyAxis () const
const Eigen::ArrayXd &	getBandAxis () const
const Eigen::ArrayXd &	getDiagonalization () const

Additional Inherited Members
Protected Member Functions inherited from jsa::cicuetea::NsgfCqtCommon
bool	checkFrameHealth () const
	Measured frame-health check on the constructed frame operator.
Static Protected Member Functions inherited from jsa::cicuetea::NsgfCqtCommon
static bool	validate (double fs, Eigen::Index nSamps, double frac, double fMin, double fMax, double fRef)
	Checks the structural validity conditions for a configuration.
static BandInfo	computeBandInfo (double frac, double fMin, double fMax, double fRef)
	Computes band information for the filterbank.
Protected Attributes inherited from jsa::cicuetea::NsgfCqtCommon
const bool	valid
	Structural validity: result of validate().
bool	frameOk = true
	Measured frame health; set by derived ctors.
const double	fs
	Sampling rate (Hz).
const Eigen::Index	nSamps
	Number of samples in a block (0 when invalid).
const double	frac
	Reciprocal of bands per octave.
const double	fMin
	Minimum frequency (Hz).
const double	fMax
	Maximum frequency (Hz).
const double	fRef
	Reference frequency (Hz).
const BandInfo	bandInfo
	Band information.
const Eigen::Index	nBands
	Total number of bands.
const Eigen::Index	nFreqs
	Number of frequencies.
Eigen::ArrayXd	bax
	Band axis.
Eigen::ArrayXd	fax
	Frequency axis.
Eigen::ArrayXd	d
	Diagonalization array.
Eigen::ArrayXcd	Xdft
	DFT of the signal.
DFT	dft
	Discrete Fourier Transform object.
Static Protected Attributes inherited from jsa::cicuetea::NsgfCqtCommon
static constexpr double	dHealthTol = 1e-6
static constexpr double	th = 1e-6
static constexpr Eigen::Index	minAtomSupport = 4

Detailed Description

Sparse implementation of the NSGF-CQT.

This class provides methods for forward and inverse NSGF-CQT transformations using a sparse representation of the filterbank.

Constructor & Destructor Documentation

NsgfCqtSparse()

NsgfCqtSparse::NsgfCqtSparse	(	double	sampleRate,
		Eigen::Index	nSamps,
		double	fraction,
		double	minFrequency,
		double	maxFrequency,
		double	refFrequency )

Constructor for NsgfCqtSparse.

Parameters

sampleRate	Sampling rate of the signal (Hz).
nSamps	Number of samples in the signal.
fraction	Reciprocal of bands per octave (e.g. 1.0/12 for 12 bands/octave); fractional values allowed.
minFrequency	Minimum frequency of the filterbank (Hz).
maxFrequency	Maximum frequency of the filterbank (Hz).
refFrequency	Reference frequency for the filterbank (Hz).

Member Function Documentation

forward()

void NsgfCqtSparse::forward	(	const Eigen::ArrayXd &	x,
		Coefs &	Xcq )

Performs the forward NSGF-CQT transformation.

Parameters

x	Input signal.
Xcq	Output constant-Q transform coefficients.

inverse()

void NsgfCqtSparse::inverse	(	const Coefs &	Xcq,
		Eigen::ArrayXd &	x )

Performs the inverse NSGF-CQT transformation.

Parameters

Xcq	Input constant-Q transform coefficients.
x	Output reconstructed signal.

---

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

• /home/runner/work/CiCueTea/CiCueTea/Include/CQT.hpp
• /home/runner/work/CiCueTea/CiCueTea/Source/CQT.cpp