/* $Id: cpl_image_basic.h,v 1.43 2007/03/13 22:48:36 llundin Exp $
 *
 * This file is part of the ESO Common Pipeline Library
 * Copyright (C) 2001-2004 European Southern Observatory
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

/*
 * $Author: llundin $
 * $Date: 2007/03/13 22:48:36 $
 * $Revision: 1.43 $
 * $Name:  $
 */

#ifndef CPL_IMAGE_BASIC_H
#define CPL_IMAGE_BASIC_H

/*-----------------------------------------------------------------------------
                                   Includes
 -----------------------------------------------------------------------------*/

#include "cpl_image.h"
#include "cpl_vector.h"

CPL_BEGIN_DECLS

/*-----------------------------------------------------------------------------
                                   Defines
 -----------------------------------------------------------------------------*/
/**
 * Each FFT mode is listed below.
 * The modes can be combined with bitwise or.
 */
#define CPL_FFT_DEFAULT      ((unsigned)0)
/* Inverse FFT */
#define CPL_FFT_INVERSE      ((unsigned)1 << 1)
/* No normalization */
#define CPL_FFT_UNNORMALIZED ((unsigned)1 << 2)
/* Swap halves of output */
#define CPL_FFT_SWAP_HALVES  ((unsigned)1 << 3)

enum _cpl_norm_ {
    CPL_NORM_SCALE,
    CPL_NORM_MEAN,
    CPL_NORM_FLUX,
    CPL_NORM_ABSFLUX
};

typedef enum _cpl_norm_ cpl_norm;


/*-----------------------------------------------------------------------------
                            Function prototypes
 -----------------------------------------------------------------------------*/

/* Basic operations */
cpl_image * cpl_image_add_create(const cpl_image *, const cpl_image *) ;
cpl_image * cpl_image_subtract_create(const cpl_image *, const cpl_image *) ;
cpl_image * cpl_image_multiply_create(const cpl_image *, const cpl_image *) ;
cpl_image * cpl_image_divide_create(const cpl_image *, const cpl_image *) ; 
cpl_error_code cpl_image_add(cpl_image *, const cpl_image *) ;
cpl_error_code cpl_image_subtract(cpl_image *, const cpl_image *) ;
cpl_error_code cpl_image_multiply(cpl_image *, const cpl_image *) ;
cpl_error_code cpl_image_divide(cpl_image *, const cpl_image *) ;

cpl_error_code cpl_image_add_scalar(cpl_image *, double) ;
cpl_error_code cpl_image_subtract_scalar(cpl_image *, double) ;
cpl_error_code cpl_image_multiply_scalar(cpl_image *, double) ;
cpl_error_code cpl_image_divide_scalar(cpl_image *, double) ;
cpl_error_code cpl_image_power(cpl_image *, double) ;
cpl_error_code cpl_image_exponential(cpl_image *, double) ;
cpl_error_code cpl_image_logarithm(cpl_image *, double) ;
cpl_error_code cpl_image_normalise(cpl_image *, cpl_norm) ;
cpl_error_code cpl_image_abs(cpl_image *) ;

cpl_image * cpl_image_add_scalar_create(const cpl_image *, double) ;
cpl_image * cpl_image_subtract_scalar_create(const cpl_image *, double) ;
cpl_image * cpl_image_multiply_scalar_create(const cpl_image *, double) ;
cpl_image * cpl_image_divide_scalar_create(const cpl_image *, double) ;
cpl_image * cpl_image_power_create(const cpl_image *, double) ;
cpl_image * cpl_image_exponential_create(const cpl_image *, double) ;
cpl_image * cpl_image_logarithm_create(const cpl_image *, double) ;
cpl_image * cpl_image_normalise_create(const cpl_image *, cpl_norm) ;
cpl_image * cpl_image_abs_create(const cpl_image *) ;

cpl_error_code cpl_image_threshold(cpl_image *, double, double, double, double);
cpl_image * cpl_image_average_create(const cpl_image *, const cpl_image *);

/* Collapse functions */
cpl_image * cpl_image_collapse_window_create(const cpl_image *, int, int, int, int, int);
cpl_image * cpl_image_collapse_create(const cpl_image *, int) ;
cpl_image * cpl_image_collapse_median_create(const cpl_image *, int, int, int) ;

/* Extraction function */
cpl_image * cpl_image_extract(const cpl_image *, int, int, int, int) ;
cpl_vector * cpl_vector_new_from_image_row(const cpl_image *, int) ;
cpl_vector * cpl_vector_new_from_image_column(const cpl_image *, int) ;

/* Rotation and Shift */
cpl_error_code cpl_image_turn(cpl_image *, int) ;
cpl_error_code cpl_image_shift(cpl_image *, int, int) ;

/* Insert an image in an other one */
cpl_error_code cpl_image_copy(cpl_image *, const cpl_image *, int, int);

/* Symmetry function */
cpl_error_code cpl_image_flip(cpl_image *, int) ;

/* Pixels re-organization */
cpl_error_code cpl_image_move(cpl_image *, int, const int *) ;

/* Gaussian fit of an image zone */
cpl_error_code cpl_image_fit_gaussian(const cpl_image *, int, int, int, 
        double *, double *, double *, double *, double *, double *, double *) ;

/* FWHM computation on a local maximum */
cpl_error_code cpl_image_get_fwhm(const cpl_image *, int, int, double *, 
        double *) ;

/* FFT computation */
cpl_error_code cpl_image_fft(cpl_image *, cpl_image *, unsigned) ;

CPL_END_DECLS

#endif