Shared utilities (I/O helpers, spectral analysis, layout management, warp algorithms). More...

Classes
struct	ArtifactDetectEcgParams
	ECG R-peak detection parameters (defined outside class to avoid Clang/GCC default-argument issues with nested structs). More...
struct	ArtifactDetectEogParams
	EOG blink / saccade detection parameters (defined outside class to avoid Clang/GCC default-argument issues with nested structs). More...
class	ArtifactDetect
	ECG and EOG physiological artifact event detection. More...
struct	BadChannelDetectParams
	Bad-channel detection parameters (defined outside class to avoid Clang/GCC default-argument issues with nested structs). More...
class	BadChannelDetect
	Automated detection of bad MEG/EEG channels using flat, variance, and correlation criteria. More...
class	CosineFilter
	Creates a cosine filter response in the frequency domain. More...
struct	EpochExtractorParams
	Epoch extraction parameters (defined outside class to avoid Clang/GCC default-argument issues with nested structs). More...
class	EpochExtractor
	Segments continuous raw data into fixed-length epochs locked to events. More...
class	FilterIO
	Processes txt files which hold filter coefficients. More...
class	FilterParameter
	Named filter-design parameter descriptor holding a human-readable name and description (e.g. design method or filter type). More...
class	FilterKernel
	The FilterKernel class provides methods to create/design a FIR filter kernel. More...
class	FirFilter
	Discoverable façade over the FilterKernel FIR-filter engine. More...
struct	IcaResult
	Result of an ICA decomposition. More...
class	ICA
	Independent Component Analysis using the FastICA algorithm (deflationary, logcosh nonlinearity). More...
struct	IirBiquad
	Coefficients of one second-order IIR section (biquad). More...
class	IirFilter
	Butterworth IIR filter design and application using second-order sections. More...
class	ParksMcClellan
	Parks-McClellan equiripple FIR filter design algorithm (Remez exchange). More...
class	Resample
	Polyphase anti-aliased rational resampling for MEG/EEG data. More...
struct	SpectogramInputData
	Input parameters for short-time Fourier transform spectrogram computation. More...
class	Spectrogram
	Computes time-frequency spectrograms via short-time Fourier transform with configurable window and overlap. More...
struct	SSSParams
	Implements Signal Space Separation (SSS) and temporal SSS (tSSS) for MEG data. More...
class	SSS
class	KMeans
	K-Means Clustering. More...
class	Linalg
	Static linear algebra utility functions. More...
class	Numerics
	Static numerical utility functions. More...
class	SimplexAlgorithm
	Simplex algorithm. More...
struct	TaperedSpectraInputData
	Input parameters for multi-taper spectral estimation (data matrix, taper weights, frequencies, sample rate). More...
class	Spectral
	Computes spectral measures of input data. More...
struct	FitUser
	Workspace for sphere-fitting optimisation, holding 3-D point coordinates and a report flag. More...
class	Sphere
	Describes a 3D sphere object. More...
class	Warp
	Thin Plate Spline Warp. More...
class	CircularBuffer
	Thread-safe lock-free circular (ring) buffer for producer-consumer data exchange between threads. More...
class	ICommand
	The ICommand interface provides the base class of every command of the command design pattern. More...
class	MNELogger
	Custom Qt message handler that formats and routes qDebug/qWarning/qCritical output to file or console. More...
class	IObserver
	The IObserver interface provides the base class of every observer of the observer design pattern. More...
class	Subject
	The Subject class provides the base class of every subject of the observer design pattern. More...
class	IOUtils
	Eigen matrix I/O utilities. More...
class	LayoutLoader
	Processes AsA .elc files which contain the electrode positions of a EEG hat. More...
struct	fitUser
	Workspace for sphere-fitting used by the layout maker, holding 3-D point coordinates and fit parameters. More...
class	LayoutMaker
	Make layout files from given 3D points. More...
class	SelectionIO
	Processes selection files (mne .sel) files which contain the chanels for each selection group. More...

