Geophysical Inversion and Modelling Library  v1.5.0
GIMLI::DataMap Class Reference
+ Collaboration diagram for GIMLI::DataMap:

Public Member Functions

 DataMap ()
 
 DataMap (const std::string &filename)
 
 DataMap (const DataMap &map)
 
DataMapoperator= (const DataMap &map)
 
bool isComplex () const
 
int save (const std::string &filename)
 
int load (const std::string &filename)
 
void collect (const std::vector< ElectrodeShape * > &electrodes, const RMatrix &sol, bool isCEM=false)
 
RVector data (const DataContainerERT &dat, bool reciprocity=false, bool imag=false)
 
void setElectrodes (const std::vector< RVector3 > &elecs)
 
const std::vector< RVector3 > & electrodes () const
 
const RMatrixmap () const
 

Protected Member Functions

void copy_ (const DataMap &map)
 

Protected Attributes

std::vector< RVector3elecs_
 
RMatrix map_
 
bool complex_
 

Detailed Description

Potential matrix for BERT. Stores the potential values for every current injection at every electrode positions. Filtering a specific data configuration is done by the data call. In generall, the map size is equal to the amount of electrodes. There are exceptions: Dipol-Pattern sources, Dipol-Sources against a reference Electrode.

Constructor & Destructor Documentation

◆ DataMap() [1/3]

GIMLI::DataMap::DataMap ( )

Default contructor, builds an empty map

◆ DataMap() [2/3]

GIMLI::DataMap::DataMap ( const std::string &  filename)

Contructs a map and load content from a file

References load().

◆ DataMap() [3/3]

GIMLI::DataMap::DataMap ( const DataMap map)

Copyconstructor

References copy_().

Member Function Documentation

◆ collect()

void GIMLI::DataMap::collect ( const std::vector< ElectrodeShape * > &  electrodes,
const RMatrix sol,
bool  isCEM = false 
)

Fill the map. Collect potential values from complete mesh related solution matrix and a vector of assiciated electrodes.

References GIMLI::Matrix< ValueType >::clear(), GIMLI::Matrix< ValueType >::cols(), elecs_, electrodes(), map_, GIMLI::Matrix< ValueType >::push_back(), and GIMLI::Matrix< ValueType >::rows().

Referenced by GIMLI::DCMultiElectrodeModelling::calculate().

◆ copy_()

void GIMLI::DataMap::copy_ ( const DataMap map)
protected

Internal copy function

References elecs_, map(), and map_.

Referenced by DataMap(), and operator=().

◆ data()

RVector GIMLI::DataMap::data ( const DataContainerERT dat,
bool  reciprocity = false,
bool  imag = false 
)

Returns RVector of power values corresponding to the DataConatiner, Return reciprocity values if reciprocity set to True. In the case of reciprocity, a <-> m and b <-> n are swapped.

** probably measured agains last electrode as current and power reference

References GIMLI::Matrix< ValueType >::cols(), elecs_, map_, and GIMLI::Matrix< ValueType >::rows().

Referenced by GIMLI::DCMultiElectrodeModelling::response().

◆ electrodes()

const std::vector< RVector3 >& GIMLI::DataMap::electrodes ( ) const
inline

Return a reference to the electrode positions

Referenced by collect().

◆ isComplex()

bool GIMLI::DataMap::isComplex ( ) const
inline

Complex valued entries.

◆ load()

int GIMLI::DataMap::load ( const std::string &  filename)

Load a collect matrix

References elecs_, map_, and GIMLI::Matrix< ValueType >::push_back().

Referenced by DataMap().

◆ map()

const RMatrix& GIMLI::DataMap::map ( ) const
inline

Return a reference to the potential matrix

Referenced by copy_(), and operator=().

◆ operator=()

DataMap & GIMLI::DataMap::operator= ( const DataMap map)

Assignment operator

References copy_(), and map().

◆ save()

int GIMLI::DataMap::save ( const std::string &  filename)

Save the collect matrix

References elecs_, map_, GIMLI::Matrix< ValueType >::rows(), and GIMLI::MatrixBase::size().

◆ setElectrodes()

void GIMLI::DataMap::setElectrodes ( const std::vector< RVector3 > &  elecs)
inline

Set the electrode positions

Member Data Documentation

◆ elecs_

std::vector< RVector3 > GIMLI::DataMap::elecs_
protected

Hold electrode positions

Referenced by collect(), copy_(), data(), load(), and save().

◆ map_

RMatrix GIMLI::DataMap::map_
protected

Hold potential map

Referenced by collect(), copy_(), data(), load(), and save().