Averaging declarations. More...

#include "rtprocessing_global.h"
#include <fiff/fiff_evoked.h>
#include <QObject>
#include <Eigen/Core>

Include dependency graph for averaging.h:

This graph shows which files directly or indirectly include this file:

Functions
RTPROCESINGSHARED_EXPORT FIFFLIB::FiffEvoked	RTPROCESSINGLIB::computeAverage (const FIFFLIB::FiffRawData &raw, const Eigen::MatrixXi &matEvents, float fTMinS, float fTMaxS, qint32 eventType, bool bApplyBaseline, float fTBaselineFromS, float fTBaselineToS, const QMap< QString, double > &mapReject, const QStringList &lExcludeChs=QStringList(), const Eigen::RowVectorXi &vecPicks=Eigen::RowVectorXi())

RTPROCESINGSHARED_EXPORT FIFFLIB::FiffEvoked	RTPROCESSINGLIB::computeFilteredAverage (const FIFFLIB::FiffRawData &raw, const Eigen::MatrixXi &matEvents, float fTMinS, float fTMaxS, qint32 eventType, bool bApplyBaseline, float fTBaselineFromS, float fTBaselineToS, const QMap< QString, double > &mapReject, const FilterKernel &filterKernel, const QStringList &lExcludeChs=QStringList(), const Eigen::RowVectorXi &vecPicks=Eigen::RowVectorXi())

Detailed Description

Averaging declarations.

Author: Lorenz Esch lesch.nosp@m.@mgh.nosp@m..harv.nosp@m.ard..nosp@m.edu

Since: 0.1.3

Date: June, 2020

LICENSE

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of MNE-CPP authors nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file averaging.h.

Function Documentation

◆ computeAverage()

RTPROCESINGSHARED_EXPORT FIFFLIB::FiffEvoked RTPROCESSINGLIB::computeAverage	(	const FIFFLIB::FiffRawData &	raw,
		const Eigen::MatrixXi &	matEvents,
		float	fTMinS,
		float	fTMaxS,
		qint32	eventType,
		bool	bApplyBaseline,
		float	fTBaselineFromS,
		float	fTBaselineToS,
		const QMap< QString, double > &	mapReject,
		const QStringList &	lExcludeChs = `QStringList()`,
		const Eigen::RowVectorXi &	vecPicks = `Eigen::RowVectorXi()`
	)

Computes the average for given fiff raw data.

Parameters

[in]	raw	The raw data.
[in]	matEvents	The events provided in samples and event kinds.
[in]	fTMinS	The start time relative to the event in seconds.
[in]	fTMaxS	The end time relative to the event in seconds.
[in]	eventType	The event type.
[in]	bApplyBaseline	Whether to use baseline correction (mode=mean).
[in]	fTBaselineFromS	The start baseline correction time relative to the event in seconds.
[in]	fTBaselineToS	The end baseline correction time relative to the event in seconds.
[in]	mapReject	The thresholds per channel type to reject epochs.
[in]	lExcludeChs	List of channel names to exclude.
[in]	vecPicks	Which channels to pick.

◆ computeFilteredAverage()

RTPROCESINGSHARED_EXPORT FIFFLIB::FiffEvoked RTPROCESSINGLIB::computeFilteredAverage	(	const FIFFLIB::FiffRawData &	raw,
		const Eigen::MatrixXi &	matEvents,
		float	fTMinS,
		float	fTMaxS,
		qint32	eventType,
		bool	bApplyBaseline,
		float	fTBaselineFromS,
		float	fTBaselineToS,
		const QMap< QString, double > &	mapReject,
		const FilterKernel &	filterKernel,
		const QStringList &	lExcludeChs = `QStringList()`,
		const Eigen::RowVectorXi &	vecPicks = `Eigen::RowVectorXi()`
	)

Computes the filtered average for given fiff raw data.