INVLIB::InvSignalModel Class Reference

Generates the forward sinusoidal model matrix for HPI coil signals at known drive frequencies. More...

#include <inv_signal_model.h>

Public Types
typedef QSharedPointer< InvSignalModel >	SPtr
typedef QSharedPointer< const InvSignalModel >	ConstSPtr

Public Member Functions
	InvSignalModel ()=default
Eigen::MatrixXd	fitData (const InvHpiModelParameters &hpiModelParameters, const Eigen::MatrixXd &matData)

Detailed Description

Generates the forward sinusoidal model matrix for HPI coil signals at known drive frequencies.

Description of what this class is intended to do (in detail).

Definition at line 73 of file inv_signal_model.h.

Member Typedef Documentation

ConstSPtr

typedef QSharedPointer<const InvSignalModel> INVLIB::InvSignalModel::ConstSPtr

Const shared pointer type for InvSignalModel.

Definition at line 78 of file inv_signal_model.h.

SPtr

typedef QSharedPointer<InvSignalModel> INVLIB::InvSignalModel::SPtr

Shared pointer type for InvSignalModel.

Definition at line 77 of file inv_signal_model.h.

Constructor & Destructor Documentation

InvSignalModel()

INVLIB::InvSignalModel::InvSignalModel ( )

explicitdefault

Constructs a InvSignalModel object.

Member Function Documentation

fitData()

MatrixXd InvSignalModel::fitData	(	const InvHpiModelParameters &	hpiModelParameters,
		const Eigen::MatrixXd &	matData )

Fit the data to the model constructed from given model parameters.

Parameters

[in]	hpiModelParameters	The InvHpiModelParameters.
[in]	matData	The data matrix.

Returns

the fitted data

Definition at line 71 of file inv_signal_model.cpp.

---

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

• src/libraries/inv/hpi/inv_signal_model.h
• src/libraries/inv/hpi/inv_signal_model.cpp