eisgenerator 2.1.x
eis Namespace Reference

eisgenerator Copyright (C) 2021 Carl Klemm More...

Classes

class  Cap
 Ideal capacitor, model character c. More...
class  Componant
class  Cpe
 Constant phase element, model character p. More...
class  Inductor
 Ideal inductor, model character l. More...
class  Log
class  Model
 The main class of eisgenerator representing an equivalent circuit model. More...
class  Parallel
class  ParallelSerial
struct  ParameterPermutation
 One assignment of a model's parameters that yields the same spectrum as the assignment it was derived from. More...
class  Resistor
 Ideal resistor, model character r. More...
class  Serial
class  TransmissionLineClosed
 Transmission line with a closed (insulated, reflecting) end, model character t. More...
class  TransmissionLineOpen
 Transmission line with an open (reflecting) end, model character o. More...
class  Warburg
 Warburg element (semi-infinite linear diffusion), model character w. More...

Functions

void mulitplyAdd (std::vector< eis::DataPoint > &data, fvalue mult, fvalue add)
std::complex< fvalue > absGrad (const std::vector< eis::DataPoint > &data, size_t index)
 Calculates the element wise absolute gradient at the given point of the data given.
fvalue grad (const std::vector< fvalue > &data, const std::vector< fvalue > &omega, size_t index)
 Calculates derivative at the given point of the data given.
std::complex< fvalue > grad (const std::vector< eis::DataPoint > &data, size_t index)
 Calculates the gradient at the given point of the data given.
fvalue mean (const std::vector< fvalue > &data)
 Calculates the mean of the given data.
std::complex< fvalue > mean (const std::vector< eis::DataPoint > &data)
 Calculates the mean of the given data.
fvalue median (std::vector< fvalue > data)
 Calculates the median of the given data.
std::complex< fvalue > median (const std::vector< eis::DataPoint > &data)
 Calculates the median of the given data.
void difference (std::vector< eis::DataPoint > &a, const std::vector< eis::DataPoint > &b)
 Calculates the difference between two spectra.
std::vector< eis::DataPoint > rescale (const std::vector< eis::DataPoint > &data, size_t outputSize)
 Resamples the data to the given amount of points.
fvalue pearsonCorrelation (const std::vector< eis::DataPoint > &data)
 Calculates the Pearson correlation between the imaginary and the real part of the data.
fvalue nonConstantScore (const std::vector< eis::DataPoint > &data)
fvalue nyquistAreaVariance (const std::vector< eis::DataPoint > &data, eis::DataPoint *centroid=nullptr)
 Calculates the variance of the distance of the data from a centroid in the nyquist plane.
fvalue maximumNyquistJump (const std::vector< eis::DataPoint > &data)
 Finds the maximum distance between subsequent points in the data in the nyquist plane.
void noise (std::vector< eis::DataPoint > &data, double amplitude, bool relative)
 Adds white noise to the data.
void removeDuplicates (std::vector< eis::DataPoint > &data)
 Removes duplicate data points from the data.
bool fvalueEq (fvalue a, fvalue b, unsigned int ulp=4)
 Checks two fvalues for equality.
std::vector< eis::DataPoint > fitToFrequencies (std::vector< fvalue > omegas, const std::vector< eis::DataPoint > &data, bool linearExtrapolation=false)
 This function resamples, extrapolates and interpolates to fit the data given to the frequencies also given.
fvalue 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 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.
void normalize (std::vector< eis::DataPoint > &data)
 Normalizes the data to [0,1].
std::vector< eis::DataPoint > reduceRegion (const std::vector< eis::DataPoint > &data, fvalue gradThreshFactor=0.01, bool useSecondDeiv=false)
 Reduces the data by removing "uninteresting" regions.
void eraseSingularites (std::vector< eis::DataPoint > &data)
 Removes INF and NAN from the dataset by interpolating from neighboring points.
std::string relaxisToEis (const std::string &in, const std::vector< double > &params=std::vector< double >())
 Translates a model string for RHD instruments RelaxIS to the format used by eisgenerator,.
std::string eisToRelaxis (const std::string &in)
 Translates a string for this library to the format used by RHD instruments RelaxIS.
std::string cdcToEis (std::string in)
 Translates a Boukamp Circuit Description Code (CDC) string into the format used by this library.
std::string eisToCdc (const std::string &in)
 Translates a string for this library a Boukamp Circuit Description Code (CDC).
std::string madapToEis (const std::string &in, const std::string &parameters="")
 Translates a model description string as used by the MADAP library into the format used by this library.
std::string eisToMadap (std::string in)
 Translates a string for this library a into the format used by the MADAP library.
void purgeEisParamBrackets (std::string &in)
 Given a eisgenerator model description string, this function will purge all the embedded parameters.

Detailed Description

eisgenerator Copyright (C) 2021 Carl Klemm

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.