IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 4243


Ignore:
Timestamp:
Jun 13, 2005, 4:54:15 PM (21 years ago)
Author:
drobbin
Message:

* empty log message *

Location:
trunk/psLib/src
Files:
13 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/collections/psMetadata.h

    r4162 r4243  
    1111*  @author Ross Harman, MHPCC
    1212*
    13 *  @version $Revision: 1.47 $ $Name: not supported by cvs2svn $
    14 *  @date $Date: 2005-06-08 23:40:45 $
     13*  @version $Revision: 1.48 $ $Name: not supported by cvs2svn $
     14*  @date $Date: 2005-06-14 02:54:06 $
    1515*
    1616*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    287287 */
    288288psBool psMetadataAddV(
    289     psMetadata* md,                    ///< Metadata collection to insert metadat item.
     289    psMetadata* md,                    ///< Metadata collection to insert metadata item.
    290290    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    291291    const char *name,                  ///< Name of metadata item.
    … …  
    296296#endif // #ifndef SWIG
    297297
    298 psBool psMetadataAddS32(psMetadata* md, psS32 location, const char* name,
    299                         const char* comment, psS32 value);
    300 psBool psMetadataAddF32(psMetadata* md, psS32 location, const char* name,
    301                         const char* comment, psF32 value);
    302 psBool psMetadataAddF64(psMetadata* md, psS32 location, const char* name,
    303                         const char* comment, psF64 value);
    304 psBool psMetadataAddList(psMetadata* md, psS32 location, const char* name,
    305                          const char* comment, psList* value);
    306 psBool psMetadataAddStr(psMetadata* md, psS32 location, const char* name,
    307                         const char* comment, const char* value);
    308 psBool psMetadataAddVector(psMetadata* md, psS32 location, const char* name,
    309                            const char* comment, psVector* value);
    310 psBool psMetadataAddImage(psMetadata* md, psS32 location, const char* name,
    311                           const char* comment, psImage* value);
    312 psBool psMetadataAddHash(psMetadata* md, psS32 location, const char* name,
    313                          const char* comment, psHash* value);
    314 psBool psMetadataAddLookupTable(psMetadata* md, psS32 location, const char* name,
    315                                 const char* comment, psLookupTable* value);
    316 psBool psMetadataAddUnknown(psMetadata* md, psS32 location, const char* name,
    317                             const char* comment, psPtr value);
    318 psBool psMetadataAddMetadata(psMetadata* md, psS32 location, const char* name,
    319                              const char* comment, psMetadata* value);
     298/** Add a psS32 value to metadata collection.
     299 * 
     300 *  @return psBool:  True for success, False for failure.
     301 */
     302psBool psMetadataAddS32(
     303    psMetadata* md,                    ///< Metadata collection to insert metadata item
     304    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     305    const char* name,                  ///< Name of metadata item
     306    const char* comment,               ///< Comment for metadata item
     307    psS32 value                        ///< Value for metadata item data
     308);
     309
     310/** Add a psF32 value to metadata collection.
     311 * 
     312 *  @return psBool:  True for success, False for failure.
     313*/
     314psBool psMetadataAddF32(
     315    psMetadata* md,                    ///< Metadata collection to insert metadata item
     316    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     317    const char* name,                  ///< Name of metadata item
     318    const char* comment,               ///< Comment for metadata item
     319    psF32 value                        ///< Value for metadata item data
     320);
     321
     322/** Add a psF64 value to metadata collection.
     323 * 
     324 *  @return psBool:  True for success, False for failure.
     325*/
     326psBool psMetadataAddF64(
     327    psMetadata* md,                    ///< Metadata collection to insert metadata item
     328    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     329    const char* name,                  ///< Name of metadata item
     330    const char* comment,               ///< Comment for metadata item
     331    psF64 value                        ///< Value for metadata item data
     332);
     333
     334/** Add a psList to metadata collection.
     335 * 
     336 *  @return psBool:  True for success, False for failure.
     337 */
     338psBool psMetadataAddList(
     339    psMetadata* md,                    ///< Metadata collection to insert metadata item
     340    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     341    const char* name,                  ///< Name of metadata item
     342    const char* comment,               ///< Comment for metadata item
     343    psList* value                      ///< psList for metadata item data
     344);
     345
     346/** Add a string to metadata collection.
     347 * 
     348 *  @return psBool:  True for success, False for failure.
     349 */
     350psBool psMetadataAddStr(
     351    psMetadata* md,                    ///< Metadata collection to insert metadata item
     352    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     353    const char* name,                  ///< Name of metadata item
     354    const char* comment,               ///< Comment for metadata item
     355    const char* value                  ///< String for metadata item data
     356);
     357
     358/** Add a vector to metadata collection.
     359 * 
     360 *  @return psBool:  True for success, False for failure.
     361 */
     362psBool psMetadataAddVector(
     363    psMetadata* md,                    ///< Metadata collection to insert metadata item
     364    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     365    const char* name,                  ///< Name of metadata item
     366    const char* comment,               ///< Comment for metadata item
     367    psVector* value                    ///< Vector for metadata item data
     368);
     369
     370/** Add an Image to metadata collection.
     371 * 
     372 *  @return psBool:  True for success, False for failure.
     373 */
     374psBool psMetadataAddImage(
     375    psMetadata* md,                    ///< Metadata collection to insert metadata item
     376    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     377    const char* name,                  ///< Name of metadata item
     378    const char* comment,               ///< Comment for metadata item
     379    psImage* value                     ///< Image for metadata item data
     380);
     381
     382/** Add a Hash to metadata collection.
     383 * 
     384 *  @return psBool:  True for success, False for failure.
     385 */
     386psBool psMetadataAddHash(
     387    psMetadata* md,                    ///< Metadata collection to insert metadata item
     388    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     389    const char* name,                  ///< Name of metadata item
     390    const char* comment,               ///< Comment for metadata item
     391    psHash* value                      ///< Hash for metadata item data
     392);
     393
     394/** Add a LookupTable to metadata collection.
     395 * 
     396 *  @return psBool:  True for success, False for failure.
     397 */
     398psBool psMetadataAddLookupTable(
     399    psMetadata* md,                    ///< Metadata collection to insert metadata item
     400    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     401    const char* name,                  ///< Name of metadata item
     402    const char* comment,               ///< Comment for metadata item
     403    psLookupTable* value               ///< LookupTable for metadata item data
     404);
     405
     406/** Add an Unknown (psPtr) to metadata collection.
     407 * 
     408 *  @return psBool:  True for success, False for failure.
     409 */
     410psBool psMetadataAddUnknown(
     411    psMetadata* md,                    ///< Metadata collection to insert metadata item
     412    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     413    const char* name,                  ///< Name of metadata item
     414    const char* comment,               ///< Comment for metadata item
     415    psPtr value                        ///< Unknown for metadata item data
     416);
     417
     418/** Add Metadata to metadata collection.
     419 * 
     420 *  @return psBool:  True for success, False for failure.
     421 */
     422psBool psMetadataAddMetadata(
     423    psMetadata* md,                    ///< Metadata collection to insert metadata item
     424    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     425    const char* name,                  ///< Name of metadata item
     426    const char* comment,               ///< Comment for metadata item
     427    psMetadata* value                  ///< Metadata for metadata item data
     428);
    320429
    321430/** Remove an item from metadata collection.

  • trunk/psLib/src/collections/psMetadataIO.h

    r4209 r4243  
    1010 *  @author Robert DeSonia, MHPCC
    1111 *
    12  *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2005-06-10 18:09:12 $
     12 *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2005-06-14 02:54:07 $
    1414 *
    1515 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2121/// @{
    2222
     23/** A metadata data structure used in parsing arrays.
     24 * 
     25 *  Contains array information and the metadata storage location.
     26*/
    2327typedef struct
    2428{
    25     psArray*    nonUniqueKeyArray;
    26     psArray*    typeArray;
    27     psArray*    templateArray;
    28     psMetadata* metadata;
    29     char*       name;
     29    psArray*    nonUniqueKeyArray;     ///< non-unique key names
     30    psArray*    typeArray;             ///< array of user defined types
     31    psArray*    templateArray;         ///< array of user type templates
     32    psMetadata* metadata;              ///< metadata container
     33    char*       name;                  ///< name of key
    3034}
    3135p_psParseLevelInfo;
    3236
     37/** Allocates a p_psParseLevelInfo structure
     38 *   
     39 *  @return p_psParseLevelInfo* :   new p_psParseLevelInfo struct
     40 */
    3341p_psParseLevelInfo* p_psParseLevelInfoAlloc(void);
    3442

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

    r4162 r4243  
    88 *  @author GLG, MHPCC
    99 *
    10  *  @version $Revision: 1.43 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2005-06-08 23:40:45 $
     10 *  @version $Revision: 1.44 $ $Name: not supported by cvs2svn $
     11 *  @date $Date: 2005-06-14 02:54:12 $
    1212 *
    1313 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    3737#include "psConstants.h"
    3838
     39/** A psMinimization data structure.
     40 * 
     41 *  Contains numerical analysis parameters/values
     42 */
    3943typedef struct
    4044{
    … …  
    4751psMinimization;
    4852
    49 psMinimization *psMinimizationAlloc(psS32 maxIter,   ///< Number of minimization iterations to perform.
    50                                     psF32 tol        ///< Requested error tolerance
    51                                    );
     53/** Allocates a psMinimization structure.
     54 * 
     55 *  @return psMinimization* :   a new psMinimization struct
     56*/
     57psMinimization *psMinimizationAlloc(
     58    psS32 maxIter,                     ///< Number of minimization iterations to perform.
     59    psF32 tol                          ///< Requested error tolerance
     60);
    5261
    5362/** Derive a polynomial fit.
    … …  
    7180);
    7281
    73 psSpline1D *psVectorFitSpline1D(psSpline1D *mySpline,     ///< The spline which will be generated.
    74                                 const psVector* x,        ///< Ordinates (or NULL to just use the indices)
    75                                 const psVector* y,        ///< Coordinates
    76                                 const psVector* yErr      ///< Errors in coordinates, or NULL
    77                                );
    78 
    79 // XXX: Add Doxygen comments here.
     82/** Derive a one-dimensional spline fit.
     83 *   
     84 *  Given a psSpline1D data structure and a set of x,y vectors, this routine generates
     85 *  the linear splines which satisfy those data points.
     86 * 
     87 *  @return psSpline1D*:  the calculated one-dimensional splines
     88 */
     89psSpline1D *psVectorFitSpline1D(
     90    psSpline1D *mySpline,              ///< The spline which will be generated.
     91    const psVector* x,                 ///< Ordinates (or NULL to just use the indices)
     92    const psVector* y,                 ///< Coordinates
     93    const psVector* yErr               ///< Errors in coordinates, or NULL
     94);
     95
     96/** Defines a Levenberg-Marquardt function of a collection of parameters evaluated at a given position.
     97 * 
     98 *  @return psF64:   a single floating-point value which is the value of the function given the parameters
     99 *      and coordinate vectors, along with the derivatives of the function with respect to each of the parameters.
     100 */
    80101typedef
    81 psF64 (*psMinimizeLMChi2Func)(psVector *deriv,
    82                               psVector *params,
    83                               psVector *x);
    84 
    85 psBool psMinimizeLMChi2(psMinimization *min,
    86                         psImage *covar,
    87                         psVector *params,
    88                         const psVector *paramMask,
    89                         const psArray *x,
    90                         const psVector *y,
    91                         const psVector *yErr,
    92                         psMinimizeLMChi2Func func);
    93 
    94 psBool p_psMinLM_GuessABP (psImage  *Alpha,
    95                            psVector *Beta,
    96                            psVector *Params,
    97                            psImage  *alpha,
    98                            psVector *beta,
    99                            psVector *params,
    100                            psF64 lambda);
    101 
    102 psF64 p_psMinLM_SetABX (psImage  *alpha,
    103                         psVector *beta,
    104                         psVector *params,
    105                         const psArray  *x,
    106                         const psVector *y,
    107                         const psVector *dy,
    108                         psMinimizeLMChi2Func func);
    109 
     102psF64 (*psMinimizeLMChi2Func)(
     103    psVector *deriv,                   ///< derivatives of the function
     104    psVector *params,                  ///< the parameters used to evaluate the function
     105    psVector *x                        ///< positions for evaluation
     106);
     107
     108/** Fits a specified function based on the Levenberg-Marquardt method.
     109 * 
     110 *  @return psBool:   True unless an error occurred.
     111 */
     112psBool psMinimizeLMChi2(
     113    psMinimization *min,               ///<
     114    psImage *covar,                    ///<
     115    psVector *params,                  ///<
     116    const psVector *paramMask,         ///<
     117    const psArray *x,                  ///<
     118    const psVector *y,                 ///<
     119    const psVector *yErr,              ///<
     120    psMinimizeLMChi2Func func          ///<
     121);
     122
     123/**
     124 * 
     125 *
     126 *  @return psBool:   True if
     127 */
     128psBool p_psMinLM_GuessABP(
     129    psImage  *Alpha,                   ///<
     130    psVector *Beta,                    ///<
     131    psVector *Params,                  ///<
     132    psImage  *alpha,                   ///<
     133    psVector *beta,                    ///<
     134    psVector *params,                  ///<
     135    psF64 lambda                       ///<
     136);
     137
     138/**
     139 * 
     140 *
     141 *  @return psF64:   
     142 */
     143psF64 p_psMinLM_SetABX (
     144    psImage  *alpha,                   ///<
     145    psVector *beta,                    ///<
     146    psVector *params,                  ///<
     147    const psArray  *x,                 ///<
     148    const psVector *y,                 ///<
     149    const psVector *dy,                ///<
     150    psMinimizeLMChi2Func func);        ///<
     151
     152/**
     153 * 
     154 * 
     155 *  @return psF32:   
     156*/
    110157typedef
    111 psF32 (*psMinimizePowellFunc)(const psVector *params,
    112                               const psArray *coords);
    113 
    114 psBool psMinimizePowell(psMinimization *min,
    115                         psVector *params,
    116                         const psVector *paramMask,
    117                         const psArray *coords,
    118                         psMinimizePowellFunc func);
    119 
    120 psVector *psMinimizeLMChi2Gauss1D(psImage *deriv,
    121                                   const psVector *params,
    122                                   const psArray *coords);
    123 
    124 psVector *psMinimizePowellChi2Gauss1D(const psVector *params,
    125                                       const psArray *coords);
    126 
     158psF32 (*psMinimizePowellFunc)(
     159    const psVector *params,            ///<
     160    const psArray *coords              ///<
     161);
     162
     163
     164/**
     165 * 
     166 *
     167 *  @return psBool:   True if
     168 */
     169psBool psMinimizePowell(
     170    psMinimization *min,               ///<
     171    psVector *params,                  ///<
     172    const psVector *paramMask,         ///<
     173    const psArray *coords,             ///<
     174    psMinimizePowellFunc func          ///<
     175);
     176
     177/**
     178 * 
     179 *
     180 *  @return psVector*:   
     181 */
     182psVector *psMinimizeLMChi2Gauss1D(
     183    psImage *deriv,                    ///<
     184    const psVector *params,            ///<
     185    const psArray *coords              ///<
     186);
     187
     188/**
     189 * 
     190 *
     191 *  @return psVector*:   
     192 */
     193psVector *psMinimizePowellChi2Gauss1D(
     194    const psVector *params,            ///<
     195    const psArray *coords              ///<
     196);
     197
     198/**
     199 * 
     200 * 
     201 * 
     202*/
    127203typedef
    128 psVector *(*psMinimizeChi2PowellFunc)(const psVector *params,
    129                                       const psArray *coords);
    130 
    131 psBool psMinimizeChi2Powell(psMinimization *min,
    132                             psVector *params,
    133                             const psVector *paramMask,
    134                             const psArray *coords,
    135                             const psVector *value,
    136                             const psVector *error,
    137                             psMinimizeChi2PowellFunc func);
    138 
    139 // XXX EAM : psGaussJordan provided as an alternate to LU Decomp for psMinimizeLMChi2
    140 bool psGaussJordan (psImage *a, psVector *b);
     204psVector *(*psMinimizeChi2PowellFunc)(
     205    const psVector *params,            ///<
     206    const psArray *coords              ///<
     207);
     208
     209
     210/**
     211 * 
     212 *
     213 *  @return psBool:   True if
     214 */
     215psBool psMinimizeChi2Powell(
     216    psMinimization *min,               ///<
     217    psVector *params,                  ///<
     218    const psVector *paramMask,         ///<
     219    const psArray *coords,             ///<
     220    const psVector *value,             ///<
     221    const psVector *error,             ///<
     222    psMinimizeChi2PowellFunc func      ///<
     223);
     224
     225/**
     226 * 
     227 *
     228 *  @return bool:   True if
     229 */
     230bool psGaussJordan(
     231    psImage *a,                        ///<
     232    psVector *b                        ///<
     233);
    141234
    142235/* \} */// End of MathGroup Functions

  • trunk/psLib/src/image/psImageConvolve.h

    r4162 r4243  
    77 *  @author Robert DeSonia, MHPCC
    88 *
    9  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2005-06-08 23:40:45 $
     9 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     10 *  @date $Date: 2005-06-14 02:54:15 $
    1111 *
    1212 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2424#define PS_TYPE_KERNEL_NAME "psF32"    /**< the data type for kernel as a string */
    2525
     26/** Kernel Type
     27 * 
     28 *  A floating-point data type used for storing kernel data.
     29 * 
     30 */
    2631typedef psF32 psKernelType;
    2732
    … …  
    9398    const psVector* yShifts,           ///< list of y-axis shifts
    9499    psBool relative
     100    /**< specifies the starting point for the shifts; true=relative to previous shift
     101     *  false = relative to some other starting point.  */
    95102);
    96103

  • trunk/psLib/src/image/psImageGeomManip.h

    r4214 r4243  
    88 *  @author Robert DeSonia, MHPCC
    99 *
    10  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2005-06-11 02:19:05 $
     10 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     11 *  @date $Date: 2005-06-14 02:54:15 $
    1212 *
    1313 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    119119 *
    120120 *  Transform the input image according the supplied transformation. The size
    121  *  of the transformed image is defined by the supplied output image, if
     121 *  of the transformed image is defined by the supplied output image, if
    122122 *  non-NULL, or the region otherwise (size region.x1 - region.x0 by region.y1
    123123 *  region.y0, with out->x0 = region.x0 and out->y0 = region.y0). If the
    … …  
    149149    int inputMaskVal,                  ///< masking value for inputMask
    150150    const psPlaneTransform *outToIn,   ///< the transform to apply
    151     const psRegion region,             ///<
    152     const psPixels* pixels,            ///<
    153     psImageInterpolateMode mode,       ///<
    154     int exposedValue                   ///<
     151    const psRegion region,             ///< the size of the transformed image
     152    const psPixels* pixels,            /**< if not NULL, consists of psPixelCoords and specifies which pixels in
     153                                             *  output image shall be transformed; otherwise, entire image generated*/
     154    psImageInterpolateMode mode,       ///< the interpolation scheme to be used
     155    int exposedValue                   ///< Exposed value to which non-corresponding pixels are set
    155156);
    156157

  • trunk/psLib/src/image/psImageStats.h

    r4162 r4243  
    99*  @author GLG, MHPCC
    1010*
    11 *  @version $Revision: 1.22 $ $Name: not supported by cvs2svn $
    12 *  @date $Date: 2005-06-08 23:40:45 $
     11*  @version $Revision: 1.23 $ $Name: not supported by cvs2svn $
     12*  @date $Date: 2005-06-14 02:54:15 $
    1313*
    1414*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    6969psPolynomial2D* psImageFitPolynomial(
    7070    psPolynomial2D* coeffs,            ///< coefficient structure carries in desired terms & target
    71     const psImage* input
     71    const psImage* input               ///< input image
    7272);
    7373

  • trunk/psLib/src/imageops/psImageConvolve.h

    r4162 r4243  
    77 *  @author Robert DeSonia, MHPCC
    88 *
    9  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2005-06-08 23:40:45 $
     9 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     10 *  @date $Date: 2005-06-14 02:54:15 $
    1111 *
    1212 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2424#define PS_TYPE_KERNEL_NAME "psF32"    /**< the data type for kernel as a string */
    2525
     26/** Kernel Type
     27 * 
     28 *  A floating-point data type used for storing kernel data.
     29 * 
     30 */
    2631typedef psF32 psKernelType;
    2732
    … …  
    9398    const psVector* yShifts,           ///< list of y-axis shifts
    9499    psBool relative
     100    /**< specifies the starting point for the shifts; true=relative to previous shift
     101     *  false = relative to some other starting point.  */
    95102);
    96103

  • trunk/psLib/src/imageops/psImageGeomManip.h

    r4214 r4243  
    88 *  @author Robert DeSonia, MHPCC
    99 *
    10  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2005-06-11 02:19:05 $
     10 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     11 *  @date $Date: 2005-06-14 02:54:15 $
    1212 *
    1313 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    119119 *
    120120 *  Transform the input image according the supplied transformation. The size
    121  *  of the transformed image is defined by the supplied output image, if
     121 *  of the transformed image is defined by the supplied output image, if
    122122 *  non-NULL, or the region otherwise (size region.x1 - region.x0 by region.y1
    123123 *  region.y0, with out->x0 = region.x0 and out->y0 = region.y0). If the
    … …  
    149149    int inputMaskVal,                  ///< masking value for inputMask
    150150    const psPlaneTransform *outToIn,   ///< the transform to apply
    151     const psRegion region,             ///<
    152     const psPixels* pixels,            ///<
    153     psImageInterpolateMode mode,       ///<
    154     int exposedValue                   ///<
     151    const psRegion region,             ///< the size of the transformed image
     152    const psPixels* pixels,            /**< if not NULL, consists of psPixelCoords and specifies which pixels in
     153                                             *  output image shall be transformed; otherwise, entire image generated*/
     154    psImageInterpolateMode mode,       ///< the interpolation scheme to be used
     155    int exposedValue                   ///< Exposed value to which non-corresponding pixels are set
    155156);
    156157

  • trunk/psLib/src/imageops/psImageStats.h

    r4162 r4243  
    99*  @author GLG, MHPCC
    1010*
    11 *  @version $Revision: 1.22 $ $Name: not supported by cvs2svn $
    12 *  @date $Date: 2005-06-08 23:40:45 $
     11*  @version $Revision: 1.23 $ $Name: not supported by cvs2svn $
     12*  @date $Date: 2005-06-14 02:54:15 $
    1313*
    1414*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    6969psPolynomial2D* psImageFitPolynomial(
    7070    psPolynomial2D* coeffs,            ///< coefficient structure carries in desired terms & target
    71     const psImage* input
     71    const psImage* input               ///< input image
    7272);
    7373

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

    r4162 r4243  
    88 *  @author GLG, MHPCC
    99 *
    10  *  @version $Revision: 1.43 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2005-06-08 23:40:45 $
     10 *  @version $Revision: 1.44 $ $Name: not supported by cvs2svn $
     11 *  @date $Date: 2005-06-14 02:54:12 $
    1212 *
    1313 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    3737#include "psConstants.h"
    3838
     39/** A psMinimization data structure.
     40 * 
     41 *  Contains numerical analysis parameters/values
     42 */
    3943typedef struct
    4044{
    … …  
    4751psMinimization;
    4852
    49 psMinimization *psMinimizationAlloc(psS32 maxIter,   ///< Number of minimization iterations to perform.
    50                                     psF32 tol        ///< Requested error tolerance
    51                                    );
     53/** Allocates a psMinimization structure.
     54 * 
     55 *  @return psMinimization* :   a new psMinimization struct
     56*/
     57psMinimization *psMinimizationAlloc(
     58    psS32 maxIter,                     ///< Number of minimization iterations to perform.
     59    psF32 tol                          ///< Requested error tolerance
     60);
    5261
    5362/** Derive a polynomial fit.
    … …  
    7180);
    7281
    73 psSpline1D *psVectorFitSpline1D(psSpline1D *mySpline,     ///< The spline which will be generated.
    74                                 const psVector* x,        ///< Ordinates (or NULL to just use the indices)
    75                                 const psVector* y,        ///< Coordinates
    76                                 const psVector* yErr      ///< Errors in coordinates, or NULL
    77                                );
    78 
    79 // XXX: Add Doxygen comments here.
     82/** Derive a one-dimensional spline fit.
     83 *   
     84 *  Given a psSpline1D data structure and a set of x,y vectors, this routine generates
     85 *  the linear splines which satisfy those data points.
     86 * 
     87 *  @return psSpline1D*:  the calculated one-dimensional splines
     88 */
     89psSpline1D *psVectorFitSpline1D(
     90    psSpline1D *mySpline,              ///< The spline which will be generated.
     91    const psVector* x,                 ///< Ordinates (or NULL to just use the indices)
     92    const psVector* y,                 ///< Coordinates
     93    const psVector* yErr               ///< Errors in coordinates, or NULL
     94);
     95
     96/** Defines a Levenberg-Marquardt function of a collection of parameters evaluated at a given position.
     97 * 
     98 *  @return psF64:   a single floating-point value which is the value of the function given the parameters
     99 *      and coordinate vectors, along with the derivatives of the function with respect to each of the parameters.
     100 */
    80101typedef
    81 psF64 (*psMinimizeLMChi2Func)(psVector *deriv,
    82                               psVector *params,
    83                               psVector *x);
    84 
    85 psBool psMinimizeLMChi2(psMinimization *min,
    86                         psImage *covar,
    87                         psVector *params,
    88                         const psVector *paramMask,
    89                         const psArray *x,
    90                         const psVector *y,
    91                         const psVector *yErr,
    92                         psMinimizeLMChi2Func func);
    93 
    94 psBool p_psMinLM_GuessABP (psImage  *Alpha,
    95                            psVector *Beta,
    96                            psVector *Params,
    97                            psImage  *alpha,
    98                            psVector *beta,
    99                            psVector *params,
    100                            psF64 lambda);
    101 
    102 psF64 p_psMinLM_SetABX (psImage  *alpha,
    103                         psVector *beta,
    104                         psVector *params,
    105                         const psArray  *x,
    106                         const psVector *y,
    107                         const psVector *dy,
    108                         psMinimizeLMChi2Func func);
    109 
     102psF64 (*psMinimizeLMChi2Func)(
     103    psVector *deriv,                   ///< derivatives of the function
     104    psVector *params,                  ///< the parameters used to evaluate the function
     105    psVector *x                        ///< positions for evaluation
     106);
     107
     108/** Fits a specified function based on the Levenberg-Marquardt method.
     109 * 
     110 *  @return psBool:   True unless an error occurred.
     111 */
     112psBool psMinimizeLMChi2(
     113    psMinimization *min,               ///<
     114    psImage *covar,                    ///<
     115    psVector *params,                  ///<
     116    const psVector *paramMask,         ///<
     117    const psArray *x,                  ///<
     118    const psVector *y,                 ///<
     119    const psVector *yErr,              ///<
     120    psMinimizeLMChi2Func func          ///<
     121);
     122
     123/**
     124 * 
     125 *
     126 *  @return psBool:   True if
     127 */
     128psBool p_psMinLM_GuessABP(
     129    psImage  *Alpha,                   ///<
     130    psVector *Beta,                    ///<
     131    psVector *Params,                  ///<
     132    psImage  *alpha,                   ///<
     133    psVector *beta,                    ///<
     134    psVector *params,                  ///<
     135    psF64 lambda                       ///<
     136);
     137
     138/**
     139 * 
     140 *
     141 *  @return psF64:   
     142 */
     143psF64 p_psMinLM_SetABX (
     144    psImage  *alpha,                   ///<
     145    psVector *beta,                    ///<
     146    psVector *params,                  ///<
     147    const psArray  *x,                 ///<
     148    const psVector *y,                 ///<
     149    const psVector *dy,                ///<
     150    psMinimizeLMChi2Func func);        ///<
     151
     152/**
     153 * 
     154 * 
     155 *  @return psF32:   
     156*/
    110157typedef
    111 psF32 (*psMinimizePowellFunc)(const psVector *params,
    112                               const psArray *coords);
    113 
    114 psBool psMinimizePowell(psMinimization *min,
    115                         psVector *params,
    116                         const psVector *paramMask,
    117                         const psArray *coords,
    118                         psMinimizePowellFunc func);
    119 
    120 psVector *psMinimizeLMChi2Gauss1D(psImage *deriv,
    121                                   const psVector *params,
    122                                   const psArray *coords);
    123 
    124 psVector *psMinimizePowellChi2Gauss1D(const psVector *params,
    125                                       const psArray *coords);
    126 
     158psF32 (*psMinimizePowellFunc)(
     159    const psVector *params,            ///<
     160    const psArray *coords              ///<
     161);
     162
     163
     164/**
     165 * 
     166 *
     167 *  @return psBool:   True if
     168 */
     169psBool psMinimizePowell(
     170    psMinimization *min,               ///<
     171    psVector *params,                  ///<
     172    const psVector *paramMask,         ///<
     173    const psArray *coords,             ///<
     174    psMinimizePowellFunc func          ///<
     175);
     176
     177/**
     178 * 
     179 *
     180 *  @return psVector*:   
     181 */
     182psVector *psMinimizeLMChi2Gauss1D(
     183    psImage *deriv,                    ///<
     184    const psVector *params,            ///<
     185    const psArray *coords              ///<
     186);
     187
     188/**
     189 * 
     190 *
     191 *  @return psVector*:   
     192 */
     193psVector *psMinimizePowellChi2Gauss1D(
     194    const psVector *params,            ///<
     195    const psArray *coords              ///<
     196);
     197
     198/**
     199 * 
     200 * 
     201 * 
     202*/
    127203typedef
    128 psVector *(*psMinimizeChi2PowellFunc)(const psVector *params,
    129                                       const psArray *coords);
    130 
    131 psBool psMinimizeChi2Powell(psMinimization *min,
    132                             psVector *params,
    133                             const psVector *paramMask,
    134                             const psArray *coords,
    135                             const psVector *value,
    136                             const psVector *error,
    137                             psMinimizeChi2PowellFunc func);
    138 
    139 // XXX EAM : psGaussJordan provided as an alternate to LU Decomp for psMinimizeLMChi2
    140 bool psGaussJordan (psImage *a, psVector *b);
     204psVector *(*psMinimizeChi2PowellFunc)(
     205    const psVector *params,            ///<
     206    const psArray *coords              ///<
     207);
     208
     209
     210/**
     211 * 
     212 *
     213 *  @return psBool:   True if
     214 */
     215psBool psMinimizeChi2Powell(
     216    psMinimization *min,               ///<
     217    psVector *params,                  ///<
     218    const psVector *paramMask,         ///<
     219    const psArray *coords,             ///<
     220    const psVector *value,             ///<
     221    const psVector *error,             ///<
     222    psMinimizeChi2PowellFunc func      ///<
     223);
     224
     225/**
     226 * 
     227 *
     228 *  @return bool:   True if
     229 */
     230bool psGaussJordan(
     231    psImage *a,                        ///<
     232    psVector *b                        ///<
     233);
    141234
    142235/* \} */// End of MathGroup Functions

  • trunk/psLib/src/types/psMetadata.h

    r4162 r4243  
    1111*  @author Ross Harman, MHPCC
    1212*
    13 *  @version $Revision: 1.47 $ $Name: not supported by cvs2svn $
    14 *  @date $Date: 2005-06-08 23:40:45 $
     13*  @version $Revision: 1.48 $ $Name: not supported by cvs2svn $
     14*  @date $Date: 2005-06-14 02:54:06 $
    1515*
    1616*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    287287 */
    288288psBool psMetadataAddV(
    289     psMetadata* md,                    ///< Metadata collection to insert metadat item.
     289    psMetadata* md,                    ///< Metadata collection to insert metadata item.
    290290    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    291291    const char *name,                  ///< Name of metadata item.
    … …  
    296296#endif // #ifndef SWIG
    297297
    298 psBool psMetadataAddS32(psMetadata* md, psS32 location, const char* name,
    299                         const char* comment, psS32 value);
    300 psBool psMetadataAddF32(psMetadata* md, psS32 location, const char* name,
    301                         const char* comment, psF32 value);
    302 psBool psMetadataAddF64(psMetadata* md, psS32 location, const char* name,
    303                         const char* comment, psF64 value);
    304 psBool psMetadataAddList(psMetadata* md, psS32 location, const char* name,
    305                          const char* comment, psList* value);
    306 psBool psMetadataAddStr(psMetadata* md, psS32 location, const char* name,
    307                         const char* comment, const char* value);
    308 psBool psMetadataAddVector(psMetadata* md, psS32 location, const char* name,
    309                            const char* comment, psVector* value);
    310 psBool psMetadataAddImage(psMetadata* md, psS32 location, const char* name,
    311                           const char* comment, psImage* value);
    312 psBool psMetadataAddHash(psMetadata* md, psS32 location, const char* name,
    313                          const char* comment, psHash* value);
    314 psBool psMetadataAddLookupTable(psMetadata* md, psS32 location, const char* name,
    315                                 const char* comment, psLookupTable* value);
    316 psBool psMetadataAddUnknown(psMetadata* md, psS32 location, const char* name,
    317                             const char* comment, psPtr value);
    318 psBool psMetadataAddMetadata(psMetadata* md, psS32 location, const char* name,
    319                              const char* comment, psMetadata* value);
     298/** Add a psS32 value to metadata collection.
     299 * 
     300 *  @return psBool:  True for success, False for failure.
     301 */
     302psBool psMetadataAddS32(
     303    psMetadata* md,                    ///< Metadata collection to insert metadata item
     304    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     305    const char* name,                  ///< Name of metadata item
     306    const char* comment,               ///< Comment for metadata item
     307    psS32 value                        ///< Value for metadata item data
     308);
     309
     310/** Add a psF32 value to metadata collection.
     311 * 
     312 *  @return psBool:  True for success, False for failure.
     313*/
     314psBool psMetadataAddF32(
     315    psMetadata* md,                    ///< Metadata collection to insert metadata item
     316    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     317    const char* name,                  ///< Name of metadata item
     318    const char* comment,               ///< Comment for metadata item
     319    psF32 value                        ///< Value for metadata item data
     320);
     321
     322/** Add a psF64 value to metadata collection.
     323 * 
     324 *  @return psBool:  True for success, False for failure.
     325*/
     326psBool psMetadataAddF64(
     327    psMetadata* md,                    ///< Metadata collection to insert metadata item
     328    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     329    const char* name,                  ///< Name of metadata item
     330    const char* comment,               ///< Comment for metadata item
     331    psF64 value                        ///< Value for metadata item data
     332);
     333
     334/** Add a psList to metadata collection.
     335 * 
     336 *  @return psBool:  True for success, False for failure.
     337 */
     338psBool psMetadataAddList(
     339    psMetadata* md,                    ///< Metadata collection to insert metadata item
     340    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     341    const char* name,                  ///< Name of metadata item
     342    const char* comment,               ///< Comment for metadata item
     343    psList* value                      ///< psList for metadata item data
     344);
     345
     346/** Add a string to metadata collection.
     347 * 
     348 *  @return psBool:  True for success, False for failure.
     349 */
     350psBool psMetadataAddStr(
     351    psMetadata* md,                    ///< Metadata collection to insert metadata item
     352    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     353    const char* name,                  ///< Name of metadata item
     354    const char* comment,               ///< Comment for metadata item
     355    const char* value                  ///< String for metadata item data
     356);
     357
     358/** Add a vector to metadata collection.
     359 * 
     360 *  @return psBool:  True for success, False for failure.
     361 */
     362psBool psMetadataAddVector(
     363    psMetadata* md,                    ///< Metadata collection to insert metadata item
     364    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     365    const char* name,                  ///< Name of metadata item
     366    const char* comment,               ///< Comment for metadata item
     367    psVector* value                    ///< Vector for metadata item data
     368);
     369
     370/** Add an Image to metadata collection.
     371 * 
     372 *  @return psBool:  True for success, False for failure.
     373 */
     374psBool psMetadataAddImage(
     375    psMetadata* md,                    ///< Metadata collection to insert metadata item
     376    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     377    const char* name,                  ///< Name of metadata item
     378    const char* comment,               ///< Comment for metadata item
     379    psImage* value                     ///< Image for metadata item data
     380);
     381
     382/** Add a Hash to metadata collection.
     383 * 
     384 *  @return psBool:  True for success, False for failure.
     385 */
     386psBool psMetadataAddHash(
     387    psMetadata* md,                    ///< Metadata collection to insert metadata item
     388    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     389    const char* name,                  ///< Name of metadata item
     390    const char* comment,               ///< Comment for metadata item
     391    psHash* value                      ///< Hash for metadata item data
     392);
     393
     394/** Add a LookupTable to metadata collection.
     395 * 
     396 *  @return psBool:  True for success, False for failure.
     397 */
     398psBool psMetadataAddLookupTable(
     399    psMetadata* md,                    ///< Metadata collection to insert metadata item
     400    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     401    const char* name,                  ///< Name of metadata item
     402    const char* comment,               ///< Comment for metadata item
     403    psLookupTable* value               ///< LookupTable for metadata item data
     404);
     405
     406/** Add an Unknown (psPtr) to metadata collection.
     407 * 
     408 *  @return psBool:  True for success, False for failure.
     409 */
     410psBool psMetadataAddUnknown(
     411    psMetadata* md,                    ///< Metadata collection to insert metadata item
     412    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     413    const char* name,                  ///< Name of metadata item
     414    const char* comment,               ///< Comment for metadata item
     415    psPtr value                        ///< Unknown for metadata item data
     416);
     417
     418/** Add Metadata to metadata collection.
     419 * 
     420 *  @return psBool:  True for success, False for failure.
     421 */
     422psBool psMetadataAddMetadata(
     423    psMetadata* md,                    ///< Metadata collection to insert metadata item
     424    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     425    const char* name,                  ///< Name of metadata item
     426    const char* comment,               ///< Comment for metadata item
     427    psMetadata* value                  ///< Metadata for metadata item data
     428);
    320429
    321430/** Remove an item from metadata collection.

  • trunk/psLib/src/types/psMetadataConfig.h

    r4209 r4243  
    1010 *  @author Robert DeSonia, MHPCC
    1111 *
    12  *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2005-06-10 18:09:12 $
     12 *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2005-06-14 02:54:07 $
    1414 *
    1515 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2121/// @{
    2222
     23/** A metadata data structure used in parsing arrays.
     24 * 
     25 *  Contains array information and the metadata storage location.
     26*/
    2327typedef struct
    2428{
    25     psArray*    nonUniqueKeyArray;
    26     psArray*    typeArray;
    27     psArray*    templateArray;
    28     psMetadata* metadata;
    29     char*       name;
     29    psArray*    nonUniqueKeyArray;     ///< non-unique key names
     30    psArray*    typeArray;             ///< array of user defined types
     31    psArray*    templateArray;         ///< array of user type templates
     32    psMetadata* metadata;              ///< metadata container
     33    char*       name;                  ///< name of key
    3034}
    3135p_psParseLevelInfo;
    3236
     37/** Allocates a p_psParseLevelInfo structure
     38 *   
     39 *  @return p_psParseLevelInfo* :   new p_psParseLevelInfo struct
     40 */
    3341p_psParseLevelInfo* p_psParseLevelInfoAlloc(void);
    3442

  • trunk/psLib/src/xml/psXML.h

    r4209 r4243  
    1010 *  @author Robert DeSonia, MHPCC
    1111 *
    12  *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2005-06-10 18:09:12 $
     12 *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2005-06-14 02:54:07 $
    1414 *
    1515 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2121/// @{
    2222
     23/** A metadata data structure used in parsing arrays.
     24 * 
     25 *  Contains array information and the metadata storage location.
     26*/
    2327typedef struct
    2428{
    25     psArray*    nonUniqueKeyArray;
    26     psArray*    typeArray;
    27     psArray*    templateArray;
    28     psMetadata* metadata;
    29     char*       name;
     29    psArray*    nonUniqueKeyArray;     ///< non-unique key names
     30    psArray*    typeArray;             ///< array of user defined types
     31    psArray*    templateArray;         ///< array of user type templates
     32    psMetadata* metadata;              ///< metadata container
     33    char*       name;                  ///< name of key
    3034}
    3135p_psParseLevelInfo;
    3236
     37/** Allocates a p_psParseLevelInfo structure
     38 *   
     39 *  @return p_psParseLevelInfo* :   new p_psParseLevelInfo struct
     40 */
    3341p_psParseLevelInfo* p_psParseLevelInfoAlloc(void);
    3442
Note: See TracChangeset for help on using the changeset viewer.