v2.0.0
Loading...
Searching...
No Matches
FWDLIB::ComputeFwd Class Reference

Forward solution computation worker. More...

#include <compute_fwd.h>

Public Member Functions

 ComputeFwd (std::shared_ptr< ComputeFwdSettings > pSettings)
virtual ~ComputeFwd ()
std::unique_ptr< MNELIB::MNEForwardSolutioncalculateFwd ()
bool updateHeadPos (const FIFFLIB::FiffCoordTrans &transDevHead, MNELIB::MNEForwardSolution &fwd)

Detailed Description

Forward solution computation worker.

Implements the forward solution computation.

ComputeFwd is a worker/factory that takes ComputeFwdSettings, initialises all required data structures (coil definitions, BEM model, source spaces, …) and performs the actual forward calculation. The computed MNEForwardSolution is returned by calculateFwd() and updateHeadPos().

Definition at line 104 of file compute_fwd.h.

Constructor & Destructor Documentation

◆ ComputeFwd()

ComputeFwd::ComputeFwd ( std::shared_ptr< ComputeFwdSettings > pSettings)
explicit

Constructs a ComputeFwd and initialises all data structures needed for the forward computation according to pSettings.

Parameters
[in]pSettingsShared pointer to the forward computation settings.

Definition at line 80 of file compute_fwd.cpp.

◆ ~ComputeFwd()

ComputeFwd::~ComputeFwd ( )
virtual

Destructor.

Definition at line 92 of file compute_fwd.cpp.

Member Function Documentation

◆ calculateFwd()

std::unique_ptr< MNEForwardSolution > ComputeFwd::calculateFwd ( )

Perform the forward calculation.

Returns
The computed forward solution, or nullptr on error.

Definition at line 532 of file compute_fwd.cpp.

◆ updateHeadPos()

bool ComputeFwd::updateHeadPos ( const FIFFLIB::FiffCoordTrans & transDevHead,
MNELIB::MNEForwardSolution & fwd )

Update the head position with a new device-to-head transform and recompute the MEG portion of the forward solution.

Parameters
[in]transDevHeadThe updated device-to-head coordinate transform.
[in,out]fwdThe forward solution to update in place.
Returns
True on success, false on error.

Definition at line 632 of file compute_fwd.cpp.


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