v2.0.0
Loading...
Searching...
No Matches
INVERSELIB::SignalModel Class Reference

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

#include <signalmodel.h>

Public Types

typedef QSharedPointer< SignalModelSPtr
typedef QSharedPointer< const SignalModelConstSPtr

Public Member Functions

 SignalModel ()=default
Eigen::MatrixXd fitData (const HpiModelParameters &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 signalmodel.h.

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const SignalModel> INVERSELIB::SignalModel::ConstSPtr

Const shared pointer type for SignalModel.

Definition at line 78 of file signalmodel.h.

◆ SPtr

typedef QSharedPointer<SignalModel> INVERSELIB::SignalModel::SPtr

Shared pointer type for SignalModel.

Definition at line 77 of file signalmodel.h.

Constructor & Destructor Documentation

◆ SignalModel()

INVERSELIB::SignalModel::SignalModel ( )
explicitdefault

Constructs a SignalModel object.

Member Function Documentation

◆ fitData()

MatrixXd SignalModel::fitData ( const HpiModelParameters & hpiModelParameters,
const Eigen::MatrixXd & matData )

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

Parameters
[in]hpiModelParametersThe HpiModelParameters.
[in]matDataThe data matrix.
Returns
the fitted data

Definition at line 71 of file signalmodel.cpp.


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