IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 1470


Ignore:
Timestamp:
Aug 11, 2004, 9:16:04 AM (22 years ago)
Author:
desonia
Message:

doxygen comment cleanup.

Location:
trunk/psLib/src
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/dataManip/psMinimize.h

    r1469 r1470  
    2727 *
    2828 *  @return float     the derivative in respect to params[derivParam]
     29 */
    2930typedef float (*psMinimizeFunctionDeriv) (
    3031    const psVector* restrict params,   ///< collection of parameters
    … …  
    3233    int derivParam                     ///< index of parameter to calculate derivative of
    3334);
    34  
     35
    3536/** Minimizes a non-linear function.
    3637 *

  • trunk/psLib/src/dataManip/psStats.h

    r1441 r1470  
    1010 *  @author George Gusciora, MHPCC
    1111 *
    12  *  @version $Revision: 1.24 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-08-09 23:40:55 $
     12 *  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2004-08-11 19:16:04 $
    1414 *
    1515 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    2626    Statistical functions and data structures.
    2727 *****************************************************************************/
     28
     29/** enumeration of statistical calculation options
     30 *
     31 *  @see psStats, psVectorStats, psImageStats
     32 */
    2833typedef enum {
    2934    PS_STAT_SAMPLE_MEAN = 0x000001,
    … …  
    4651
    4752/** This is the generic statistics structure.  It contails the data members
    48     for the various statistic values.  It contains the options member to
    49     specifiy which statistics must be calculated. */
     53    for the various statistic values.  It also contains the options member to
     54    specifiy which statistics should be calculated. */
    5055typedef struct
    5156{
    … …  
    7681psStats;
    7782
    78 /** Do Statistics on an array.  Returns a status value. \ingroup MathGroup */
    79 psStats* psVectorStats(psStats* stats, ///< stats structure defines stats to be calculated and how
    80                        psVector* in,   ///< Vector to be analysed: must be F32
    81                        psVector* mask, ///< Ignore elements where (maskVector & maskVal) != 0: must be INT
    82                        // or NULL
    83                        unsigned int maskVal     ///< Only mask elements with one of these bits set in
    84                        // maskVector
    85                       );
     83/** Performs statistical calculations on a vector.
     84 *
     85 *  @return psStats*    the statistical results as specified by stats->options
     86 */
     87psStats* psVectorStats(
     88    psStats* stats,
     89    ///< stats structure defines stats to be calculated and how
    8690
    87 /** A constructor for the stats structure.*/
    88 psStats* psStatsAlloc(psStatsOptions options);  ///< Statistics to measure
     91    psVector* in,
     92    ///< Vector to be analysed: must be F32
     93
     94    psVector* mask,
     95    ///< Ignore elements where (maskVector & maskVal) != 0: must be INT or NULL
     96
     97    unsigned int maskVal
     98    ///< Only mask elements with one of these bits set in maskVector
     99);
     100
     101/** Allocator of the psStats structure.
     102 *
     103 *  @return psStats*    A new psStats struct with the options member set to the
     104 *                      value given.
     105 */
     106psStats* psStatsAlloc(
     107    psStatsOptions options             ///< Statistics to calculate
     108);
    89109
    90110/******************************************************************************
    … …  
    92112 *****************************************************************************/
    93113
    94 /** The basic histogram structure which contains bounds and bins. */
     114/** The basic histogram structure which contains bounds and bins.
     115 *
     116 *  In this structure, the vector bounds specifies the boundaries of the
     117 *  histogram bins, and must of type psF32, while nums specifies the number
     118 *  of entries in the bin, and must of type psU32. The value of bounds.n must
     119 *  therefore be 1 greater than than nums.n. The two values minNum and maxNum
     120 *  are the number of data values which fell below the lower limit bound or
     121 *  above the upper limit bound, respectively.
     122 */
    95123typedef struct
    96124{
    97     psVector* bounds;           ///< Bounds for the bins (type F32)
    98     psVector* nums;             ///< Number in each of the bins (INT)
    99     int minNum;                 ///< Number below the minimum
    100     int maxNum;                 ///< Number above the maximum
    101     bool uniform;               ///< Is it a uniform distribution?
     125    psVector* bounds;                  ///< Bounds for the bins (type F32)
     126    psVector* nums;                    ///< Number in each of the bins (INT)
     127    int minNum;                        ///< Number below the minimum
     128    int maxNum;                        ///< Number above the maximum
     129    bool uniform;                      ///< Is it a uniform distribution?
    102130}
    103131psHistogram;
    104132
    105 /** Constructor \ingroup MathGroup */
    106 psHistogram* psHistogramAlloc(float lower,      ///< Lower limit for the bins
    107                               float upper,      ///< Upper limit for the bins
    108                               int n);   ///< Number of bins
     133/** Allocator for psHistogram where the bounds of the bins are implicitly
     134 *  specified through simply specifying an upper and lower limit along with
     135 *  the size of the bins.
     136 *
     137 *  @return psHistogram*    Newly allocated psHistogram
     138 */
     139psHistogram* psHistogramAlloc(
     140    float lower,                       ///< Lower limit for the bins
     141    float upper,                       ///< Upper limit for the bins
     142    int n                              ///< Number of bins
     143);
    109144
    110 /** Generic constructor \ingroup MathGroup */
    111 psHistogram* psHistogramAllocGeneric(const psVector* restrict bounds); ///< Bounds for the bins
     145/** Allocator for psHistogram where the bounds of the bins are explicitly
     146 *  specified.
     147 *
     148 *  @return psHistogram*    Newly allocated psHistogram
     149 */
     150psHistogram* psHistogramAllocGeneric(
     151    const psVector* restrict bounds    ///< Bounds for the bins
     152);
    112153
    113 /** Calculate a histogram \ingroup MathGroup **/
    114 psHistogram* psVectorHistogram(psHistogram* out,       ///< Histogram data
    115                                const psVector* restrict in,    ///< Vector to analyse
    116                                const psVector* restrict mask,  ///< Mask dat for input vector
    117                                unsigned int maskVal);   ///< Mask value
     154/** Calculate a histogram
     155 *
     156 *  The following function populates the histogram bins from the specified
     157 *  vector (in). It alters and returns the histogram out structure. The input
     158 *  vector may be of types psU8, psU16, psF32, psF64.
     159 *
     160 *  @return psHistogram*   histogram result
     161 */
     162psHistogram* psVectorHistogram(
     163    psHistogram* out,                  ///< Histogram data
     164    const psVector* restrict in,       ///< Vector to analyse
     165    const psVector* restrict mask,     ///< Mask dat for input vector
     166    unsigned int maskVal               ///< Mask value
     167);
    118168
    119 bool p_psGetStatValue(const psStats* stats, double *value);
     169/** Extracts the statistic value specified by stats->options.
     170 *
     171 *  @return bool    If more than one statistic result is set in stats->options,
     172 *                  false is returned and the value parameter is not set,
     173 *                  otherwise true is returned.
     174 */
     175bool p_psGetStatValue(
     176    const psStats* stats,
     177    ///< the statistic struct to operate on
     178
     179    double *value
     180    ///< if return is true, this is set to the specified statistic value by stats->options
     181);
    120182
    121183/// @}

  • trunk/psLib/src/math/psMinimize.h

    r1469 r1470  
    2727 *
    2828 *  @return float     the derivative in respect to params[derivParam]
     29 */
    2930typedef float (*psMinimizeFunctionDeriv) (
    3031    const psVector* restrict params,   ///< collection of parameters
    … …  
    3233    int derivParam                     ///< index of parameter to calculate derivative of
    3334);
    34  
     35
    3536/** Minimizes a non-linear function.
    3637 *

  • trunk/psLib/src/math/psStats.h

    r1441 r1470  
    1010 *  @author George Gusciora, MHPCC
    1111 *
    12  *  @version $Revision: 1.24 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-08-09 23:40:55 $
     12 *  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2004-08-11 19:16:04 $
    1414 *
    1515 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    2626    Statistical functions and data structures.
    2727 *****************************************************************************/
     28
     29/** enumeration of statistical calculation options
     30 *
     31 *  @see psStats, psVectorStats, psImageStats
     32 */
    2833typedef enum {
    2934    PS_STAT_SAMPLE_MEAN = 0x000001,
    … …  
    4651
    4752/** This is the generic statistics structure.  It contails the data members
    48     for the various statistic values.  It contains the options member to
    49     specifiy which statistics must be calculated. */
     53    for the various statistic values.  It also contains the options member to
     54    specifiy which statistics should be calculated. */
    5055typedef struct
    5156{
    … …  
    7681psStats;
    7782
    78 /** Do Statistics on an array.  Returns a status value. \ingroup MathGroup */
    79 psStats* psVectorStats(psStats* stats, ///< stats structure defines stats to be calculated and how
    80                        psVector* in,   ///< Vector to be analysed: must be F32
    81                        psVector* mask, ///< Ignore elements where (maskVector & maskVal) != 0: must be INT
    82                        // or NULL
    83                        unsigned int maskVal     ///< Only mask elements with one of these bits set in
    84                        // maskVector
    85                       );
     83/** Performs statistical calculations on a vector.
     84 *
     85 *  @return psStats*    the statistical results as specified by stats->options
     86 */
     87psStats* psVectorStats(
     88    psStats* stats,
     89    ///< stats structure defines stats to be calculated and how
    8690
    87 /** A constructor for the stats structure.*/
    88 psStats* psStatsAlloc(psStatsOptions options);  ///< Statistics to measure
     91    psVector* in,
     92    ///< Vector to be analysed: must be F32
     93
     94    psVector* mask,
     95    ///< Ignore elements where (maskVector & maskVal) != 0: must be INT or NULL
     96
     97    unsigned int maskVal
     98    ///< Only mask elements with one of these bits set in maskVector
     99);
     100
     101/** Allocator of the psStats structure.
     102 *
     103 *  @return psStats*    A new psStats struct with the options member set to the
     104 *                      value given.
     105 */
     106psStats* psStatsAlloc(
     107    psStatsOptions options             ///< Statistics to calculate
     108);
    89109
    90110/******************************************************************************
    … …  
    92112 *****************************************************************************/
    93113
    94 /** The basic histogram structure which contains bounds and bins. */
     114/** The basic histogram structure which contains bounds and bins.
     115 *
     116 *  In this structure, the vector bounds specifies the boundaries of the
     117 *  histogram bins, and must of type psF32, while nums specifies the number
     118 *  of entries in the bin, and must of type psU32. The value of bounds.n must
     119 *  therefore be 1 greater than than nums.n. The two values minNum and maxNum
     120 *  are the number of data values which fell below the lower limit bound or
     121 *  above the upper limit bound, respectively.
     122 */
    95123typedef struct
    96124{
    97     psVector* bounds;           ///< Bounds for the bins (type F32)
    98     psVector* nums;             ///< Number in each of the bins (INT)
    99     int minNum;                 ///< Number below the minimum
    100     int maxNum;                 ///< Number above the maximum
    101     bool uniform;               ///< Is it a uniform distribution?
     125    psVector* bounds;                  ///< Bounds for the bins (type F32)
     126    psVector* nums;                    ///< Number in each of the bins (INT)
     127    int minNum;                        ///< Number below the minimum
     128    int maxNum;                        ///< Number above the maximum
     129    bool uniform;                      ///< Is it a uniform distribution?
    102130}
    103131psHistogram;
    104132
    105 /** Constructor \ingroup MathGroup */
    106 psHistogram* psHistogramAlloc(float lower,      ///< Lower limit for the bins
    107                               float upper,      ///< Upper limit for the bins
    108                               int n);   ///< Number of bins
     133/** Allocator for psHistogram where the bounds of the bins are implicitly
     134 *  specified through simply specifying an upper and lower limit along with
     135 *  the size of the bins.
     136 *
     137 *  @return psHistogram*    Newly allocated psHistogram
     138 */
     139psHistogram* psHistogramAlloc(
     140    float lower,                       ///< Lower limit for the bins
     141    float upper,                       ///< Upper limit for the bins
     142    int n                              ///< Number of bins
     143);
    109144
    110 /** Generic constructor \ingroup MathGroup */
    111 psHistogram* psHistogramAllocGeneric(const psVector* restrict bounds); ///< Bounds for the bins
     145/** Allocator for psHistogram where the bounds of the bins are explicitly
     146 *  specified.
     147 *
     148 *  @return psHistogram*    Newly allocated psHistogram
     149 */
     150psHistogram* psHistogramAllocGeneric(
     151    const psVector* restrict bounds    ///< Bounds for the bins
     152);
    112153
    113 /** Calculate a histogram \ingroup MathGroup **/
    114 psHistogram* psVectorHistogram(psHistogram* out,       ///< Histogram data
    115                                const psVector* restrict in,    ///< Vector to analyse
    116                                const psVector* restrict mask,  ///< Mask dat for input vector
    117                                unsigned int maskVal);   ///< Mask value
     154/** Calculate a histogram
     155 *
     156 *  The following function populates the histogram bins from the specified
     157 *  vector (in). It alters and returns the histogram out structure. The input
     158 *  vector may be of types psU8, psU16, psF32, psF64.
     159 *
     160 *  @return psHistogram*   histogram result
     161 */
     162psHistogram* psVectorHistogram(
     163    psHistogram* out,                  ///< Histogram data
     164    const psVector* restrict in,       ///< Vector to analyse
     165    const psVector* restrict mask,     ///< Mask dat for input vector
     166    unsigned int maskVal               ///< Mask value
     167);
    118168
    119 bool p_psGetStatValue(const psStats* stats, double *value);
     169/** Extracts the statistic value specified by stats->options.
     170 *
     171 *  @return bool    If more than one statistic result is set in stats->options,
     172 *                  false is returned and the value parameter is not set,
     173 *                  otherwise true is returned.
     174 */
     175bool p_psGetStatValue(
     176    const psStats* stats,
     177    ///< the statistic struct to operate on
     178
     179    double *value
     180    ///< if return is true, this is set to the specified statistic value by stats->options
     181);
    120182
    121183/// @}
Note: See TracChangeset for help on using the changeset viewer.