ICurveFitter (LOCI Javadocs 0-SNAPSHOT API)

All Known Implementing Classes:

CurveFitter, GACurveFitter, LMCurveFitter
```
public interface ICurveFitter
```
Interface for curve fitting algorithms.

Author:

Eric Kjellman

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`estimate()` Initializes the curve fitter with a starting curve estimate.
`double`	`getChiSquaredError()` Returns the Chi Squared Error of the current curve estimate.
`double`	`getChiSquaredError(double[][] estCurve)`
`int`	`getComponentCount()` Returns the number of exponentials to be fitted.
`double[][]`	`getCurve()` Returns the current curve estimate.
`int[]`	`getData()` Gets the data to be used to generate curve estimates.
`double[]`	`getEstimates(double[][] estimate)`
`int`	`getFirst()`
`boolean[][]`	`getFixed()` For each parameter, gets whether it should be fixed at the current value, or allowed to iterate toward an optimal value.
`int`	`getIterations()` Returns the number of iterations so far.
`int`	`getLast()`
`double`	`getReducedChiSquaredError()` Returns the Reduced Chi Squared Error of the current curve estimate This is based on the number of datapoints in data and the number of exponentials in setComponentCount.
`double`	`getReducedChiSquaredError(double[][] estCurve)`
`void`	`iterate()` iterate() runs through one iteration of whatever curve fitting technique this curve fitter uses.
`void`	`setComponentCount(int numExp)` Sets how many exponentials are expected to be fitted.
`void`	`setCurve(double[][] curve)` Sets the current curve estimate, useful if information about the curve is already known.
`void`	`setData(int[] data)` Sets the data to be used to generate curve estimates.
`void`	`setData(int[] data, int first, int last)`
`void`	`setFixed(boolean[][] fixed)` For each parameter, sets whether it should be fixed at the current value, or allowed to iterate toward an optimal value.

- Method Detail
  - iterate
```
void iterate()
```
    iterate() runs through one iteration of whatever curve fitting technique this curve fitter uses. This will generally update the information returned by getCurve and getChiSquaredError.
  - getIterations
```
int getIterations()
```
    Returns the number of iterations so far.
  - getChiSquaredError
```
double getChiSquaredError()
```
    Returns the Chi Squared Error of the current curve estimate.
  - getChiSquaredError
```
double getChiSquaredError(double[][] estCurve)
```
  - getReducedChiSquaredError
```
double getReducedChiSquaredError()
```
    Returns the Reduced Chi Squared Error of the current curve estimate This is based on the number of datapoints in data and the number of exponentials in setComponentCount.
  - getReducedChiSquaredError
```
double getReducedChiSquaredError(double[][] estCurve)
```
  - getEstimates
```
double[] getEstimates(double[][] estimate)
```
  - setData
```
void setData(int[] data)
```
    Sets the data to be used to generate curve estimates. Single dimension of data... time values are index, since we can assume that the datapoints are evenly spaced.
  - setData
```
void setData(int[] data,
             int first,
             int last)
```
  - getData
```
int[] getData()
```
    Gets the data to be used to generate curve estimates. Single dimension of data... time values are index, since we can assume that the datapoints are evenly spaced.
  - getFirst
```
int getFirst()
```
  - getLast
```
int getLast()
```
  - setComponentCount
```
void setComponentCount(int numExp)
```
    Sets how many exponentials are expected to be fitted.
  - getComponentCount
```
int getComponentCount()
```
    Returns the number of exponentials to be fitted.
  - setFixed
```
void setFixed(boolean[][] fixed)
```
    For each parameter, sets whether it should be fixed at the current value, or allowed to iterate toward an optimal value.
  - getFixed
```
boolean[][] getFixed()
```
    For each parameter, gets whether it should be fixed at the current value, or allowed to iterate toward an optimal value.
  - estimate
```
void estimate()
```
    Initializes the curve fitter with a starting curve estimate.
  - getCurve
```
double[][] getCurve()
```
    Returns the current curve estimate. Return size is expected to be [components][3] For each exponential of the form ae^-bt+c, [][0] is a, [1] is b, [2] is c.
  - setCurve
```
void setCurve(double[][] curve)
```
    Sets the current curve estimate, useful if information about the curve is already known. See getCurve for information about the array to pass.

Interface ICurveFitter

Method Summary

Method Detail

iterate

getIterations

getChiSquaredError

getChiSquaredError

getReducedChiSquaredError

getReducedChiSquaredError

getEstimates

setData

setData

getData

getFirst

getLast

setComponentCount

getComponentCount

setFixed

getFixed

estimate

getCurve

setCurve