/** @file  psImageUnbin.h
 *
 *  @brief Functions to determine the image background
 *
 *  @author EAM, IfA
 *
 *  $Revision: 1.4.12.1 $ $Name: not supported by cvs2svn $
 *  $Date: 2007-09-07 20:18:03 $
 *  Copyright 2004-2005 IfA, University of Hawaii
 */

#ifndef PS_IMAGE_BACKGROUND_H
#define PS_IMAGE_BACKGROUND_H

/// @addtogroup ImageOps Image Operations
/// @{

#include "psStats.h"
#include "psImage.h"
#include "psType.h"

// Get the background for an image
bool psImageBackground(psStats *stats, // desired measurement and options
		       psVector **sample, // vector of data used for analysis
                       const psImage *image, // Image for which to get the background
                       const psImage *mask, // Mask image
                       psMaskType maskValue, // Mask pixels which this mask value
                       psRandom *rng // Random number generator (for pixel selection)
                      );

/// @}
#endif // #ifndef PS_IMAGE_BACKGROUND_H

/* the user may supply a psVector ** or NULL to sample.  if a vector is supplied,
   the user must free the resulting vector */
