AbstractFitsImageModel

java.lang.Object
- astro.fits.AbstractFitsImageModel

All Implemented Interfaces:

MultidimensionalDataModel

Direct Known Subclasses:

AbstractPinholeModel.AbstractPinholeFits, AbstractSkyMaker.SkyRandomModel
```
public abstract class AbstractFitsImageModel
extends Object
implements MultidimensionalDataModel
```
An abstract fits image model links x/y data to ADU measures. It is thus multidimensional only in the independent variable. It is constructed with an image HDU plus an optional readout-window. The x/y data is restored from the original window readout.

Field Summary

Fields
Modifier and Type	Field and Description
`private double[]`	`adu` The ADUs.
`private double[]`	`err` The errors of the measures, can be constructed from adus.
`private Dimension`	`size`
`private Point2D`	`upleft` An offset to the data, normally the upper left corner of the ADU window.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractFitsImageModel(double[] fits, Rectangle box)` We construct an abstract fit image model by providing the adus plus an eventual readout window.
`protected`	`AbstractFitsImageModel(MImageHDU fits)` We construct an abstract fit image model by providing the adus plus an eventual readout window.
`protected`	`AbstractFitsImageModel(MImageHDU fits, Rectangle box)` We construct an abstract fit image model by providing the adus plus an eventual readout window.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Pair<Vector3D,double[]>`	`aboveBackground(double back, double rms, double sigma, double gain)` All ADU not at least sigma times rms above back are set to zero, from all others, the background is subtracted.
`int`	`dimension()` Returns one.
`int`	`dimensionOfIndependent()` Returns two.
`boolean`	`equalData(MultidimensionalDataModel mdm)` Two fits model have equal data if their adus are the same
`private float[]`	`floatModelData(VectorG[] model)` Returns the data as output from the modeling as a double array
`Dimension`	`getArea()`
`float[]`	`getFloatImageData()` Returns the image data as a float array
`float[]`	`getFloatImageDataErrors()` Returns the errors of the image data.
`float[]`	`getFloatImageModel(VectorG parameters)` Returns the image model
`float[]`	`getFloatImageResiduals(VectorG parameters)` Returns the image residuals
`double[]`	`getImageData()` Returns the image data
`double[]`	`getImageDataErrors()` Returns the errors of the image data.
`double[]`	`getImageModel(VectorG parameters)` Returns the image model
`double[]`	`getImageResiduals(VectorG parameters)` Returns the image residuals
`int`	`getMeasureCount()` The number of data points is equal to the array size of the dependant variable array.
`VectorG[]`	`getMeasurementErrors()` If the errors were set, we return the error vector here.
`VectorG[]`	`getMeasures()` Returns the measures as an VectorG array.
`Metric`	`getMetric()` Per default we return the euclidean arc length metric.
`VectorG[]`	`getModel(VectorG a)` Returns the entire model by stepping through all measurement times.
`VectorG[]`	`getResiduals(VectorG a)` Returns the residuals of the measures to the data model.
`double`	`getRms(VectorG a)` Return the rms of the average of the residuals squared.
`VectorG[]`	`getTimes()` Returns the times the measurements were taken.
`VectorG[]`	`getTotalErrors()` Default implementation returns the total errors here.
`protected Point2D`	`getUpLeft()`
`protected int[]`	`getYX(VectorG time)` Back-conversion of 2d location into image array, y first.
`private double[]`	`modelData(VectorG[] model)` Returns the data as output from the modeling as a double array
`double[]`	`photonAndReadoutNoise(double gain, double ron)` Estimates the ADU errors by providing the CCD gain and read-out noise.
`void`	`setAduErrors(double[] sig)` Sets the errors of the image data explicitly.
`void`	`subtract(double back)` Subtracts a background from all ADUs.
`private VectorG[]`	`vectorData(double[] data)` Converts adus or their errors to an array of one-dimensional vectors.

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

Methods inherited from interface math.MultidimensionalDataModel
evaluateModel, getParameterCount

- Field Detail
  - adu
```
private final double[] adu
```
    The ADUs.
  - err
```
private double[] err
```
    The errors of the measures, can be constructed from adus.
  - upleft
```
private final Point2D upleft
```
    An offset to the data, normally the upper left corner of the ADU window.
  - size
```
private final Dimension size
```
- Constructor Detail
  - AbstractFitsImageModel
```
protected AbstractFitsImageModel(MImageHDU fits)
                          throws BasicFitsException
```
    We construct an abstract fit image model by providing the adus plus an eventual readout window.
    
    Throws:
    
    BasicFitsException
  - AbstractFitsImageModel
```
protected AbstractFitsImageModel(MImageHDU fits,
                                 Rectangle box)
                          throws BasicFitsException
```
    We construct an abstract fit image model by providing the adus plus an eventual readout window.
    
    Throws:
    
    BasicFitsException
  - AbstractFitsImageModel
```
protected AbstractFitsImageModel(double[] fits,
                                 Rectangle box)
```
    We construct an abstract fit image model by providing the adus plus an eventual readout window.
- Method Detail
  - getUpLeft
```
protected Point2D getUpLeft()
```
  - setAduErrors
```
public void setAduErrors(double[] sig)
```
    Sets the errors of the image data explicitly. Photon noise plus readout errors can be estimated with a call to photonAndReadoutNoise(double, double).
  - subtract
```
public void subtract(double back)
```
    Subtracts a background from all ADUs.
  - aboveBackground
