eisgenerator API

API for use with eisgenerator applications . More...

Functions
std::vector< fvalue >	calcDrt (const std::vector< eis::DataPoint > &data, const std::vector< fvalue > &omegaVector, FitMetrics &fm, const FitParameters &fp, fvalue *rSeries=nullptr)
	Calculates a drt on eisgenerator types.
std::vector< fvalue >	calcDrt (const std::vector< eis::DataPoint > &data, FitMetrics &fm, const FitParameters &fp, fvalue *rSeries=nullptr)
	Calculates a drt on eisgenerator types.
std::vector< eis::DataPoint >	calcImpedance (const std::vector< fvalue > &drt, fvalue rSeries, const std::vector< fvalue > &omegaVector)
	Calculate impedance from drt using eisgenerator datatypes.
std::vector< eis::DataPoint >	calcImpedance (const std::vector< fvalue > &drt, fvalue rSeries, const eis::Range &omegaRange)
	Calculates impedance from drt using eisgenerator datatypes.

Detailed Description

API for use with eisgenerator applications .

Calculates drts with eisgenerator datatypes.

Function Documentation

calcDrt() [1/2]

std::vector< fvalue > calcDrt	(	const std::vector< eis::DataPoint > &	data,
		const std::vector< fvalue > &	omegaVector,
		FitMetrics &	fm,
		const FitParameters &	fp,
		fvalue *	rSeries = nullptr )

Calculates a drt on eisgenerator types.

Parameters

data	A vector of eisgenerator data points with the values to your experiment, embedded omega values are ignored.
omegaVector	A vector with the omega values that the impedances where measured at.
fm	A fit metrics struct where this function returns information on the fit acquired.
fp	A struct with fit parameters.
rSeries	An optional parameter where the series resistance is stored.

Returns

A vector with the drt values.

calcDrt() [2/2]

std::vector< fvalue > calcDrt	(	const std::vector< eis::DataPoint > &	data,
		FitMetrics &	fm,
		const FitParameters &	fp,
		fvalue *	rSeries = nullptr )

Calculates a drt on eisgenerator types.

Parameters

data	A vector of eisgenerator data points with the values to your experiment, embedded omega values are used.
fm	A fit metrics struct where this function returns information on the fit acquired.
fp	A struct with fit parameters.
rSeries	An optional parameter where the series resistance is stored.

Returns

A vector with the drt values.

calcImpedance() [1/2]

std::vector< eis::DataPoint > calcImpedance	(	const std::vector< fvalue > &	drt,
		fvalue	rSeries,
		const eis::Range &	omegaRange )

Calculates impedance from drt using eisgenerator datatypes.

Parameters

drt	The drt to calculate impedance from.
omegaRange	A range that describes the omega values the drt was taken at.
rSeries	A parameter giving the series resistance.

Returns

A vector with the impedance values.

calcImpedance() [2/2]

std::vector< eis::DataPoint > calcImpedance	(	const std::vector< fvalue > &	drt,
		fvalue	rSeries,
		const std::vector< fvalue > &	omegaVector )

Calculate impedance from drt using eisgenerator datatypes.

Parameters

drt	The drt to calculate impedance from.
omegaVector	A vector with the omega values that the impedances where measured at.
rSeries	A parameter giving the series resistance.

Returns

A vector with the impedance values.