MNE-CPP: INVLIB::InvHpiModelParameters Class Reference

v2.0.0

Loading...

Searching...

No Matches

Configuration parameters for the HPI signal model (line frequency, coil frequencies, sample rate, buffer size). More...

#include <inv_hpi_model_parameters.h>

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

Public Member Functions
	InvHpiModelParameters ()=default
	InvHpiModelParameters (const QVector< int > vecHpiFreqs, const int iSampleFreq, const int iLineFreq, const bool bBasic)
	InvHpiModelParameters (const InvHpiModelParameters &hpiModelParameter)
InvHpiModelParameters	operator= (const InvHpiModelParameters &other)
bool	operator== (const InvHpiModelParameters &b) const
bool	operator!= (const InvHpiModelParameters &b) const
QVector< int >	vecHpiFreqs () const
int	iNHpiCoils () const
int	iSampleFreq () const
int	iLineFreq () const
bool	bBasic () const

Detailed Description

Configuration parameters for the HPI signal model (line frequency, coil frequencies, sample rate, buffer size).

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

Definition at line 75 of file inv_hpi_model_parameters.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for InvHpiModelParameters.

Definition at line 79 of file inv_hpi_model_parameters.h.

◆ SPtr

typedef QSharedPointer<InvHpiModelParameters> INVLIB::InvHpiModelParameters::SPtr

Shared pointer type for InvHpiModelParameters.

Definition at line 78 of file inv_hpi_model_parameters.h.

Constructor & Destructor Documentation

◆ InvHpiModelParameters() [1/3]

INVLIB::InvHpiModelParameters::InvHpiModelParameters ( )

default

Defaul Constructor.

◆ InvHpiModelParameters() [2/3]

InvHpiModelParameters::InvHpiModelParameters	(	const QVector< int >	vecHpiFreqs,
		const int	iSampleFreq,
		const int	iLineFreq,
		const bool	bBasic )

explicit

Constructs a InvHpiModelParameters object.

Parameters

[in]	vecHpiFreqs	The Hpi frequencies.
[in]	iSampleFreq	The sampling frequency.
[in]	iLineFreq	The line Frequency
[in]	bBasic	Create a basic model without line frequeny or not.

Definition at line 64 of file inv_hpi_model_parameters.cpp.

◆ InvHpiModelParameters() [3/3]

InvHpiModelParameters::InvHpiModelParameters ( const InvHpiModelParameters & hpiModelParameter )

Copy constructor.

Parameters

[in] hpiModelParameter InvHpiModelParameters which should be copied.

Definition at line 79 of file inv_hpi_model_parameters.cpp.

Member Function Documentation

◆ bBasic()

bool INVLIB::InvHpiModelParameters::bBasic ( ) const

inline

Definition at line 178 of file inv_hpi_model_parameters.h.

◆ iLineFreq()

int INVLIB::InvHpiModelParameters::iLineFreq ( ) const

inline

Definition at line 171 of file inv_hpi_model_parameters.h.

◆ iNHpiCoils()

int INVLIB::InvHpiModelParameters::iNHpiCoils ( ) const

inline

Definition at line 157 of file inv_hpi_model_parameters.h.

◆ iSampleFreq()

int INVLIB::InvHpiModelParameters::iSampleFreq ( ) const

inline

Definition at line 164 of file inv_hpi_model_parameters.h.

◆ operator!=()

bool INVLIB::InvHpiModelParameters::operator!= ( const InvHpiModelParameters & b ) const

inline

Definition at line 196 of file inv_hpi_model_parameters.h.

◆ operator=()

InvHpiModelParameters InvHpiModelParameters::operator= ( const InvHpiModelParameters & other )

Definition at line 104 of file inv_hpi_model_parameters.cpp.

◆ operator==()

bool INVLIB::InvHpiModelParameters::operator== ( const InvHpiModelParameters & b ) const

inline

Definition at line 185 of file inv_hpi_model_parameters.h.

◆ vecHpiFreqs()

QVector< int > INVLIB::InvHpiModelParameters::vecHpiFreqs ( ) const

inline

Inline functions to get acces to parameters.

Definition at line 150 of file inv_hpi_model_parameters.h.

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

src/libraries/inv/hpi/inv_hpi_model_parameters.h
src/libraries/inv/hpi/inv_hpi_model_parameters.cpp