```
protected Pair<Vector3D,double[]> aboveBackground(double back,
                                                  double rms,
                                                  double sigma,
                                                  double gain)
```
    All ADU not at least sigma times rms above back are set to zero, from all others, the background is subtracted. All relevant ADUs contribute to the 3-dim vector returned containing zeroth and the two first image moments as pure sums (not normalized). To additionally allow proper errors to be constructed from the ADU statistics, we return a 2-dim double error containing photon statistic errors for relevant ADU and background RMS as stated on input for all others.
  - photonAndReadoutNoise
```
public double[] photonAndReadoutNoise(double gain,
                                      double ron)
```
    Estimates the ADU errors by providing the CCD gain and read-out noise. If this is not sufficient, set the adu errors explicitly with #setAduErrors(double[][]).
    
    Returns:
    
    The estimated errors from photon noise and read-out in ADUs.
  - getTimes
```
public VectorG[] getTimes()
```
    Returns the times the measurements were taken. This is only important to fulfill the general contract of a MultidimensionalDataModel. It is constructed from the index in the adus array plus the upper left corner in the original image. Each element returned is a 2 dimensional vector.
    
    Specified by:
    
    getTimes in interface MultidimensionalDataModel
  - getYX
```
protected int[] getYX(VectorG time)
```
    Back-conversion of 2d location into image array, y first.
    
    Parameters:
    
    time -
    
    Returns:
  - getMeasures
```
public VectorG[] getMeasures()
```
    Returns the measures as an VectorG array. This is only important to fulfill the general contract of a MultidimensionalDataModel. It is constructed from the adus of the image, the index is constructed as in the measurments.
    
    Specified by:
    
    getMeasures in interface MultidimensionalDataModel
    
    See Also:
    
    getTimes()
  - getMeasurementErrors
```
public VectorG[] getMeasurementErrors()
```
    If the errors were set, we return the error vector here.
    
    Specified by:
    
    getMeasurementErrors in interface MultidimensionalDataModel
  - modelData
```
private double[] modelData(VectorG[] model)
```
    Returns the data as output from the modeling as a double array
    
    Parameters:
    
    model -
    
    Returns:
  - floatModelData
```
private float[] floatModelData(VectorG[] model)
```
    Returns the data as output from the modeling as a double array
    
    Parameters:
    
    model -
    
    Returns:
  - vectorData
```
private VectorG[] vectorData(double[] data)
```
    Converts adus or their errors to an array of one-dimensional vectors.
    
    Parameters:
    
    err2 -
    
    Returns:
  - getTotalErrors
```
public VectorG[] getTotalErrors()
```
    Default implementation returns the total errors here.
    
    Specified by:
    
    getTotalErrors in interface MultidimensionalDataModel
  - getModel
```
public VectorG[] getModel(VectorG a)
```
    Returns the entire model by stepping through all measurement times.
    
    Specified by:
    
    getModel in interface MultidimensionalDataModel
  - getResiduals
```
public VectorG[] getResiduals(VectorG a)
```
    Returns the residuals of the measures to the data model. This equals calling getMeasures() and getModel(math.VectorG) and returning the difference between both.
    
    Specified by:
    
    getResiduals in interface MultidimensionalDataModel
    
    Parameters:
    
    a - The model parameters, not necessarily the best fit.
  - getRms
```
public double getRms(VectorG a)
```
    Return the rms of the average of the residuals squared.
  - getArea
```
public Dimension getArea()
```
  - getMeasureCount
```
public int getMeasureCount()
```
    The number of data points is equal to the array size of the dependant variable array.
    
    Specified by:
    
    getMeasureCount in interface MultidimensionalDataModel
  - dimension
```
public int dimension()
```
    Returns one.
    
    Specified by:
    
    dimension in interface MultidimensionalDataModel
  - dimensionOfIndependent
```
public int dimensionOfIndependent()
```
    Returns two.
    
    Specified by:
    
    dimensionOfIndependent in interface MultidimensionalDataModel
  - getMetric
```
public Metric getMetric()
```
    Per default we return the euclidean arc length metric.
    
    Specified by:
    
    getMetric in interface MultidimensionalDataModel
  - equalData
```
public boolean equalData(MultidimensionalDataModel mdm)
```
    Two fits model have equal data if their adus are the same
  - getImageData
```
public double[] getImageData()
```
    Returns the image data
  - getImageDataErrors
```
public double[] getImageDataErrors()
```
    Returns the errors of the image data.
  - getImageModel
```
public double[] getImageModel(VectorG parameters)
```
    Returns the image model
  - getImageResiduals
```
public double[] getImageResiduals(VectorG parameters)
```
    Returns the image residuals
  - getFloatImageData
```
public float[] getFloatImageData()
```
    Returns the image data as a float array
  - getFloatImageDataErrors
```
public float[] getFloatImageDataErrors()
```
    Returns the errors of the image data.
  - getFloatImageModel
```
public float[] getFloatImageModel(VectorG parameters)
```
    Returns the image model
  - getFloatImageResiduals
```
public float[] getFloatImageResiduals(VectorG parameters)
```
    Returns the image residuals

Class AbstractFitsImageModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface math.MultidimensionalDataModel

Field Detail

adu

err

upleft

size

Constructor Detail

AbstractFitsImageModel

AbstractFitsImageModel

AbstractFitsImageModel

Method Detail

getUpLeft

setAduErrors

subtract

aboveBackground

photonAndReadoutNoise

getTimes

getYX

getMeasures

getMeasurementErrors

modelData

floatModelData

vectorData

getTotalErrors

getModel

getResiduals

getRms

getArea

getMeasureCount

dimension

dimensionOfIndependent

getMetric

equalData

getImageData

getImageDataErrors

getImageModel

getImageResiduals

getFloatImageData

getFloatImageDataErrors

getFloatImageModel

getFloatImageResiduals