Types

Types used by eisgenerator . More...

Classes
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 > &data)
	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 the 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 the given spectra.

This function will be moved to the math API in the future.

Parameters

a	The first set of points.
b	The second set of points, must contain the same number of elements 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 function will be moved to the math API in the future.

This implementation is quite slow.

Parameters

a	The first set of points.
b	The 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 > &

data

)

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

Parameters

data	the data to transform to valarrays

Returns

A pair of valarrays, first the real part and second the imaginary part.