Click or drag to resize

ShiftGroupCollection Class

A set of IShiftGroups. The curves in these collections will be shifted with a common set of shift factors. For example, for complex data to be shifted, there will be a ShiftGroupComplexCommonX.
Inheritance Hierarchy
SystemObject
  Altaxo.Science.Thermorheology.MasterCurvesShiftGroupCollection

Namespace: Altaxo.Science.Thermorheology.MasterCurves
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
Copy
public class ShiftGroupCollection : IReadOnlyList<IShiftGroup>, 
	IReadOnlyCollection<IShiftGroup>, IEnumerable<IShiftGroup>, IEnumerable

The ShiftGroupCollection type exposes the following members.

Constructors
 NameDescription
Public methodShiftGroupCollection Initializes a new instance of the ShiftGroupCollection class.
Top
Properties
 NameDescription
Public propertyCountGets the number of elements in the collection.
Public propertyCurvesParticipatingInFit Contains the indices of the curves that participate in the fit. Contains the same information as _isCurveParticipatingInFit, but more convienient for foreach.. statements
Public propertyGroupsParticipatingInFit Contains the indices of the groups that participate in the fit. Contains the same information as _isGroupParticipatingInFit, but more convienient for foreach.. statements
Public propertyIsCurveParticipatingInFit If the element is true, the curve(s) with that curve index participate in the fit; otherwise, the element is false.
Public propertyIsShiftValueRestrictedByBoundaries Element is true if the shift value of the respective curve is not at its optimum, but is restricted by the boundaries given by the RequiredRelativeOverlap.
Public propertyItemGets the element at the specified index in the read-only list.
Public propertyMaximumNumberOfCurves 
Public propertyNumberOfIterations Gets or sets the number of iterations. Must be greater than or equal to 1. This number determines how many rounds the master curve is fitted. Increasing this value will in most cases increase the quality of the fit.
Public propertyOptimizationMethod Determines the method to best fit the data into the master curve.
Public propertyRequiredRelativeOverlap Gets/sets the required relative overlap. The default value is 0, which means that a curve part only needs to touch the rest of the master curve. Setting this to a value, for instance to 0.1, means that a curve part needs an overlapping of 10% (of its x-range) with the rest of the master curve. This value can also be set to negative values. For instance, setting it to -1 means that a curve part could be in 100% distance (of its x-range) to the rest of the master curve.
Public propertyShiftErrors Gets the shift errors.
Public propertyShiftOrder 
Public propertyShiftValues Resulting list of shift offsets or ln(shiftfactors).
Top
Methods
 NameDescription
Public methodClampPivotIndexCandidateToAvailablePivots Uses the pivot index candidate and looks for the next possible pivot index around this candidate index.
Public methodCreateMasterCurve Creates one or multiple master curve(s).
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodEvaluateParticipatingCurvesAndGroups 
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 methodGetEnumeratorReturns an enumerator that iterates through the collection.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetShiftOffset Gets the shift offset. After creation of the master curve using the low level interface, the entire curve can be shifted, so that the value shift=0 is at another point. The point is determined by the options.
Public methodGetTrackedXMinimumMaximum Gets the tracked x minimum and x maximum values. For explanation, see TrackXMinimumMaximumOfMasterCurvePoints(Int32, Double, Boolean).
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIterate Performs iteration to create or refine the master curve. There must already exist an interpolation for each curve group (which at the first iteration consist only of the interpolation of the reference curve(s)).
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodReInitializeResult Reinitializes the result. With that, new options can be used, for instance a new interpolation function. Typically, after calling this, you can call Iterate(IReadOnlyListInt32, CancellationToken, IProgressDouble) to iterate with the new interpolation function again.
Public methodReinterpolateAllGroups Reinterpolates the master curves in all groups, using the current shift values. This call will also interpolate the curves in thoses groups, which do not participate in the master curve fitting.
Public methodReIterate Reinitializes the result (see ReInitializeResult) and then iterate anew with Iterate(IReadOnlyListInt32, CancellationToken, IProgressDouble).
Public methodSetShiftOffset Offsets the shift values (ShiftValues) by the provided value.
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 (independently of the interpolation points, for each iteration only those curves which were already considered).
Top
Fields
Extension Methods
 NameDescription
