eisgenerator 1.0.x
Data Structures | Functions
Types

Types used by eisgenerator. More...

Data Structures

class  eis::DataPoint
 Basic singular EIS data point. More...
 
class  eis::Range
 A range. More...
 
class  eis::parse_errror
 
class  eis::file_error
 
class  eis::EisSpectra
 

Functions

bool eis::saveToDisk (const EisSpectra &data, const std::filesystem::path &path)
 deprecated function use eis::EisSpectra::saveToDisk instead
 
EisSpectra eis::loadFromDisk (const std::filesystem::path &path)
 deprecated function use eis::EisSpectra::loadFromDisk instead
 
std::pair< std::valarray< fvalue >, std::valarray< fvalue > > eis::eisToValarrays (const std::vector< eis::DataPoint > &b)
 Returns the a vector of DataPoints as a pair of valarrays.
 
fvalue eis::eisDistance (const std::vector< eis::DataPoint > &a, const std::vector< eis::DataPoint > &b)
 Returns the mean l2 element wise distance of he given spectra.
 
fvalue eis::eisNyquistDistance (const std::vector< eis::DataPoint > &a, const std::vector< eis::DataPoint > &b)
 Returns the mean distance of the points in a to the linearly interpolated nyquist curve of b.
 

Detailed Description

Types used by eisgenerator.

Function Documentation

◆ eisDistance()

fvalue eis::eisDistance ( const std::vector< eis::DataPoint > &  a,
const std::vector< eis::DataPoint > &  b 
)

Returns the mean l2 element wise distance of he given spectra.

Parameters
athe first set of points
bthe second set of points, must be the same length as a
Returns
the mean l2 distance

◆ eisNyquistDistance()

fvalue eis::eisNyquistDistance ( const std::vector< eis::DataPoint > &  a,
const std::vector< eis::DataPoint > &  b 
)

Returns the mean distance of the points in a to the linearly interpolated nyquist curve of b.

This implementation is quite slow

Parameters
athe first set of points
bthe second set of points
Returns
the mean nyquist distance

◆ eisToValarrays()

std::pair< std::valarray< fvalue >, std::valarray< fvalue > > eis::eisToValarrays ( const std::vector< eis::DataPoint > &  b)

Returns the a vector of DataPoints as a pair of valarrays.

Returns
a pair of valarrays first the real part and second the imaginary part