Index: trunk/psLib/src/collections/psMetadata.h =================================================================== --- trunk/psLib/src/collections/psMetadata.h (revision 4235) +++ trunk/psLib/src/collections/psMetadata.h (revision 4243) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * -* @version $Revision: 1.47 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-08 23:40:45 $ +* @version $Revision: 1.48 $ $Name: not supported by cvs2svn $ +* @date $Date: 2005-06-14 02:54:06 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -287,5 +287,5 @@ */ psBool psMetadataAddV( - psMetadata* md, ///< Metadata collection to insert metadat item. + psMetadata* md, ///< Metadata collection to insert metadata item. psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL const char *name, ///< Name of metadata item. @@ -296,26 +296,135 @@ #endif // #ifndef SWIG -psBool psMetadataAddS32(psMetadata* md, psS32 location, const char* name, - const char* comment, psS32 value); -psBool psMetadataAddF32(psMetadata* md, psS32 location, const char* name, - const char* comment, psF32 value); -psBool psMetadataAddF64(psMetadata* md, psS32 location, const char* name, - const char* comment, psF64 value); -psBool psMetadataAddList(psMetadata* md, psS32 location, const char* name, - const char* comment, psList* value); -psBool psMetadataAddStr(psMetadata* md, psS32 location, const char* name, - const char* comment, const char* value); -psBool psMetadataAddVector(psMetadata* md, psS32 location, const char* name, - const char* comment, psVector* value); -psBool psMetadataAddImage(psMetadata* md, psS32 location, const char* name, - const char* comment, psImage* value); -psBool psMetadataAddHash(psMetadata* md, psS32 location, const char* name, - const char* comment, psHash* value); -psBool psMetadataAddLookupTable(psMetadata* md, psS32 location, const char* name, - const char* comment, psLookupTable* value); -psBool psMetadataAddUnknown(psMetadata* md, psS32 location, const char* name, - const char* comment, psPtr value); -psBool psMetadataAddMetadata(psMetadata* md, psS32 location, const char* name, - const char* comment, psMetadata* value); +/** Add a psS32 value to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddS32( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psS32 value ///< Value for metadata item data +); + +/** Add a psF32 value to metadata collection. + * + * @return psBool: True for success, False for failure. +*/ +psBool psMetadataAddF32( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psF32 value ///< Value for metadata item data +); + +/** Add a psF64 value to metadata collection. + * + * @return psBool: True for success, False for failure. +*/ +psBool psMetadataAddF64( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psF64 value ///< Value for metadata item data +); + +/** Add a psList to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddList( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psList* value ///< psList for metadata item data +); + +/** Add a string to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddStr( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + const char* value ///< String for metadata item data +); + +/** Add a vector to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddVector( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psVector* value ///< Vector for metadata item data +); + +/** Add an Image to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddImage( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psImage* value ///< Image for metadata item data +); + +/** Add a Hash to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddHash( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psHash* value ///< Hash for metadata item data +); + +/** Add a LookupTable to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddLookupTable( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psLookupTable* value ///< LookupTable for metadata item data +); + +/** Add an Unknown (psPtr) to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddUnknown( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psPtr value ///< Unknown for metadata item data +); + +/** Add Metadata to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddMetadata( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psMetadata* value ///< Metadata for metadata item data +); /** Remove an item from metadata collection. Index: trunk/psLib/src/collections/psMetadataIO.h =================================================================== --- trunk/psLib/src/collections/psMetadataIO.h (revision 4235) +++ trunk/psLib/src/collections/psMetadataIO.h (revision 4243) @@ -10,6 +10,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-10 18:09:12 $ + * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-14 02:54:07 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -21,14 +21,22 @@ /// @{ +/** A metadata data structure used in parsing arrays. + * + * Contains array information and the metadata storage location. +*/ typedef struct { - psArray* nonUniqueKeyArray; - psArray* typeArray; - psArray* templateArray; - psMetadata* metadata; - char* name; + psArray* nonUniqueKeyArray; ///< non-unique key names + psArray* typeArray; ///< array of user defined types + psArray* templateArray; ///< array of user type templates + psMetadata* metadata; ///< metadata container + char* name; ///< name of key } p_psParseLevelInfo; +/** Allocates a p_psParseLevelInfo structure + * + * @return p_psParseLevelInfo* : new p_psParseLevelInfo struct + */ p_psParseLevelInfo* p_psParseLevelInfoAlloc(void); Index: trunk/psLib/src/dataManip/psMinimize.h =================================================================== --- trunk/psLib/src/dataManip/psMinimize.h (revision 4235) +++ trunk/psLib/src/dataManip/psMinimize.h (revision 4243) @@ -8,6 +8,6 @@ * @author GLG, MHPCC * - * @version $Revision: 1.43 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ + * @version $Revision: 1.44 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-14 02:54:12 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -37,4 +37,8 @@ #include "psConstants.h" +/** A psMinimization data structure. + * + * Contains numerical analysis parameters/values + */ typedef struct { @@ -47,7 +51,12 @@ psMinimization; -psMinimization *psMinimizationAlloc(psS32 maxIter, ///< Number of minimization iterations to perform. - psF32 tol ///< Requested error tolerance - ); +/** Allocates a psMinimization structure. + * + * @return psMinimization* : a new psMinimization struct +*/ +psMinimization *psMinimizationAlloc( + psS32 maxIter, ///< Number of minimization iterations to perform. + psF32 tol ///< Requested error tolerance +); /** Derive a polynomial fit. @@ -71,72 +80,156 @@ ); -psSpline1D *psVectorFitSpline1D(psSpline1D *mySpline, ///< The spline which will be generated. - const psVector* x, ///< Ordinates (or NULL to just use the indices) - const psVector* y, ///< Coordinates - const psVector* yErr ///< Errors in coordinates, or NULL - ); - -// XXX: Add Doxygen comments here. +/** Derive a one-dimensional spline fit. + * + * Given a psSpline1D data structure and a set of x,y vectors, this routine generates + * the linear splines which satisfy those data points. + * + * @return psSpline1D*: the calculated one-dimensional splines + */ +psSpline1D *psVectorFitSpline1D( + psSpline1D *mySpline, ///< The spline which will be generated. + const psVector* x, ///< Ordinates (or NULL to just use the indices) + const psVector* y, ///< Coordinates + const psVector* yErr ///< Errors in coordinates, or NULL +); + +/** Defines a Levenberg-Marquardt function of a collection of parameters evaluated at a given position. + * + * @return psF64: a single floating-point value which is the value of the function given the parameters + * and coordinate vectors, along with the derivatives of the function with respect to each of the parameters. + */ typedef -psF64 (*psMinimizeLMChi2Func)(psVector *deriv, - psVector *params, - psVector *x); - -psBool psMinimizeLMChi2(psMinimization *min, - psImage *covar, - psVector *params, - const psVector *paramMask, - const psArray *x, - const psVector *y, - const psVector *yErr, - psMinimizeLMChi2Func func); - -psBool p_psMinLM_GuessABP (psImage *Alpha, - psVector *Beta, - psVector *Params, - psImage *alpha, - psVector *beta, - psVector *params, - psF64 lambda); - -psF64 p_psMinLM_SetABX (psImage *alpha, - psVector *beta, - psVector *params, - const psArray *x, - const psVector *y, - const psVector *dy, - psMinimizeLMChi2Func func); - +psF64 (*psMinimizeLMChi2Func)( + psVector *deriv, ///< derivatives of the function + psVector *params, ///< the parameters used to evaluate the function + psVector *x ///< positions for evaluation +); + +/** Fits a specified function based on the Levenberg-Marquardt method. + * + * @return psBool: True unless an error occurred. + */ +psBool psMinimizeLMChi2( + psMinimization *min, ///< + psImage *covar, ///< + psVector *params, ///< + const psVector *paramMask, ///< + const psArray *x, ///< + const psVector *y, ///< + const psVector *yErr, ///< + psMinimizeLMChi2Func func ///< +); + +/** + * + * + * @return psBool: True if + */ +psBool p_psMinLM_GuessABP( + psImage *Alpha, ///< + psVector *Beta, ///< + psVector *Params, ///< + psImage *alpha, ///< + psVector *beta, ///< + psVector *params, ///< + psF64 lambda ///< +); + +/** + * + * + * @return psF64: + */ +psF64 p_psMinLM_SetABX ( + psImage *alpha, ///< + psVector *beta, ///< + psVector *params, ///< + const psArray *x, ///< + const psVector *y, ///< + const psVector *dy, ///< + psMinimizeLMChi2Func func); ///< + +/** + * + * + * @return psF32: +*/ typedef -psF32 (*psMinimizePowellFunc)(const psVector *params, - const psArray *coords); - -psBool psMinimizePowell(psMinimization *min, - psVector *params, - const psVector *paramMask, - const psArray *coords, - psMinimizePowellFunc func); - -psVector *psMinimizeLMChi2Gauss1D(psImage *deriv, - const psVector *params, - const psArray *coords); - -psVector *psMinimizePowellChi2Gauss1D(const psVector *params, - const psArray *coords); - +psF32 (*psMinimizePowellFunc)( + const psVector *params, ///< + const psArray *coords ///< +); + + +/** + * + * + * @return psBool: True if + */ +psBool psMinimizePowell( + psMinimization *min, ///< + psVector *params, ///< + const psVector *paramMask, ///< + const psArray *coords, ///< + psMinimizePowellFunc func ///< +); + +/** + * + * + * @return psVector*: + */ +psVector *psMinimizeLMChi2Gauss1D( + psImage *deriv, ///< + const psVector *params, ///< + const psArray *coords ///< +); + +/** + * + * + * @return psVector*: + */ +psVector *psMinimizePowellChi2Gauss1D( + const psVector *params, ///< + const psArray *coords ///< +); + +/** + * + * + * +*/ typedef -psVector *(*psMinimizeChi2PowellFunc)(const psVector *params, - const psArray *coords); - -psBool psMinimizeChi2Powell(psMinimization *min, - psVector *params, - const psVector *paramMask, - const psArray *coords, - const psVector *value, - const psVector *error, - psMinimizeChi2PowellFunc func); - -// XXX EAM : psGaussJordan provided as an alternate to LU Decomp for psMinimizeLMChi2 -bool psGaussJordan (psImage *a, psVector *b); +psVector *(*psMinimizeChi2PowellFunc)( + const psVector *params, ///< + const psArray *coords ///< +); + + +/** + * + * + * @return psBool: True if + */ +psBool psMinimizeChi2Powell( + psMinimization *min, ///< + psVector *params, ///< + const psVector *paramMask, ///< + const psArray *coords, ///< + const psVector *value, ///< + const psVector *error, ///< + psMinimizeChi2PowellFunc func ///< +); + +/** + * + * + * @return bool: True if + */ +bool psGaussJordan( + psImage *a, ///< + psVector *b ///< +); /* \} */// End of MathGroup Functions Index: trunk/psLib/src/image/psImageConvolve.h =================================================================== --- trunk/psLib/src/image/psImageConvolve.h (revision 4235) +++ trunk/psLib/src/image/psImageConvolve.h (revision 4243) @@ -7,6 +7,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-14 02:54:15 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -24,4 +24,9 @@ #define PS_TYPE_KERNEL_NAME "psF32" /**< the data type for kernel as a string */ +/** Kernel Type + * + * A floating-point data type used for storing kernel data. + * + */ typedef psF32 psKernelType; @@ -93,4 +98,6 @@ const psVector* yShifts, ///< list of y-axis shifts psBool relative + /**< specifies the starting point for the shifts; true=relative to previous shift + * false = relative to some other starting point. */ ); Index: trunk/psLib/src/image/psImageGeomManip.h =================================================================== --- trunk/psLib/src/image/psImageGeomManip.h (revision 4235) +++ trunk/psLib/src/image/psImageGeomManip.h (revision 4243) @@ -8,6 +8,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-11 02:19:05 $ + * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-14 02:54:15 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -119,5 +119,5 @@ * * Transform the input image according the supplied transformation. The size - * of the transformed image is defined by the supplied output image, if + * of the transformed image is defined by the supplied output image, if * non-NULL, or the region otherwise (size region.x1 - region.x0 by region.y1 * region.y0, with out->x0 = region.x0 and out->y0 = region.y0). If the @@ -149,8 +149,9 @@ int inputMaskVal, ///< masking value for inputMask const psPlaneTransform *outToIn, ///< the transform to apply - const psRegion region, ///< - const psPixels* pixels, ///< - psImageInterpolateMode mode, ///< - int exposedValue ///< + const psRegion region, ///< the size of the transformed image + const psPixels* pixels, /**< if not NULL, consists of psPixelCoords and specifies which pixels in + * output image shall be transformed; otherwise, entire image generated*/ + psImageInterpolateMode mode, ///< the interpolation scheme to be used + int exposedValue ///< Exposed value to which non-corresponding pixels are set ); Index: trunk/psLib/src/image/psImageStats.h =================================================================== --- trunk/psLib/src/image/psImageStats.h (revision 4235) +++ trunk/psLib/src/image/psImageStats.h (revision 4243) @@ -9,6 +9,6 @@ * @author GLG, MHPCC * -* @version $Revision: 1.22 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-08 23:40:45 $ +* @version $Revision: 1.23 $ $Name: not supported by cvs2svn $ +* @date $Date: 2005-06-14 02:54:15 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -69,5 +69,5 @@ psPolynomial2D* psImageFitPolynomial( psPolynomial2D* coeffs, ///< coefficient structure carries in desired terms & target - const psImage* input + const psImage* input ///< input image ); Index: trunk/psLib/src/imageops/psImageConvolve.h =================================================================== --- trunk/psLib/src/imageops/psImageConvolve.h (revision 4235) +++ trunk/psLib/src/imageops/psImageConvolve.h (revision 4243) @@ -7,6 +7,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-14 02:54:15 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -24,4 +24,9 @@ #define PS_TYPE_KERNEL_NAME "psF32" /**< the data type for kernel as a string */ +/** Kernel Type + * + * A floating-point data type used for storing kernel data. + * + */ typedef psF32 psKernelType; @@ -93,4 +98,6 @@ const psVector* yShifts, ///< list of y-axis shifts psBool relative + /**< specifies the starting point for the shifts; true=relative to previous shift + * false = relative to some other starting point. */ ); Index: trunk/psLib/src/imageops/psImageGeomManip.h =================================================================== --- trunk/psLib/src/imageops/psImageGeomManip.h (revision 4235) +++ trunk/psLib/src/imageops/psImageGeomManip.h (revision 4243) @@ -8,6 +8,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-11 02:19:05 $ + * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-14 02:54:15 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -119,5 +119,5 @@ * * Transform the input image according the supplied transformation. The size - * of the transformed image is defined by the supplied output image, if + * of the transformed image is defined by the supplied output image, if * non-NULL, or the region otherwise (size region.x1 - region.x0 by region.y1 * region.y0, with out->x0 = region.x0 and out->y0 = region.y0). If the @@ -149,8 +149,9 @@ int inputMaskVal, ///< masking value for inputMask const psPlaneTransform *outToIn, ///< the transform to apply - const psRegion region, ///< - const psPixels* pixels, ///< - psImageInterpolateMode mode, ///< - int exposedValue ///< + const psRegion region, ///< the size of the transformed image + const psPixels* pixels, /**< if not NULL, consists of psPixelCoords and specifies which pixels in + * output image shall be transformed; otherwise, entire image generated*/ + psImageInterpolateMode mode, ///< the interpolation scheme to be used + int exposedValue ///< Exposed value to which non-corresponding pixels are set ); Index: trunk/psLib/src/imageops/psImageStats.h =================================================================== --- trunk/psLib/src/imageops/psImageStats.h (revision 4235) +++ trunk/psLib/src/imageops/psImageStats.h (revision 4243) @@ -9,6 +9,6 @@ * @author GLG, MHPCC * -* @version $Revision: 1.22 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-08 23:40:45 $ +* @version $Revision: 1.23 $ $Name: not supported by cvs2svn $ +* @date $Date: 2005-06-14 02:54:15 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -69,5 +69,5 @@ psPolynomial2D* psImageFitPolynomial( psPolynomial2D* coeffs, ///< coefficient structure carries in desired terms & target - const psImage* input + const psImage* input ///< input image ); Index: trunk/psLib/src/math/psMinimize.h =================================================================== --- trunk/psLib/src/math/psMinimize.h (revision 4235) +++ trunk/psLib/src/math/psMinimize.h (revision 4243) @@ -8,6 +8,6 @@ * @author GLG, MHPCC * - * @version $Revision: 1.43 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ + * @version $Revision: 1.44 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-14 02:54:12 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -37,4 +37,8 @@ #include "psConstants.h" +/** A psMinimization data structure. + * + * Contains numerical analysis parameters/values + */ typedef struct { @@ -47,7 +51,12 @@ psMinimization; -psMinimization *psMinimizationAlloc(psS32 maxIter, ///< Number of minimization iterations to perform. - psF32 tol ///< Requested error tolerance - ); +/** Allocates a psMinimization structure. + * + * @return psMinimization* : a new psMinimization struct +*/ +psMinimization *psMinimizationAlloc( + psS32 maxIter, ///< Number of minimization iterations to perform. + psF32 tol ///< Requested error tolerance +); /** Derive a polynomial fit. @@ -71,72 +80,156 @@ ); -psSpline1D *psVectorFitSpline1D(psSpline1D *mySpline, ///< The spline which will be generated. - const psVector* x, ///< Ordinates (or NULL to just use the indices) - const psVector* y, ///< Coordinates - const psVector* yErr ///< Errors in coordinates, or NULL - ); - -// XXX: Add Doxygen comments here. +/** Derive a one-dimensional spline fit. + * + * Given a psSpline1D data structure and a set of x,y vectors, this routine generates + * the linear splines which satisfy those data points. + * + * @return psSpline1D*: the calculated one-dimensional splines + */ +psSpline1D *psVectorFitSpline1D( + psSpline1D *mySpline, ///< The spline which will be generated. + const psVector* x, ///< Ordinates (or NULL to just use the indices) + const psVector* y, ///< Coordinates + const psVector* yErr ///< Errors in coordinates, or NULL +); + +/** Defines a Levenberg-Marquardt function of a collection of parameters evaluated at a given position. + * + * @return psF64: a single floating-point value which is the value of the function given the parameters + * and coordinate vectors, along with the derivatives of the function with respect to each of the parameters. + */ typedef -psF64 (*psMinimizeLMChi2Func)(psVector *deriv, - psVector *params, - psVector *x); - -psBool psMinimizeLMChi2(psMinimization *min, - psImage *covar, - psVector *params, - const psVector *paramMask, - const psArray *x, - const psVector *y, - const psVector *yErr, - psMinimizeLMChi2Func func); - -psBool p_psMinLM_GuessABP (psImage *Alpha, - psVector *Beta, - psVector *Params, - psImage *alpha, - psVector *beta, - psVector *params, - psF64 lambda); - -psF64 p_psMinLM_SetABX (psImage *alpha, - psVector *beta, - psVector *params, - const psArray *x, - const psVector *y, - const psVector *dy, - psMinimizeLMChi2Func func); - +psF64 (*psMinimizeLMChi2Func)( + psVector *deriv, ///< derivatives of the function + psVector *params, ///< the parameters used to evaluate the function + psVector *x ///< positions for evaluation +); + +/** Fits a specified function based on the Levenberg-Marquardt method. + * + * @return psBool: True unless an error occurred. + */ +psBool psMinimizeLMChi2( + psMinimization *min, ///< + psImage *covar, ///< + psVector *params, ///< + const psVector *paramMask, ///< + const psArray *x, ///< + const psVector *y, ///< + const psVector *yErr, ///< + psMinimizeLMChi2Func func ///< +); + +/** + * + * + * @return psBool: True if + */ +psBool p_psMinLM_GuessABP( + psImage *Alpha, ///< + psVector *Beta, ///< + psVector *Params, ///< + psImage *alpha, ///< + psVector *beta, ///< + psVector *params, ///< + psF64 lambda ///< +); + +/** + * + * + * @return psF64: + */ +psF64 p_psMinLM_SetABX ( + psImage *alpha, ///< + psVector *beta, ///< + psVector *params, ///< + const psArray *x, ///< + const psVector *y, ///< + const psVector *dy, ///< + psMinimizeLMChi2Func func); ///< + +/** + * + * + * @return psF32: +*/ typedef -psF32 (*psMinimizePowellFunc)(const psVector *params, - const psArray *coords); - -psBool psMinimizePowell(psMinimization *min, - psVector *params, - const psVector *paramMask, - const psArray *coords, - psMinimizePowellFunc func); - -psVector *psMinimizeLMChi2Gauss1D(psImage *deriv, - const psVector *params, - const psArray *coords); - -psVector *psMinimizePowellChi2Gauss1D(const psVector *params, - const psArray *coords); - +psF32 (*psMinimizePowellFunc)( + const psVector *params, ///< + const psArray *coords ///< +); + + +/** + * + * + * @return psBool: True if + */ +psBool psMinimizePowell( + psMinimization *min, ///< + psVector *params, ///< + const psVector *paramMask, ///< + const psArray *coords, ///< + psMinimizePowellFunc func ///< +); + +/** + * + * + * @return psVector*: + */ +psVector *psMinimizeLMChi2Gauss1D( + psImage *deriv, ///< + const psVector *params, ///< + const psArray *coords ///< +); + +/** + * + * + * @return psVector*: + */ +psVector *psMinimizePowellChi2Gauss1D( + const psVector *params, ///< + const psArray *coords ///< +); + +/** + * + * + * +*/ typedef -psVector *(*psMinimizeChi2PowellFunc)(const psVector *params, - const psArray *coords); - -psBool psMinimizeChi2Powell(psMinimization *min, - psVector *params, - const psVector *paramMask, - const psArray *coords, - const psVector *value, - const psVector *error, - psMinimizeChi2PowellFunc func); - -// XXX EAM : psGaussJordan provided as an alternate to LU Decomp for psMinimizeLMChi2 -bool psGaussJordan (psImage *a, psVector *b); +psVector *(*psMinimizeChi2PowellFunc)( + const psVector *params, ///< + const psArray *coords ///< +); + + +/** + * + * + * @return psBool: True if + */ +psBool psMinimizeChi2Powell( + psMinimization *min, ///< + psVector *params, ///< + const psVector *paramMask, ///< + const psArray *coords, ///< + const psVector *value, ///< + const psVector *error, ///< + psMinimizeChi2PowellFunc func ///< +); + +/** + * + * + * @return bool: True if + */ +bool psGaussJordan( + psImage *a, ///< + psVector *b ///< +); /* \} */// End of MathGroup Functions Index: trunk/psLib/src/types/psMetadata.h =================================================================== --- trunk/psLib/src/types/psMetadata.h (revision 4235) +++ trunk/psLib/src/types/psMetadata.h (revision 4243) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * -* @version $Revision: 1.47 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-08 23:40:45 $ +* @version $Revision: 1.48 $ $Name: not supported by cvs2svn $ +* @date $Date: 2005-06-14 02:54:06 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -287,5 +287,5 @@ */ psBool psMetadataAddV( - psMetadata* md, ///< Metadata collection to insert metadat item. + psMetadata* md, ///< Metadata collection to insert metadata item. psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL const char *name, ///< Name of metadata item. @@ -296,26 +296,135 @@ #endif // #ifndef SWIG -psBool psMetadataAddS32(psMetadata* md, psS32 location, const char* name, - const char* comment, psS32 value); -psBool psMetadataAddF32(psMetadata* md, psS32 location, const char* name, - const char* comment, psF32 value); -psBool psMetadataAddF64(psMetadata* md, psS32 location, const char* name, - const char* comment, psF64 value); -psBool psMetadataAddList(psMetadata* md, psS32 location, const char* name, - const char* comment, psList* value); -psBool psMetadataAddStr(psMetadata* md, psS32 location, const char* name, - const char* comment, const char* value); -psBool psMetadataAddVector(psMetadata* md, psS32 location, const char* name, - const char* comment, psVector* value); -psBool psMetadataAddImage(psMetadata* md, psS32 location, const char* name, - const char* comment, psImage* value); -psBool psMetadataAddHash(psMetadata* md, psS32 location, const char* name, - const char* comment, psHash* value); -psBool psMetadataAddLookupTable(psMetadata* md, psS32 location, const char* name, - const char* comment, psLookupTable* value); -psBool psMetadataAddUnknown(psMetadata* md, psS32 location, const char* name, - const char* comment, psPtr value); -psBool psMetadataAddMetadata(psMetadata* md, psS32 location, const char* name, - const char* comment, psMetadata* value); +/** Add a psS32 value to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddS32( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psS32 value ///< Value for metadata item data +); + +/** Add a psF32 value to metadata collection. + * + * @return psBool: True for success, False for failure. +*/ +psBool psMetadataAddF32( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psF32 value ///< Value for metadata item data +); + +/** Add a psF64 value to metadata collection. + * + * @return psBool: True for success, False for failure. +*/ +psBool psMetadataAddF64( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psF64 value ///< Value for metadata item data +); + +/** Add a psList to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddList( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psList* value ///< psList for metadata item data +); + +/** Add a string to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddStr( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + const char* value ///< String for metadata item data +); + +/** Add a vector to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddVector( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psVector* value ///< Vector for metadata item data +); + +/** Add an Image to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddImage( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psImage* value ///< Image for metadata item data +); + +/** Add a Hash to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddHash( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psHash* value ///< Hash for metadata item data +); + +/** Add a LookupTable to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddLookupTable( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psLookupTable* value ///< LookupTable for metadata item data +); + +/** Add an Unknown (psPtr) to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddUnknown( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psPtr value ///< Unknown for metadata item data +); + +/** Add Metadata to metadata collection. + * + * @return psBool: True for success, False for failure. + */ +psBool psMetadataAddMetadata( + psMetadata* md, ///< Metadata collection to insert metadata item + psS32 location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL + const char* name, ///< Name of metadata item + const char* comment, ///< Comment for metadata item + psMetadata* value ///< Metadata for metadata item data +); /** Remove an item from metadata collection. Index: trunk/psLib/src/types/psMetadataConfig.h =================================================================== --- trunk/psLib/src/types/psMetadataConfig.h (revision 4235) +++ trunk/psLib/src/types/psMetadataConfig.h (revision 4243) @@ -10,6 +10,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-10 18:09:12 $ + * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-14 02:54:07 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -21,14 +21,22 @@ /// @{ +/** A metadata data structure used in parsing arrays. + * + * Contains array information and the metadata storage location. +*/ typedef struct { - psArray* nonUniqueKeyArray; - psArray* typeArray; - psArray* templateArray; - psMetadata* metadata; - char* name; + psArray* nonUniqueKeyArray; ///< non-unique key names + psArray* typeArray; ///< array of user defined types + psArray* templateArray; ///< array of user type templates + psMetadata* metadata; ///< metadata container + char* name; ///< name of key } p_psParseLevelInfo; +/** Allocates a p_psParseLevelInfo structure + * + * @return p_psParseLevelInfo* : new p_psParseLevelInfo struct + */ p_psParseLevelInfo* p_psParseLevelInfoAlloc(void); Index: trunk/psLib/src/xml/psXML.h =================================================================== --- trunk/psLib/src/xml/psXML.h (revision 4235) +++ trunk/psLib/src/xml/psXML.h (revision 4243) @@ -10,6 +10,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-10 18:09:12 $ + * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-14 02:54:07 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -21,14 +21,22 @@ /// @{ +/** A metadata data structure used in parsing arrays. + * + * Contains array information and the metadata storage location. +*/ typedef struct { - psArray* nonUniqueKeyArray; - psArray* typeArray; - psArray* templateArray; - psMetadata* metadata; - char* name; + psArray* nonUniqueKeyArray; ///< non-unique key names + psArray* typeArray; ///< array of user defined types + psArray* templateArray; ///< array of user type templates + psMetadata* metadata; ///< metadata container + char* name; ///< name of key } p_psParseLevelInfo; +/** Allocates a p_psParseLevelInfo structure + * + * @return p_psParseLevelInfo* : new p_psParseLevelInfo struct + */ p_psParseLevelInfo* p_psParseLevelInfoAlloc(void);