ScatteredInterpolationF Class

Base class for scattered interpolation methods (single-precision).

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionPairVectorF, VectorF
    DigitalRune.Mathematics.InterpolationScatteredInterpolationF
      DigitalRune.Mathematics.InterpolationRadialBasisRegressionF
      DigitalRune.Mathematics.InterpolationShepardInterpolationF

Namespace: DigitalRune.Mathematics.Interpolation
Assembly: DigitalRune.Mathematics (in DigitalRune.Mathematics.dll) Version: 1.14.0.0 (1.14.0.14427)

Syntax

C++

Copy

public abstract class ScatteredInterpolationF : Collection<Pair<VectorF, VectorF>>

Public MustInherit Class ScatteredInterpolationF
	Inherits Collection(Of Pair(Of VectorF, VectorF))

public ref class ScatteredInterpolationF abstract : public Collection<Pair<VectorF^, VectorF^>>

[<AbstractClassAttribute>]
type ScatteredInterpolationF =  
    class
        inherit Collection<Pair<VectorF, VectorF>>
    end

The ScatteredInterpolationF type exposes the following members.

Constructors

	Name	Description
	ScatteredInterpolationF	Initializes a new instance of the ScatteredInterpolationF class

Top

Methods

	Name	Description
	Add	Adds an object to the end of the CollectionT. (Inherited from CollectionPairVectorF, VectorF.)
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionPairVectorF, VectorF.)
	ClearItems	Removes all elements from the CollectionT. (Overrides CollectionTClearItems.)
	Compute	Computes a y value for the specified x value using scattered interpolation.
	Contains	Determines whether an element is in the CollectionT. (Inherited from CollectionPairVectorF, VectorF.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionPairVectorF, VectorF.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionPairVectorF, VectorF.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Searches for the specified object and returns the zero-based index of the first occurrence within the entire CollectionT. (Inherited from CollectionPairVectorF, VectorF.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionPairVectorF, VectorF.)
	InsertItem	Inserts an element into the CollectionT at the specified index. (Overrides CollectionTInsertItem(Int32, T).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnCompute	Called when Compute(VectorF) is called.
	OnSetup	Called when Setup is called.
	Remove	Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionPairVectorF, VectorF.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionPairVectorF, VectorF.)
	RemoveItem	Removes the element at the specified index of the CollectionT. (Overrides CollectionTRemoveItem(Int32).)
	SetItem	Replaces the element at the specified index. (Overrides CollectionTSetItem(Int32, T).)
	Setup	Prepares the scattered interpolation.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	Count	Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionPairVectorF, VectorF.)
	Item	Gets or sets the element at the specified index. (Inherited from CollectionPairVectorF, VectorF.)
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from CollectionPairVectorF, VectorF.)

Top

Explicit Interface Implementations

	Name	Description
	IListAdd	Adds an item to the IList. (Inherited from CollectionPairVectorF, VectorF.)
	IListContains	Determines whether the IList contains a specific value. (Inherited from CollectionPairVectorF, VectorF.)
	ICollectionCopyTo	Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from CollectionPairVectorF, VectorF.)
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection. (Inherited from CollectionPairVectorF, VectorF.)
	IListIndexOf	Determines the index of a specific item in the IList. (Inherited from CollectionPairVectorF, VectorF.)
	IListInsert	Inserts an item into the IList at the specified index. (Inherited from CollectionPairVectorF, VectorF.)
	IListIsFixedSize	Gets a value indicating whether the IList has a fixed size. (Inherited from CollectionPairVectorF, VectorF.)
	ICollectionTIsReadOnly	Gets a value indicating whether the ICollectionT is read-only. (Inherited from CollectionPairVectorF, VectorF.)
	IListIsReadOnly	Gets a value indicating whether the IList is read-only. (Inherited from CollectionPairVectorF, VectorF.)
	ICollectionIsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from CollectionPairVectorF, VectorF.)
	IListItem	Gets or sets the element at the specified index. (Inherited from CollectionPairVectorF, VectorF.)
	IListRemove	Removes the first occurrence of a specific object from the IList. (Inherited from CollectionPairVectorF, VectorF.)
	ICollectionSyncRoot	Gets an object that can be used to synchronize access to the ICollection. (Inherited from CollectionPairVectorF, VectorF.)

Top

Remarks

Scattered interpolation solves the following problem: Several data pairs have been observed: (x1, y1), (x2, y2), (x3, y3), ... These are the reference data values. Now a new x is measured and the y value for the given x is wanted.

The x values are m-dimensional vectors. The y values are n-dimensional vectors. All x vectors must have equal dimensions and all y vectors must have equal dimensions. But the dimension of the x vectors are usually different than the dimension of the y vectors.

How to use this class:

First the reference data pairs have to be created using the class PairTFirst, TSecond and registered by calling Add(T). The first item of each data pair is the x vector, the second item is the y vector. For example:
C#
Copy
```
scatteredInterpolation.Add(new Pair<VectorF, VectorF>(x, y));
```
After all reference data pairs are added, Setup has to be called.
Then Compute(VectorF) can be called to compute y values for any given x values. If the reference data pairs are changed, it is necessary to call Setup before the next call of Compute(VectorF).

Notes to Inheritors: Derived types need to implement the methods OnSetup and OnCompute(VectorF).

Reference

DigitalRune.Mathematics.Interpolation Namespace