Public Extension MethodElementsAtIShiftGroup
(Defined by VectorMath)
Public Extension MethodElementsWhereIShiftGroup
(Defined by VectorMath)
Public Extension MethodElementsWhereIShiftGroup
(Defined by VectorMath)
Public Extension MethodFirstOrIShiftGroup Returns the first value of the enumeration, or, if the enumeration is empty, the other value provided in the arguments.
(Defined by EnumerableExtensions)
Public Extension MethodFlattenFromRootToLeavesIShiftGroup Converts a recursive data structure into a flat list. The root element is enumerated before its corresponding child element(s).
(Defined by EnumerableExtensions)
Public Extension MethodForEachDoIShiftGroup Executes an action for each element of the sequence.
(Defined by EnumerableExtensions)
Public Extension MethodGetPossibleStepsToMoveTowardsHigherIndicesIShiftGroup Return the number of steps that selected items can be moved towards higher indices. The selected item with the highest index determines that value.
(Defined by ListExtensions)
Public Extension MethodGetPossibleStepsToMoveTowardsLowerIndicesIShiftGroup Return the number of steps that selected items can be moved towards lower indices. The selected item with the lowest index determines that value.
(Defined by ListExtensions)
Public Extension MethodHasSingleElementIShiftGroup Determines whether the specified enumeration has exactly one element.
(Defined by EnumerableExtensions)
Public Extension MethodIndexOfIShiftGroup Gets the index of an item in a enumeration or list.
(Defined by ListExtensions)
Public Extension MethodIndexOfFirstIShiftGroup Gets the index the of first item in list that fulfills the predicate predicate
(Defined by ListExtensions)
Public Extension MethodIndexOfFirstIShiftGroup Gets the index the of first item in list that fulfills the predicate predicate
(Defined by ListExtensions)
Public Extension MethodIndexOfMaxIShiftGroupReturn the index of the element with the maximum value in an enumerable. If multiple elements with the same minimal value exist, the index of the first element in the sequence is returned.
(Defined by EnumerableExtensions)
Public Extension MethodIndexOfMinIShiftGroupReturn the index of the element with the minimum value in an enumerable. If multiple elements with the same minimal value exist, the index of the first element in the sequence is returned.
(Defined by EnumerableExtensions)
Public Extension MethodIndicesInt32AndValuesWhereIShiftGroup Returns tuples of index and element of all elements in an enumeration which fullfill a given condition, given by the element's value.
(Defined by EnumerableExtensions)
Public Extension MethodIndicesInt32AndValuesWhereIShiftGroup Returns tuples of index and element of all elements in an enumeration which fullfill a given condition, given by the element's value and its index.
(Defined by EnumerableExtensions)
Public Extension MethodIndicesInt32WhereIShiftGroup Returns the indices of the elements which fullfill a given condition, given by the element's value.
(Defined by EnumerableExtensions)
Public Extension MethodIndicesInt32WhereIShiftGroup Returns the indices of the elements which fullfill a given condition, given by the element's value and its index.
(Defined by EnumerableExtensions)
Public Extension MethodIndicesOfMinMaxIShiftGroupReturn the index of the element with the minimum value in an enumerable. If multiple elements with the same minimal value exist, the index of the first element in the sequence is returned.
(Defined by EnumerableExtensions)
Public Extension MethodIsEmptyIShiftGroup Determines whether the specified enumeration is empty.
(Defined by EnumerableExtensions)
Public Extension MethodJoinConditionalIShiftGroup, T2 Takes a join of two sequences, but only takes into account those pair, which fulfill a given condition.
(Defined by EnumerableExtensions)
Public Extension MethodJoinConditionalIShiftGroup, T2, TResult Takes a join of two sequences, but only takes into account those pair, which fulfill a given condition.
(Defined by EnumerableExtensions)
Public Extension MethodLastOrIShiftGroup Returns the last value of the enumeration, or, if the enumeration is empty, the other value provided in the arguments.
(Defined by EnumerableExtensions)
Public Extension MethodMaxElementIShiftGroup, M Gets the element of a IEnumerabe that evaluates by means of a conversion function to the maximal value. This is different from Select(x => conversion(x)).Max() insofar as it not returns the maximum value, but the original element x which converts to the maximum value.
(Defined by EnumerableExtensions)
Public Extension MethodMaxOrDefaultIShiftGroup, M Evaluates the maximum of a enumeration of elements, or returns a default value if the series is empty.
(Defined by EnumerableExtensions)
Public Extension MethodSelectCombinationIShiftGroup Select a random combination, without repetition, from a data sequence by selecting k elements in original order.
(Defined by Combinatorics)
Public Extension MethodSelectCombinationWithRepetitionIShiftGroup Select a random combination, with repetition, from a data sequence by selecting k elements in original order.
(Defined by Combinatorics)
Public Extension MethodSelectPermutationIShiftGroup Select a random permutation from a data sequence by returning the provided data in random order. Implemented using Fisher-Yates Shuffling.
(Defined by Combinatorics)
Public Extension MethodSelectVariationIShiftGroup Select a random variation, without repetition, from a data sequence by randomly selecting k elements in random order. Implemented using partial Fisher-Yates Shuffling.
(Defined by Combinatorics)
Public Extension MethodSelectVariationWithRepetitionIShiftGroup Select a random variation, with repetition, from a data sequence by randomly selecting k elements in random order.
(Defined by Combinatorics)
Public Extension MethodTakeAllButLastIShiftGroup Takes all elements of the enumeration except the last element.
(Defined by EnumerableExtensions)
Public Extension MethodThisOrEmptyIShiftGroup Returns either the provided enumeration, or if it is null, an empty enumeration.
(Defined by EnumerableExtensions)
Public Extension MethodTryGetFirstAndLastIShiftGroup Returns true and the first and last value of the enumeration, or, if the enumeration is empty, returns false.
(Defined by EnumerableExtensions)
Public Extension MethodTryGetSingleElementIShiftGroup Try to get the one and only element of the collection.
(Defined by EnumerableExtensions)
Top
See Also