AlgorithmAutoCorrelation.FitCorrelationModel (MIPAV API Documentation)

java.lang.Object
- gov.nih.mipav.model.algorithms.NLConstrainedEngine
- - gov.nih.mipav.model.algorithms.AlgorithmAutoCorrelation.FitCorrelationModel

Enclosing class:: AlgorithmAutoCorrelation

class AlgorithmAutoCorrelation.FitCorrelationModel
extends NLConstrainedEngine

DOCUMENT ME!

Field Summary

Fields
Modifier and Type Field Description

private float[] xData

private float[] yData
- Fields inherited from class gov.nih.mipav.model.algorithms.NLConstrainedEngine
  a, absoluteConvergence, analyticalJacobian, bl, bounds, bu, ctrlMat, dyda, gues, internalScaling, iters, jacobian, maxIterations, nPts, outputMes, param, parameterConvergence, relativeConvergence, residuals, secondAllowed, stdv, tolerance

Constructor Summary

Constructors
Constructor	Description
`FitCorrelationModel(int nPoints, float[] xData, float[] yData, double[] initial)`	Creates a new FitCorrelationModel object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`driver()`	Starts the analysis.
`void`	`dumpResults()`	Display results of displaying exponential fitting parameters.
`void`	`fitToFunction(double[] a, double[] residuals, double[][] covarMat)`	fitToFunction communicates with 3 protected variables param, nPts, and ctrlMat ctrlMat is used as a wrapper for ctrl or lctrl.

Methods inherited from class gov.nih.mipav.model.algorithms.NLConstrainedEngine
dumpTestResults, fitToTestFunction, getChiSquared, getExitStatus, getIterations, getParameters, getResiduals, statusMessage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - xData
```
private float[] xData
```
  - yData
```
private float[] yData
```
- Constructor Detail
  - FitCorrelationModel
```
public FitCorrelationModel(int nPoints,
                           float[] xData,
                           float[] yData,
                           double[] initial)
```
    Creates a new FitCorrelationModel object.
    
    Parameters:
    
    nPoints - DOCUMENT ME!
    
    xData - DOCUMENT ME!
    
    yData - DOCUMENT ME!
    
    initial - DOCUMENT ME!
- Method Detail
  - driver
```
public void driver()
```
    Starts the analysis.
    
    Overrides:
    
    driver in class NLConstrainedEngine
  - dumpResults
```
public void dumpResults()
```
    Display results of displaying exponential fitting parameters.
  - fitToFunction
```
public void fitToFunction(double[] a,
                          double[] residuals,
                          double[][] covarMat)
```
    Description copied from class: NLConstrainedEngine
    
    fitToFunction communicates with 3 protected variables param, nPts, and ctrlMat ctrlMat is used as a wrapper for ctrl or lctrl. Evaluates the residuals or the Jacobian at a certain a[]
    
    Specified by:
    
    fitToFunction in class NLConstrainedEngine
    
    Parameters:
    
    a - The best guess parameter values.
    
    residuals - ymodel - yData.
    
    covarMat - The derivative values of y with respect to fitting parameters.