Typedefs
typedef CircularBuffer< int >	CircularBuffer_int
typedef CircularBuffer< short >	CircularBuffer_short
typedef CircularBuffer< char >	CircularBuffer_char
typedef CircularBuffer< double >	CircularBuffer_double
typedef CircularBuffer< QPair< int, int > >	CircularBuffer_pair_int_int
typedef CircularBuffer< QPair< double, double > >	CircularBuffer_pair_double_double
typedef CircularBuffer< Eigen::MatrixXd >	CircularBuffer_Matrix_double
typedef CircularBuffer< Eigen::MatrixXf >	CircularBuffer_Matrix_float
typedef struct UTILSLIB::fitUser	fitUserRec

Enumerations
enum class	KMeansDistance { SquaredEuclidean , CityBlock , Cosine , Correlation , Hamming }
	Distance metric for K-Means clustering. More...
enum class	KMeansStart { Sample , Uniform , Cluster }
	Initialization strategy for K-Means clustering. More...
enum class	KMeansEmptyAction { Error , Drop , Singleton }
	Action to take when a K-Means cluster becomes empty. More...

Functions
DSPSHARED_EXPORT Eigen::MatrixXd	makeSpharaProjector (const Eigen::MatrixXd &matBaseFct, const Eigen::VectorXi &vecIndices, int iOperatorDim, int iNBaseFct, int iSkip=0)
constexpr auto	timeNowNow ()
constexpr auto	dateToday ()
constexpr auto	dateTimeNow ()
constexpr auto	gitHash ()
constexpr auto	gitHashLong ()
const char *	buildDateTime ()
const char *	buildHash ()
const char *	buildHashLong ()

Detailed Description

Shared utilities (I/O helpers, spectral analysis, layout management, warp algorithms).

Typedef Documentation

◆ CircularBuffer_char

typedef CircularBuffer<char> UTILSLIB::CircularBuffer_char

Defines CircularBuffer of char type.

Definition at line 301 of file circularbuffer.h.

◆ CircularBuffer_double

typedef CircularBuffer<double> UTILSLIB::CircularBuffer_double

Defines CircularBuffer of double type.

Definition at line 302 of file circularbuffer.h.

◆ CircularBuffer_int

typedef CircularBuffer<int> UTILSLIB::CircularBuffer_int

Defines CircularBuffer of integer type.

Definition at line 299 of file circularbuffer.h.

◆ CircularBuffer_Matrix_double

typedef CircularBuffer< Eigen::MatrixXd > UTILSLIB::CircularBuffer_Matrix_double

Defines CircularBuffer of Eigen::MatrixXd type.

Definition at line 305 of file circularbuffer.h.

◆ CircularBuffer_Matrix_float

typedef CircularBuffer< Eigen::MatrixXf > UTILSLIB::CircularBuffer_Matrix_float

Defines CircularBuffer of Eigen::MatrixXf type.

Definition at line 306 of file circularbuffer.h.

◆ CircularBuffer_pair_double_double

typedef CircularBuffer< QPair<double, double> > UTILSLIB::CircularBuffer_pair_double_double

Defines CircularBuffer of double Pair type.

Definition at line 304 of file circularbuffer.h.

◆ CircularBuffer_pair_int_int

typedef CircularBuffer< QPair<int, int> > UTILSLIB::CircularBuffer_pair_int_int

Defines CircularBuffer of integer Pair type.

Definition at line 303 of file circularbuffer.h.

◆ CircularBuffer_short

typedef CircularBuffer<short> UTILSLIB::CircularBuffer_short

Defines CircularBuffer of short type.

Definition at line 300 of file circularbuffer.h.

◆ fitUserRec

typedef struct UTILSLIB::fitUser UTILSLIB::fitUserRec

Enumeration Type Documentation

◆ KMeansDistance

enum class UTILSLIB::KMeansDistance

strong

Distance metric for K-Means clustering.

Enumerator
SquaredEuclidean	Squared Euclidean distance (default).
CityBlock	Manhattan / city-block distance.
Cosine	Cosine distance.
Correlation	Correlation distance.
Hamming	Hamming distance (binary data only).

