Click or drag to resize

PronySeriesFrequencyDomainComplexInterpolation Class

Interpolation with a sum of Prony terms of a complex relaxation or retardation function in the frequency domain.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.InterpolationPronySeriesInterpolationBase
    Altaxo.Calc.InterpolationPronySeriesFrequencyDomainComplexInterpolation

Namespace: Altaxo.Calc.Interpolation
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)
Syntax
C#
Copy
public class PronySeriesFrequencyDomainComplexInterpolation : PronySeriesInterpolationBase, 
	IComplexInterpolation, IEquatable<PronySeriesFrequencyDomainComplexInterpolation>

The PronySeriesFrequencyDomainComplexInterpolation type exposes the following members.

Constructors
 NameDescription
Public methodPronySeriesFrequencyDomainComplexInterpolationInitializes a new instance of the PronySeriesFrequencyDomainComplexInterpolation class
Top
Properties
 NameDescription
Public propertyAllowNegativePronyCoefficients If true, also negative Prony coefficients are allowed. The default value is false.
(Inherited from PronySeriesInterpolationBase)
Public propertyIsRelaxation If true, the Prony terms model a relaxation process, i.e. a modulus, where the real part increases with frequency. If false, the Prony terms model a retardation process, i.e. a susceptibility, where the real part decreases with frequency.
(Inherited from PronySeriesInterpolationBase)
Public propertyIsSupportingSeparateXForRealAndImaginaryPart Gets a value indicating whether this instance supports independent real and imaginary sample sets.
Public propertyNumberOfPoints If PointsPerDecade is 0, this property specifies a fixed number of Prony terms. Else, if PointsPerDecade is > 0, this property specifies the maximum number of Prony terms.
(Inherited from PronySeriesInterpolationBase)
Public propertyPointsPerDecade Gets the number of Prony terms per decade. If this value is <= 0, the property NumberOfPoints specifies a fixed number of Prony terms. Else, if this property is > 0, it specifies the number of Prony terms per decade, and NumberOfPoints only specifies the maximum number of Prony terms.
(Inherited from PronySeriesInterpolationBase)
Public propertyRegularizationParameter Gets or sets the regularization parameter that controls the smoothing of the resulting curve. The higher the parameter, the smoother the resulting curve will be.
(Inherited from PronySeriesInterpolationBase)
Public propertyUseIntercept If true, besides of the Prony terms, additionally an intercept is fitted to the data.
(Inherited from PronySeriesInterpolationBase)
Public propertyXMinimumMaximum Gets the minimum and maximum x values to be used. If this property is null, then the minimum and maximum x is determined automatically. In time domain, the x values are times. In frequency domain, the x values are frequencies (frequencies, not circular frequencies!).
(Inherited from PronySeriesInterpolationBase)
Top
Methods
 NameDescription
Protected methodDeserializeV0 Deserializes the legacy V0 schema and returns a new options record populated with the loaded data.
(Inherited from PronySeriesInterpolationBase)
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 methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodGetWorkingXMinMaxNumberOfPoints Determines the working x-range and number of points based on either user-specified bounds or the data.
(Inherited from PronySeriesInterpolationBase)
Public methodInterpolate(IReadOnlyListDouble, IReadOnlyListDouble, IReadOnlyListDouble) Sets the interpolation data by providing values for x and y. Both vectors must be of equal length.
Public methodInterpolate(IReadOnlyListDouble, IReadOnlyListComplex, IReadOnlyListComplex) Sets the interpolation data by providing values for x and y. Both vectors must be of equal length.
Public methodInterpolate(IReadOnlyListDouble, IReadOnlyListDouble, IReadOnlyListDouble, IReadOnlyListDouble) Sets the interpolation data by providing values for xreal and yreal (both of the same length), as well as for ximag and yimag (both also of the same length, though the length can differ from the real pair).
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodRetardationWithAutomaticXMinimumMaximumAndNumberOfPointsPerDecade Creates a copy configured for retardation with automatically detected x-range and a given number of Prony terms per decade.
(Inherited from PronySeriesInterpolationBase)
Protected methodSerializeV0 Serializes the current options set by using the legacy V0 schema.
(Inherited from PronySeriesInterpolationBase)
Public methodWithAutomaticXMinimumMaximumAndFixedNumberOfPoints Creates a copy with automatically determined x-range and a fixed number of Prony terms.
(Inherited from PronySeriesInterpolationBase)
Public methodWithAutomaticXMinimumMaximumAndNumberOfPointsPerDecadeAndMaximumNumberOfPoints Creates a copy with automatically determined x-range, a user-specified number of points per decade, and a maximum number of Prony terms.
(Inherited from PronySeriesInterpolationBase)
Public methodWithSpecifiedXMinimumMaximumAndFixedNumberOfPoints Creates a copy with a manually specified x-range and a fixed number of Prony terms.
(Inherited from PronySeriesInterpolationBase)
Top
Remarks
Note that for a relaxation the real part is increasing with frequency (e.g. complex mechanical modulus), whereas for a retardation the real part is decreasing with frequency (e.g. complex electrical permittivity). We assume here that even for a retardation the imaginary part is positive: eps* = eps' - i eps''.
See Also