FitResults (FLIMLib Javadocs 0-SNAPSHOT API)

java.lang.Object
- flimlib.flimj.FitResults

```
public class FitResults
extends Object
```
The collection of all results generated by a single fit of an image. Fields named xxMap are image representations of the particular attribute. Other fields are not intended to be used by external programs and should be ignored when this object is processed with in the fitting ops.

Author:

Dasong Gao

Field Summary

Fields
Modifier and Type	Field and Description
`float`	`chisq` The reduced chi-squared of the fit.
`Img<FloatType>`	`chisqMap` The image representation of reduced chi-squared of the fit over the the dataset
`float[]`	`fitted` The fitted transients of the fit
`Img<FloatType>`	`fittedMap` The image representation of fitted transients of the fit over the the dataset
`Img<FloatType>`	`intensityMap` The image representation of the intensity distribution obtained by summing up photon counts.
`int`	`ltAxis` The index of lifetime and parameter axis
`float[]`	`param` The fitted parameters of the fit
`Img<FloatType>`	`paramMap` The image representation of fitted parameters of the fit over the the dataset
`float[]`	`residuals` The residuals (y - y_fitted) of the fit
`Img<FloatType>`	`residualsMap` The image representation of residuals of the fit over the the dataset
`static int`	`RET_BAD_FIT_CHISQ_OUT_OF_RANGE` The return code for a fit that succeeded but has chisq > 1e5
`static int`	`RET_BAD_FIT_DIVERGED` The return code for a fit that failed by flimlib
`static int`	`RET_BAD_SETTING` The return code for a fit that failed because of improper arguments
`static int`	`RET_INTENSITY_BELOW_THRESH` The return code for a fit that was not performed because the intensity is below threshold
`static int`	`RET_INTERNAL_ERROR` The return code for a fit that failed because of error in native code (e.g.
`static int`	`RET_OK` The return code for a good fit
`static int`	`RET_UNKNOWN` The return code for unknown fit status
`int`	`retCode` The return code of the fit
`Img<IntType>`	`retCodeMap` The image representation of return codes of the fit over the dataset

Constructor Summary

Constructors
Constructor and Description

FitResults()

Constructors
Constructor and Description
`FitResults()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

FitResults copy()
Create a new instance of FitResults with shallow copy (maps are not duplicated).
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FitResults`	`copy()` Create a new instance of `FitResults` with shallow copy (maps are not duplicated).

- Field Detail
  - RET_OK
```
public static final int RET_OK
```
    The return code for a good fit
    
    See Also:
    
    Constant Field Values
  - RET_BAD_FIT_DIVERGED
```
public static final int RET_BAD_FIT_DIVERGED
```
    The return code for a fit that failed by flimlib
    
    See Also:
    
    Constant Field Values
  - RET_BAD_FIT_CHISQ_OUT_OF_RANGE
```
public static final int RET_BAD_FIT_CHISQ_OUT_OF_RANGE
```
    The return code for a fit that succeeded but has chisq > 1e5
    
    See Also:
    
    Constant Field Values
  - RET_BAD_SETTING
```
public static final int RET_BAD_SETTING
```
    The return code for a fit that failed because of improper arguments
    
    See Also:
    
    Constant Field Values
  - RET_INTENSITY_BELOW_THRESH
```
public static final int RET_INTENSITY_BELOW_THRESH
```
    The return code for a fit that was not performed because the intensity is below threshold
    
    See Also:
    
    Constant Field Values
  - RET_INTERNAL_ERROR
```
public static final int RET_INTERNAL_ERROR
```
    The return code for a fit that failed because of error in native code (e.g. malloc)
    
    See Also:
    
    Constant Field Values
  - RET_UNKNOWN
```
public static final int RET_UNKNOWN
```
    The return code for unknown fit status
    
    See Also:
    
    Constant Field Values
  - ltAxis
```
public int ltAxis
```
    The index of lifetime and parameter axis
  - retCode
```
public int retCode
```
    The return code of the fit
  - retCodeMap
```
public Img<IntType> retCodeMap
```
    The image representation of return codes of the fit over the dataset
  - intensityMap
```
public Img<FloatType> intensityMap
```
    The image representation of the intensity distribution obtained by summing up photon counts.
  - param
```
public float[] param
```
    The fitted parameters of the fit
  - paramMap
```
public Img<FloatType> paramMap
```
    The image representation of fitted parameters of the fit over the the dataset
  - fitted
```
public float[] fitted
```
    The fitted transients of the fit
  - fittedMap
```
public Img<FloatType> fittedMap
```
    The image representation of fitted transients of the fit over the the dataset
  - residuals
```
public float[] residuals
```
    The residuals (y - y_fitted) of the fit
  - residualsMap
```
public Img<FloatType> residualsMap
```
    The image representation of residuals of the fit over the the dataset
  - chisq
```
public float chisq
```
    The reduced chi-squared of the fit. For global analysis, this is the global chi-squared value.
  - chisqMap
```
public Img<FloatType> chisqMap
```
    The image representation of reduced chi-squared of the fit over the the dataset
- Constructor Detail
  - FitResults
```
public FitResults()
```
- Method Detail
  - copy
```
public FitResults copy()
```
    Create a new instance of FitResults with shallow copy (maps are not duplicated).
    
    Returns:
    
    A clone of the current instance.

Class FitResults

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RET_OK

RET_BAD_FIT_DIVERGED

RET_BAD_FIT_CHISQ_OUT_OF_RANGE

RET_BAD_SETTING

RET_INTENSITY_BELOW_THRESH

RET_INTERNAL_ERROR

RET_UNKNOWN

ltAxis

retCode

retCodeMap

intensityMap

param

paramMap

fitted

fittedMap

residuals

residualsMap

chisq

chisqMap

Constructor Detail

FitResults

Method Detail

copy