Definition at line 77 of file kmeans.h.

◆ KMeansEmptyAction

enum class UTILSLIB::KMeansEmptyAction

strong

Action to take when a K-Means cluster becomes empty.

Enumerator
Error	Treat as an error (default).
Drop	Drop the empty cluster.
Singleton	Replace with the farthest point from its centroid.

Definition at line 95 of file kmeans.h.

◆ KMeansStart

enum class UTILSLIB::KMeansStart

strong

Initialization strategy for K-Means clustering.

Enumerator
Sample	Random sample of data points (default).
Uniform	Uniform random within data range.
Cluster	Sub-sample then cluster.

Definition at line 87 of file kmeans.h.

Function Documentation

◆ buildDateTime()

const char * UTILSLIB::buildDateTime ( )

Returns build date and time.

Definition at line 46 of file utils_global.cpp.

◆ buildHash()

const char * UTILSLIB::buildHash ( )

Returns abbreviated build git hash.

Definition at line 50 of file utils_global.cpp.

◆ buildHashLong()

const char * UTILSLIB::buildHashLong ( )

Returns full build git hash.

Definition at line 54 of file utils_global.cpp.

◆ dateTimeNow()

auto UTILSLIB::dateTimeNow ( )

constexpr

Returns build date and time (time preprocessor was run). Must be called in compiled function to return correctly.

Definition at line 70 of file buildinfo.h.

◆ dateToday()

auto UTILSLIB::dateToday ( )

constexpr

Returns build date (time preprocessor was run). Must be called in compiled function to return correctly.

Definition at line 60 of file buildinfo.h.

◆ gitHash()

auto UTILSLIB::gitHash ( )

constexpr

Returns short version of the hash of the current git commit

Definition at line 79 of file buildinfo.h.

◆ gitHashLong()

auto UTILSLIB::gitHashLong ( )

constexpr

Returns entire hash of the current git commit

Definition at line 92 of file buildinfo.h.

◆ makeSpharaProjector()

DSPSHARED_EXPORT Eigen::MatrixXd UTILSLIB::makeSpharaProjector	(	const Eigen::MatrixXd &	matBaseFct,
		const Eigen::VectorXi &	vecIndices,
		int	iOperatorDim,
		int	iNBaseFct,
		int	iSkip = 0 )

Constructs a SPHARA operator.

Parameters

[in]	matBaseFct	The SPHARA basis functions.
[in]	vecIndices	The indices of the positions in the final oeprator which are to be filled with the basis functions weights (i.e. these indices could respond to the indices of gradioemteres in a VectorView system).
[in]	iOperatorDim	The dimensions of the final SPHARA operator. Make sure that these correspond to the dimensions of the data matrix you want tol multiply with the SPHARA operator.
[in]	iNBaseFct	The number of SPHARA basis functions to take.
[in]	iSkip	The value to skip when reading the vecIndices variabel. I.e. use this when dealing with VectorView triplets, which include two gradiometers.

Returns: Returns the final SPHARA operator with dimensions (iOperatorDim,iOperatorDim).

◆ timeNowNow()

auto UTILSLIB::timeNowNow ( )

constexpr

Returns build time (time preprocessor was run). Must be called in compiled function to return correctly.

Definition at line 51 of file buildinfo.h.

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ CircularBuffer_char

◆ CircularBuffer_double

◆ CircularBuffer_int

◆ CircularBuffer_Matrix_double

◆ CircularBuffer_Matrix_float

◆ CircularBuffer_pair_double_double

◆ CircularBuffer_pair_int_int

◆ CircularBuffer_short

◆ fitUserRec

Enumeration Type Documentation

◆ KMeansDistance

◆ KMeansEmptyAction

◆ KMeansStart

Function Documentation

◆ buildDateTime()

◆ buildHash()

◆ buildHashLong()

◆ dateTimeNow()

◆ dateToday()

◆ gitHash()

◆ gitHashLong()

◆ makeSpharaProjector()

◆ timeNowNow()