Click or drag to resize

ShiftGroupComplexCommonX Class

A collection of multiple x-y curves (see ShiftCurveT) that will finally form one master curve. Here, the real and imaginary part of the complex value have a common x-value.
Inheritance Hierarchy
SystemObject
  Altaxo.Science.Thermorheology.MasterCurvesShiftGroupBase
    Altaxo.Science.Thermorheology.MasterCurvesShiftGroupComplexCommonX

Namespace: Altaxo.Science.Thermorheology.MasterCurves
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public class ShiftGroupComplexCommonX : ShiftGroupBase, 
	IShiftGroup

The ShiftGroupComplexCommonX type exposes the following members.

Constructors
 NameDescription
Public methodShiftGroupComplexCommonX Initializes a new instance of the ShiftGroupDouble class.
Top
Properties
 NameDescription
Public propertyCount Gets the number of curves in this shift group.
Public propertyCreateInterpolationFunction Creates the fit function. Argument is the tuple consisting of X, Y, and optional YErr. Return value is a function that calculates y for a given x.
Public propertyFittingWeightImaginary Gets the fitting weight, a number number > 0.
Public propertyFittingWeightReal Gets the fitting weight, a number number > 0.
Public propertyLogarithmizeXForInterpolationLogarithmize x values before adding to the interpolation curve. (Only for interpolation).
(Inherited from ShiftGroupBase)
Public propertyLogarithmizeYForInterpolationLogarithmize y values before adding to the interpolation curve. (Only for interpolation).
(Inherited from ShiftGroupBase)
Public propertyNumberOfValueComponents Gets the number of value components. For a usual curve, the return value is 1. For a curve consisting of complex values, the return value is 2.
Public propertyParticipateInFitByFitWeight Gets a value indicating whether this group will participate in the fit, determined by the fit weight. When the fit weigth is zero, the return value is false. Otherwise, if the fit weight is positive, the group principally will participate in the fit, and the return value is true.
Public propertyXShiftBy Determines how to shift the x values: either by factor or by offset. Use offset if the original data are already logarithmized.
(Inherited from ShiftGroupBase)
Top
Methods
 NameDescription
Public methodAddCurveToInterpolation Adds the data of the curve with index idxCurve to the interpolation. If data for that curve are already present in the interpolation data, they are removed, and then added anew.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
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 methodGetCurveIndexWithMostVariation Gets the index of the curve in the given group with the most variation. The variation is determined by calculating the absolute slope, with applying the logarithmic transformations according to the interpolation settings in that group.
Public methodGetCurvePoints Gets the original curve points of the curve with the provided index.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetInterpolatedCurvePoints Gets interpolated curve points between the minimum x-value and the maximum x-value. Before calling this function, the interpolation has to be initialized, curves must be added to the interpolation, and then Interpolate must be called.
Public methodGetMeanAbsYDifference Gets the mean difference between the y column and the interpolation function, provided that the x column is shifted by a factor.
Public methodGetMeanSquaredYDifference 
Public methodGetMergedCurvePointsUsedForInterpolation Gets the merged curve points that were used for interpolation. Before calling this function, the interpolation has to be initialized, and curves must be added to the interpolation.
Public methodGetShiftedCurvePoints Gets the curve points of the shifted curve with with the provided index.
Public methodGetTrackedXMinimumMaximum Gets the tracked x minimum and x maximum values. For explanation, see TrackXMinimumMaximumOfMasterCurvePoints(Int32, Double, Boolean). The convention is, that when shifting by multiplication, the returned values are already logarithmized, whereas, if shifted by offset, the returned values are not logarithmized. That means that the possible shifts can always be calculated by subtraction.
(Inherited from ShiftGroupBase)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetXMinimumMaximumOfCurvePointsSuitableForInterpolation Gets the minimum and maximum of the x-values, taking into account different options and whether the y-values are valid.
(Overrides ShiftGroupBaseGetXMinimumMaximumOfCurvePointsSuitableForInterpolation(Int32))
Public methodGetXMinimumMaximumOfInterpolationValuesExceptForCurveIndex Gets the minimum and maximum of the current x-values used for interpolation. Data points that belong to the curve with the index given in the argument are not taken into account.
Public methodInitializeInterpolation Initializes the interpolation with initially no points in it.
Public methodInterpolate 
Public methodIsCurveSuitableForParticipatingInFit Determines whether the curve is suitable for participating in the fit. For instance, the curve must have at least two points.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTrackXMinimumMaximumOfMasterCurvePoints Tracks the x minimum and x maximum of the master curve points. Here the convention is, that when shifting by multiplication, the values are already logarithmized, whereas, if shifted by offset, the returned values are not logarithmized.
(Inherited from ShiftGroupBase)
Public methodTransformCurveForInterpolationAccordingToGroupOptions 
Top
Fields
 NameDescription
Protected field_curves The complex valued curves to be shifted.
Protected field_trackedXMaximum
(Inherited from ShiftGroupBase)
Protected field_trackedXMinimum
(Inherited from ShiftGroupBase)
Top
See Also