StartPointEstimator (ImgLib2 Javadocs 0-SNAPSHOT API)

All Known Implementing Classes:

MLEllipticGaussianEstimator, MLGaussianEstimator
```
public interface StartPointEstimator
```
Interface for classes that are able to provide a start point for the parameters of a curve fitting problem on image data.
Implementations of this interface are used to pass a priori knowledge to fitting problems. They are specific to a particular class of problems, and required to provide for two values:
- They must be able to provide a domain size. That is the size of the image patch around the peak to fit, and whose content is to be used in the fit.
- They must be able to provide a starting point to the curve fitting solver, based on the image data around the coarse peak location.
Depending on the problem they are taylored for, implementations can be very crude: One can return plain constants if the typical parameters of all peaks are known and uniform. Refined method are also possible.
Start point parameters are returned in a double array; it is therefore important the meaning and order of each element in the returned array is the same as the one expected by the curve fitter that will be used downstream.
Author:

Jean-Yves Tinevez - 2013

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long[]`	`getDomainSpan()` Returns the domain size that will be sampled around each peak for curve fitting.
`double[]`	`initializeFit(Localizable point, Observation data)` Returns a new double array containing an starting point estimate for a specific curve fitting problem.

- Method Detail
  - getDomainSpan
```
long[] getDomainSpan()
```
    Returns the domain size that will be sampled around each peak for curve fitting.
    Domain size is provided as a long[] array, one element per dimension. The size must be understood a radius span: the actual rectangle size is 2 x span[d] + 1. For instance, if in a 2D problem a value of [2, 2] is provided, the actual rectangle that will be sampled will be 5 x 5
    
    Returns:
    
    a long array specifying the span of the domain to sample for curve fitting.
  - initializeFit
```
double[] initializeFit(Localizable point,
                       Observation data)
```
    Returns a new double array containing an starting point estimate for a specific curve fitting problem. Depending on the implementation, this estimate can be calculated from the specified point and the specified image data.
    This same data object, specified as an Observation object, will later be used by the FunctionFitter, so convoluted implementations can and may modify it in a clever way to optimize the subsequent fitting step.
    It is important that this method instantiates a new double array, for its elements will be evolved by the FunctionFitter, but the reference to the array will be shared for the specified peak.
    Since the estimates are returned in a double array, each element has a meaning only in the view of a particular curve fitting problem, and will be applicable only to a specific FunctionFitter.
    
    Parameters:
    
    point - the coarse localization of the peak whose parameters are to be estimated.
    
    data - the image data around the peak to estimate, given as an Observation object.
    
    Returns:
    
    a new double array containing the parameters estimates.

Interface StartPointEstimator

Method Summary

Method Detail

getDomainSpan

initializeFit