sphara.h File Reference

Declaration of the Sphara class. More...

#include "rtprocessing_global.h"
#include <Eigen/Core>

Include dependency graph for sphara.h:

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

Go to the source code of this file.

Functions
RTPROCESINGSHARED_EXPORT Eigen::MatrixXd	RTPROCESSINGLIB::makeSpharaProjector (const Eigen::MatrixXd &matBaseFct, const Eigen::VectorXi &vecIndices, int iOperatorDim, int iNBaseFct, int iSkip=0)

Detailed Description

Declaration of the Sphara class.

Author

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

Since

0.1.0

Date

February, 2016

LICENSE

Copyright (C) 2016, Lorenz Esch. All rights reserved.

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 sphara.h.

Function Documentation

makeSpharaProjector()

RTPROCESINGSHARED_EXPORT Eigen::MatrixXd RTPROCESSINGLIB::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).