psClip.h

Go to the documentation of this file.
00001 /* @file  psClip.h
00002  * @brief vector clipping functions
00003  *
00004  * $Revision: 1.2 $ $Name:  $
00005  * $Date: 2007/01/23 22:47:23 $
00006  * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
00007  */
00008 
00009 #ifndef PS_CLIP_H
00010 #define PS_CLIP_H
00011 
00012 /// @addtogroup MathOps Mathematical Operations
00013 /// @{
00014 
00015 /// Parameters for clipping
00016 typedef struct
00017 {
00018     psStatsOptions meanStat;            ///< Stats option to use for mean
00019     psStatsOptions stdevStat;           ///< Stats option to use for standard deviation
00020     float fracHigh;                     ///< Fraction of high values to clip
00021     float fracLow;                      ///< Fraction of low values to clip
00022     int numKeep;                        ///< Minimum number of values to keep from clipping
00023     int iter;                           ///< Number of rejection iterations
00024     float rej;                          ///< Rejection limit (standard deviations)
00025     psMaskType masked;                  ///< Mask value for entries already masked
00026     psMaskType clipped;                 ///< Mask value to give to clipped entries
00027     float mean;                         ///< Resultant mean
00028     float stdev;                        ///< Resultant stdev
00029 }
00030 psClipParams;
00031 
00032 
00033 long psClip(psClipParams *params,       ///< Clip parameters
00034             psVector *values,           ///< Values to inspect and clip
00035             psVector *mask,             ///< Mask for values
00036             const psVector *errors      ///< Errors for values
00037            );
00038 
00039 /// @}
00040 #endif

Generated on Fri Feb 2 22:24:35 2007 for pslib by  doxygen 1.5.1