Click or drag to resize

HavriliakNegamiSusceptibility Class

Havriliak-Negami function to fit dielectric spectra.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.FitFunctions.RelaxationHavriliakNegamiSusceptibility

Namespace: Altaxo.Calc.FitFunctions.Relaxation
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
Copy
public class HavriliakNegamiSusceptibility : IFitFunction, 
	IImmutable

The HavriliakNegamiSusceptibility type exposes the following members.

Constructors
 NameDescription
Public methodHavriliakNegamiSusceptibility Initializes a new instance of the HavriliakNegamiSusceptibility class.
Top
Properties
 NameDescription
Public propertyInvertResult Gets or sets a value indicating whether the complex dependent variable (the output of the fit function) should be inverted.
Public propertyInvertViscosity Gets a value indicating whether the viscosity parameter is inverted so that a conductivity or fluidity term is used.
Public propertyIsRelativeDielectricPermittivity Gets a value indicating whether the function models the relative dielectric permittivity instead of a general susceptibility.
Public propertyLogarithmizeResults Indicates whether the real and imaginary part of the dependent variable should be logarithmized (decadic logarithm).
Public propertyNumberOfDependentVariables Number of dependent variables (i.e. y, in Altaxo this is commonly called v (like value)).
Public propertyNumberOfIndependentVariables Number of independent variables (i.e. x).
Public propertyNumberOfParameters Number of parameters of this fit function.
Public propertyNumberOfTerms Gets the number of Havriliak-Negami terms used by the model.
Public propertyUseFlowTerm Gets a value indicating whether to use a flow term.
Public propertyUseFrequencyInsteadOfOmega Gets a value indicating whether to use the frequency instead of omega.
Top
Methods
 NameDescription
Public methodStatic memberCreateDielectricFunctionOfFrequency Creates a dielectric Havriliak-Negami fit function that uses frequency as the independent variable.
Public methodStatic memberCreateDielectricFunctionOfOmega Creates a dielectric Havriliak-Negami fit function that uses omega as the independent variable.
Public methodStatic memberCreateGeneralFunctionOfFrequency Creates a general Havriliak-Negami susceptibility fit function that uses frequency as the independent variable.
Public methodStatic memberCreateGeneralFunctionOfOmega Creates a general Havriliak-Negami susceptibility fit function that uses omega as the independent variable.
Public methodStatic memberCreateModulusFunctionOfFrequency Creates a multi-term Havriliak-Negami modulus fit function that uses frequency as the independent variable.
Public methodStatic memberCreateModulusFunctionOfOmega Creates a multi-term Havriliak-Negami modulus fit function that uses omega as the independent variable.
Public methodDefaultParameterValue Returns a default parameter value. You must ensure that the fit function would generate values with those default parameters.
Public methodDefaultVarianceScaling Returns the default variance scaling for the dependent variable i.
Public methodDependentVariableName Returns the ith dependent variable name.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodEvaluate(Double, Double, Double) This evaluates a function value.
Public methodEvaluate(IROMatrixDouble, IReadOnlyListDouble, IVectorDouble, IReadOnlyListBoolean) Evaluates the function values at multiple x-points.
Public methodEvaluateGradient Evaluates the gradient of the model with respect to its parameters.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetParameterBoundariesHardLimit Gets the parameter boundaries that are really a hard limit, i.e. outside those limits, the function would probably evaluate NaN values, or makes no sense.
Public methodGetParameterBoundariesSoftLimit Gets the intended parameter boundaries. This are soft limits, boundaries so that the intended purpose of the fit function is fullfilled. Example: in the exponential decay Exp(-a*t) a is intended to be positive. This is a soft limit, and not a hard limit, because a could be also negative, and the fit nevertheless would succeed.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIndependentVariableName Returns the ith independent variable name.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParameterName Returns the ith parameter name.
Public methodToStringReturns a string that represents the current object.
(Overrides ObjectToString)
Public methodWithInvertResult Returns a new instance with the InvertResult property set to the specified value.
Public methodWithInvertViscosity Returns a new instance with the InvertViscosity property set to the specified value.
Public methodWithIsRelativeDielectricPermittivity Returns a new instance with the IsRelativeDielectricPermittivity property set to the specified value.
Public methodWithLogarithmizeResults Returns a new instance with the LogarithmizeResults property set to the specified value.
Public methodWithNumberOfTerms Returns a new instance with the NumberOfTerms property set to the specified value.
Public methodWithUseFlowTerm Returns a new instance with the UseFlowTerm property set to the specified value.
Public methodWithUseFrequencyInsteadOfOmega Returns a new instance with the UseFrequencyInsteadOfOmega property set to the specified value.
Top
Events
 NameDescription
Public eventChanged Not functional because instance is immutable.
Top
See Also