/* @file  pmSourceFitModel.h
 *
 * @author EAM, IfA; GLG, MHPCC
 *
 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
 * @date $Date: 2007-01-24 02:54:15 $
 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
 */

# ifndef PM_SOURCE_FIT_MODEL_H
# define PM_SOURCE_FIT_MODEL_H

/// @addtogroup Objects Object Detection / Analysis Functions
/// @{

typedef enum {
    PM_SOURCE_FIT_NORM,
    PM_SOURCE_FIT_PSF,
    PM_SOURCE_FIT_EXT,
    PM_SOURCE_FIT_PSF_AND_SKY,
    PM_SOURCE_FIT_EXT_AND_SKY
} pmSourceFitMode;

bool pmSourceFitModelInit(
    float nIter,   ///< max number of allowed iterations
    float tol,      ///< convergence criterion
    float weight,      ///< use this weight for constant-weight fits
    bool poissonErrors   // use poisson errors for fits?
);

/** pmSourceFitModel()
 *
 * Fit the requested model to the specified source. The starting guess for the model is given
 * by the input source.model parameter values. The pixels of interest are specified by the
 * source.pixels and source.mask entries. This function calls psMinimizeLMChi2() on the image
 * data. The function returns TRUE on success or FALSE on failure.
 *
 */
bool pmSourceFitModel(
    pmSource *source,   ///< The input pmSource
    pmModel *model,   ///< model to be fitted
    pmSourceFitMode mode  ///< define parameters to be fitted
);


// initialize data for a group of object models
bool pmSourceFitSetInit (pmModelType type);

// clear data for a group of object models
void pmSourceFitSetClear (void);

// function used to set limits for a group of models
bool pmSourceFitSet_CheckLimits (psMinConstraintMode mode, int nParam, float *params, float *betas);

// function used to fit a group of object models
psF32 pmSourceFitSet_Function(psVector *deriv,
                              const psVector *params,
                              const psVector *x);

/** pmSourceFitSet()
 *
 * Fit the requested model to the specified source. The starting guess for the model is given
 * by the input source.model parameter values. The pixels of interest are specified by the
 * source.pixels and source.mask entries. This function calls psMinimizeLMChi2() on the image
 * data. The function returns TRUE on success or FALSE on failure.
 *
 */
bool pmSourceFitSet(
    pmSource *source,   ///< The input pmSource
    psArray *modelSet,   ///< model to be fitted
    pmSourceFitMode mode  ///< define parameters to be fitted
);

/// @}
# endif /* PM_SOURCE_FIT_MODEL_H */
