Index: trunk/psModules/src/detrend/pmBias.h =================================================================== --- trunk/psModules/src/detrend/pmBias.h (revision 11150) +++ trunk/psModules/src/detrend/pmBias.h (revision 11253) @@ -1,19 +1,18 @@ -/// @file pmBias.h -/// -/// @brief Subtract the overscan, bias and dark -/// -/// @ingroup Detrend -/// -/// @author George Gusciora, MHPCC -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-30 01:03:06 $ -/// -/// Copyright 2004--2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmBias.h + * @brief Subtract the overscan, bias and dark + * + * @author George Gusciora, MHPCC + * @author Paul Price, IfA + * + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004--2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM__BIAS_H #define PM__BIAS_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include @@ -66,3 +65,4 @@ ); +/// @} #endif Index: trunk/psModules/src/detrend/pmDetrendDB.h =================================================================== --- trunk/psModules/src/detrend/pmDetrendDB.h (revision 11150) +++ trunk/psModules/src/detrend/pmDetrendDB.h (revision 11253) @@ -1,25 +1,22 @@ -/** @file pmDetrendDB.h -* -* @brief Tools to query the detrend database system -* -* the functions in here do not perform the detrend database queries directly. all interfaces -* to the detrend database go through the external dettools functions. this allows the modules -* and directly dependent program to be sufficiently independent of the database schema that it -* can be used with any properly defined detrend database tables. -* -* XXX place the specific name of the detrend database query command in the configuration data -* -* @ingroup Detrend -* -* @author EAM, IfA -* -* @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-11-04 02:34:01 $ -* -* Copyright 2004-2005 Institute for Astronomy, University of Hawaii -*/ +/* @file pmDetrendDB.h + * @brief Tools to query the detrend database system + * + * the functions in here do not perform the detrend database queries directly. all interfaces + * to the detrend database go through the external dettools functions. this allows the modules + * and directly dependent program to be sufficiently independent of the database schema that it + * can be used with any properly defined detrend database tables. + * + * @author EAM, IfA + * + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2005 Institute for Astronomy, University of Hawaii + */ #ifndef PM_DETREND_DB_H #define PM_DETREND_DB_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include "pmFPALevel.h" @@ -69,3 +66,4 @@ char *pmDetrendFile (const char *detID, const char *classID); +/// @} # endif Index: trunk/psModules/src/detrend/pmFlatField.h =================================================================== --- trunk/psModules/src/detrend/pmFlatField.h (revision 11150) +++ trunk/psModules/src/detrend/pmFlatField.h (revision 11253) @@ -1,19 +1,18 @@ -/// @file pmFlatField.h -/// -/// @brief Apply flat field calibration -/// -/// @ingroup Detrend -/// -/// @author Ross Harman, MHPCC -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-24 03:48:42 $ -/// -/// Copyright 2004-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFlatField.h + * @brief Apply flat field calibration + * + * @author Ross Harman, MHPCC + * @author Paul Price, IfA + * + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FLAT_FIELD_H #define PM_FLAT_FIELD_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include "pmFPA.h" @@ -29,5 +28,4 @@ const pmReadout *flat ///< Readout with flat image ); - - +/// @} #endif Index: trunk/psModules/src/detrend/pmFlatNormalize.h =================================================================== --- trunk/psModules/src/detrend/pmFlatNormalize.h (revision 11150) +++ trunk/psModules/src/detrend/pmFlatNormalize.h (revision 11253) @@ -1,22 +1,21 @@ -/// @file pmFlatNormalize.h -/// -/// @brief Normalize flat-field measurements -/// -/// @ingroup Detrend -/// -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-17 20:49:10 $ -/// -/// Copyright 2004-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFlatNormalize.h + * @brief Normalize flat-field measurements + * + * @author Paul Price, IfA + * + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FLAT_NORMALIZE_H #define PM_FLAT_NORMALIZE_H +/// @addtogroup detrend Detrend Creation and Application +/// @{ + #include -/// Normalise flat-field measurements +/// Normalize flat-field measurements /// /// We have f_ij = g_i s_j where f_ij is the flux recorded for chip i and integration j, g_i is the gain for @@ -31,3 +30,4 @@ ); +/// @} #endif Index: trunk/psModules/src/detrend/pmFringeStats.h =================================================================== --- trunk/psModules/src/detrend/pmFringeStats.h (revision 11150) +++ trunk/psModules/src/detrend/pmFringeStats.h (revision 11253) @@ -1,19 +1,18 @@ -/// @file pmFringeStats.h -/// -/// @brief Measure fringe statistics, and apply correction -/// -/// @ingroup Detrend -/// -/// @author Eugene Magnier, IfA -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-13 22:19:52 $ -/// -/// Copyright 2004-2006 Institute for Astronomy, University of Hawaii -/// +/* @file pmFringeStats.h + * @brief Measure fringe statistics, and apply correction + * + * @author Eugene Magnier, IfA + * @author Paul Price, IfA + * + * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004-2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_FRINGE_STATS #define PM_FRINGE_STATS + +/// @addtogroup detrend Detrend Creation and Application +/// @{ ////////////////////////////////////////////////////////////////////////////////////////////////////////////// @@ -212,5 +211,4 @@ float keepFrac ///< Minimum fraction of regions to keep, for pmFringeScaleMeasure ); - - +/// @} #endif Index: trunk/psModules/src/detrend/pmMaskBadPixels.h =================================================================== --- trunk/psModules/src/detrend/pmMaskBadPixels.h (revision 11150) +++ trunk/psModules/src/detrend/pmMaskBadPixels.h (revision 11253) @@ -1,19 +1,18 @@ -/// @file pmMaskBadPixels.h -/// -/// @brief Mask bad pixels -/// -/// @ingroup Detrend -/// -/// @author Ross Harman, MHPCC -/// @author Eugene Magnier, IfA -/// -/// @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-17 01:17:59 $ -/// -/// Copyright 2004 Institute for Astronomy, University of Hawaii -/// +/* @file pmMaskBadPixels.h + * @brief Mask bad pixels + * + * @author Ross Harman, MHPCC + * @author Eugene Magnier, IfA + * + * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Institute for Astronomy, University of Hawaii + */ #ifndef PM_MASK_BAD_PIXELS_H #define PM_MASK_BAD_PIXELS_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include @@ -56,7 +55,4 @@ psMaskType maskVal ///< Value to set for bad pixels ); - - - - +/// @} #endif Index: trunk/psModules/src/detrend/pmNonLinear.h =================================================================== --- trunk/psModules/src/detrend/pmNonLinear.h (revision 11150) +++ trunk/psModules/src/detrend/pmNonLinear.h (revision 11253) @@ -1,19 +1,18 @@ -/// @file pmNonLinear.h -/// -/// @brief Perform non-linear correction through polynomial or table lookup -/// -/// @ingroup Detrend -/// -/// @author George Gusciora, MHPCC -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-10-17 22:57:27 $ -/// -/// Copyright 2004 Institute for Astronomy, University of Hawaii -/// +/* @file pmNonLinear.h + * @brief Perform non-linear correction through polynomial or table lookup + * + * @author George Gusciora, MHPCC + * @author Paul Price, IfA + * + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Institute for Astronomy, University of Hawaii + */ #ifndef PM_NON_LINEAR_H #define PM_NON_LINEAR_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include @@ -36,3 +35,4 @@ ); +/// @} #endif Index: trunk/psModules/src/detrend/pmShutterCorrection.h =================================================================== --- trunk/psModules/src/detrend/pmShutterCorrection.h (revision 11150) +++ trunk/psModules/src/detrend/pmShutterCorrection.h (revision 11253) @@ -1,63 +1,62 @@ -/// @file pmShutterCorrection.h -/// -/// @brief Functions to build and apply a shutter exposure-time correction. -/// -/// @ingroup Detrend -/// -/// @author Eugene Magnier, IfA -/// @author Paul Price, IfA -/// -/// @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ -/// @date $Date: 2006-11-15 00:40:49 $ -/// -/// Copyright 2006 Institute for Astronomy, University of Hawaii -/// - - -/// A mechanical shutter may not yield uniform exposure times as a function of -/// position on the detector. The typical error consists of a constant -/// exposure-time offset relative to the requested value, ie exposure time is -/// T_o + dT(x,y). The exposure error, dT, may be measured with the following -/// scheme. Obtain a set of exposures with different exposures times taken of -/// the same flat-field source; the source must be spatially stable between the -/// exposures, but need not have a stable amplitude. For an illuminating flux -/// of intensity F(x,y) = F_o f(x,y), the signal recorded by any pixel in the -/// detector is given by: S(t,x,y) = F_o(t) f(x,y) (T_o + dT(x,y)) where F_o is -/// the F_o(t) is the (variable) overall intensity of the illuminating source -/// and f(x,y) is the spatial illumination patter times the flat-field response. -/// Choose a reference location in the image (eg, the detector center) and -/// divide by the value of that region (ie, mean or median): -/// -/// s(t,x,y) = S(t,x,y) / S(t,0,0) -/// s(t,x,y) = F_o(t) f(x,y) (T_o + dT(x,y)) / F_o(t) f(0,0) (T_o + dT(0,0)) -/// s(t,x,y) = f(x,y) (T_o + dT(x,y)) / f(0,0) (T_o + dT(0,0)) -/// -/// we can absorb the term f(0,0) into f(x,y) as we have no motivation for the -/// scale of f(x,y). For any single pixel, over the set of exposures, we thus -/// need to solve for dT(x,y), dT(0,0), and f'(x,y) in the equation: -/// s(t,x,y) = f'(x,y) (T_o + dT(x,y)) / (T_o + dT(0,0)) -/// -/// we avoid directly fitting these values as the process would be a non-linear -/// least-squares problem for every pixel in the image, and thus very time -/// consuming. There are linear options which may be used instead. -/// First, as T_o goes to a large value, s() approaches the value of f'(x,y). -/// Next, as T_o goes to a very small value, s() approaches the value of -/// f'(x,y)*dT(x,y)/dT(0,0). Finally, when s() has the value of -/// f'(x,y)*(1 + dT(x,y)/dT(0,0))/2, T_o has the value of dT(0,0). with data -/// points covering a reasonable dynamic range, we can solve for these three -/// values by interpolation and/or extrapolation. -/// -/// To take the strategy one step further, we could use the above recipe to -/// obtain a guess for the three parameters and then apply non-linear fitting to -/// solve more accurately for the parameters. If we limit this operation to a -/// handful of positions in the image (user defined, but the obvious choice would -/// be positions near the center, edges, and corners), then we may determine a -/// good value for dT(0,0). Since there is only one dT(0,0) for the image, we -/// can apply the resulting measurement to the rest of the pixels in the image. -/// If dT(0,0) is not a free parameter, then the fitting process is linear in -/// terms of dT(x,y) and f'(x,y) +/* @file pmShutterCorrection.h + * @brief Functions to build and apply a shutter exposure-time correction. + * + * @author Eugene Magnier, IfA + * @author Paul Price, IfA + * + * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2006 Institute for Astronomy, University of Hawaii + */ #ifndef PM_SHUTTER_CORRECTION_H #define PM_SHUTTER_CORRECTION_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ + +/* A mechanical shutter may not yield uniform exposure times as a function of + * position on the detector. The typical error consists of a constant + * exposure-time offset relative to the requested value, ie exposure time is + * T_o + dT(x,y). The exposure error, dT, may be measured with the following + * scheme. Obtain a set of exposures with different exposures times taken of + * the same flat-field source; the source must be spatially stable between the + * exposures, but need not have a stable amplitude. For an illuminating flux + * of intensity F(x,y) = F_o f(x,y), the signal recorded by any pixel in the + * detector is given by: S(t,x,y) = F_o(t) f(x,y) (T_o + dT(x,y)) where F_o is + * the F_o(t) is the (variable) overall intensity of the illuminating source + * and f(x,y) is the spatial illumination patter times the flat-field response. + * Choose a reference location in the image (eg, the detector center) and + * divide by the value of that region (ie, mean or median): + * + * s(t,x,y) = S(t,x,y) / S(t,0,0) + * s(t,x,y) = F_o(t) f(x,y) (T_o + dT(x,y)) / F_o(t) f(0,0) (T_o + dT(0,0)) + * s(t,x,y) = f(x,y) (T_o + dT(x,y)) / f(0,0) (T_o + dT(0,0)) + * + * we can absorb the term f(0,0) into f(x,y) as we have no motivation for the + * scale of f(x,y). For any single pixel, over the set of exposures, we thus + * need to solve for dT(x,y), dT(0,0), and f'(x,y) in the equation: + * s(t,x,y) = f'(x,y) (T_o + dT(x,y)) / (T_o + dT(0,0)) + * + * we avoid directly fitting these values as the process would be a non-linear + * least-squares problem for every pixel in the image, and thus very time + * consuming. There are linear options which may be used instead. + * First, as T_o goes to a large value, s() approaches the value of f'(x,y). + * Next, as T_o goes to a very small value, s() approaches the value of + * f'(x,y)*dT(x,y)/dT(0,0). Finally, when s() has the value of + * f'(x,y)*(1 + dT(x,y)/dT(0,0))/2, T_o has the value of dT(0,0). with data + * points covering a reasonable dynamic range, we can solve for these three + * values by interpolation and/or extrapolation. + * + * To take the strategy one step further, we could use the above recipe to + * obtain a guess for the three parameters and then apply non-linear fitting to + * solve more accurately for the parameters. If we limit this operation to a + * handful of positions in the image (user defined, but the obvious choice would + * be positions near the center, edges, and corners), then we may determine a + * good value for dT(0,0). Since there is only one dT(0,0) for the image, we + * can apply the resulting measurement to the rest of the pixels in the image. + * If dT(0,0) is not a free parameter, then the fitting process is linear in + * terms of dT(x,y) and f'(x,y) + */ #include @@ -130,3 +129,4 @@ ); +/// @} #endif Index: trunk/psModules/src/detrend/pmSkySubtract.h =================================================================== --- trunk/psModules/src/detrend/pmSkySubtract.h (revision 11150) +++ trunk/psModules/src/detrend/pmSkySubtract.h (revision 11253) @@ -1,18 +1,19 @@ -/** @file pmSubtractSky.h +/* @file pmSubtractSky.h * - * This file will contain a module which will create a model of the - * background sky and subtract that from the input image. + * This file will contain a module which will create a model of the + * background sky and subtract that from the input image. * - * @author GLG, MHPCC + * @author GLG, MHPCC * - * @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-30 00:52:21 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-24 02:54:15 $ + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ #ifndef PM_SUBTRACT_SKY_H #define PM_SUBTRACT_SKY_H + +/// @addtogroup detrend Detrend Creation and Application +/// @{ #include @@ -34,3 +35,5 @@ psStats *stats, float clipSD); + +/// @} #endif