Click or drag to resize

PronySeriesInterpolationBase Class

Base class of the options for Prony series interpolation, both in the time domain as well as in the frequency domain.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.InterpolationPronySeriesInterpolationBase
    More

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

The PronySeriesInterpolationBase type exposes the following members.

Constructors
 NameDescription
Public methodPronySeriesInterpolationBaseInitializes a new instance of the PronySeriesInterpolationBase class
Top
Properties
 NameDescription
Public propertyAllowNegativePronyCoefficients If true, also negative Prony coefficients are allowed. The default value is false.
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.
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.
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.
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.
Public propertyUseIntercept If true, besides of the Prony terms, additionally an intercept is fitted to the data.
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!).
Top
Methods
 NameDescription
Protected methodDeserializeV0 Deserializes the legacy V0 schema and returns a new options record populated with the loaded data.
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.
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.
Protected methodSerializeV0 Serializes the current options set by using the legacy V0 schema.
Public methodWithAutomaticXMinimumMaximumAndFixedNumberOfPoints Creates a copy with automatically determined x-range and a fixed number of Prony terms.
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.
Public methodWithSpecifiedXMinimumMaximumAndFixedNumberOfPoints Creates a copy with a manually specified x-range and a fixed number of Prony terms.
Top
See Also
Inheritance Hierarchy