Changeset 2150

Timestamp:

Oct 15, 2004, 9:09:39 AM (22 years ago)

Author:

harman

Message:

Changed comment

File:

• trunk/psModules/src/mainpage.dox (modified) (8 diffs)

trunk/psModules/src/mainpage.dox

@@ -4 +4 @@
 @section intro Introduction
 This library contains the Pan-STARRS Image Processing Pipeline (IPP) modules (psModule). These modules
-use the functionality of the Pan-STARRS Library (psLib) to perform more complex tasks associated with image 
-processing. Modules were constructed to support each of the required processing stages, and are listed according 
-to the particular processing stage for which they will primarily be used. To preserve namespace, globally-visible 
+use the functionality of the Pan-STARRS Library (psLib) to perform more complex tasks associated with image
+processing. Modules were constructed to support each of the required processing stages and are listed according
+to the particular processing stage for which they will primarily be used. To preserve namespace, globally-visible
 structures and functions are prefixed with pm, an abbreviation for Pan-STARRS Modules.
 
 Modules in this release include:
 
- - Subtract bias
- - Correct for non-linearity
- - Flat-field
- - Mask bad pixels
+ - Subtract bias (pmSubtractBias)
+ - Correct for non-linearity (pmNonLinear)
+ - Flat-field (pmFlatField)
+ - Mask bad pixels (pmMaskBadPixels)
 
 
@@ -21 +21 @@
 @section extinstall Required 3rd Party Libraries
 
-Before building psLib from source, several 3rd party software libraries must 
-be installed. These include: 
+Before building psLib from source, several 3rd party software libraries must
+be installed. These include:
  - Pan-STARRS Library (psLib)
      - Available from the Maui High Performance Computiong Center (MHPCC) at https://mhpcc.pan-starrs.org/code/releases
@@ -40 +40 @@
      - Compatibility tested with version 1.3.6
      - The optional companion package, GraphViz (a.k.a., the 'dot' command), is recommended to enable header-file dependency diagrams
- - SLALIB 
+ - SLALIB
      - Available at http://star-www.rl.ac.uk/
      - Compatibility tested with package version number 2.4-12
 
-We recommend using the particular versions listed as compatibility tested, as 
+We recommend using the particular versions listed as compatibility tested, as
 that is the only versions of the external libraries tested to work well with psLib
-and psModule.  Though it is quite possible that later versions of the libraries 
+and psModule.  Though it is quite possible that later versions of the libraries
 listed will also work, care must be taken when upgrading these libraries to verify
 that its functionality is compatible with the tested version.
@@ -62 +62 @@
 https://mhpcc.pan-starrs.org/code/snapshots
 
-These snapshots represents development code as found in CVS on the day 
+These snapshots represents development code as found in CVS on the day
 specified in the filename.  This code set may not be functional, vary in
-testing, etc.  Reasonable efforts are made to ensure that the code does 
-actually compile, but given the nature of code development, even that is not 
+testing, etc.  Reasonable efforts are made to ensure that the code does
+actually compile, but given the nature of code development, even that is not
 always the case.  Use snapshots with great caution.
 
-If one has a login account on mhpcc.pan-starrs.org, direct CVS access is  
+If one has a login account on mhpcc.pan-starrs.org, direct CVS access is
 possible.  Example of the commands required for direct CVS retrieval are
 as follows:
@@ -77 +77 @@
   - USERNAME is your login name on the server
   - RELEASEBRANCH is the desired release branch, e.g. rel1.
-    
+
 
 @section build How to Build the psModule library.
@@ -88 +88 @@
 $ cd psModule
 $ configure --with-psLib=/home/kaiser/psLib (NB: Directory for psLib will vary)
-$ make 
+$ make
 </pre>
-<i>This builds and installs files to psModule/lib and psModule/include.</i>
+<i>This builds files in psModule/src and psModule/test.</i>
 
 Other configuration options, such as location of other 3rd party libraries, are also available.
@@ -106 +106 @@
 $ ./FullUnitTest
 </pre>
+<i>This executes all test drivers in psModule/test.</i>
 
 @section doc How to Create Code Documentation
 
-Both HTML and man page documentation may be generated from the inline 
+Both HTML and man page documentation may be generated from the inline
 documentation embedded in the code using the following commands:
 <pre>
@@ -117 +118 @@
 <i>This places documentation in psModule/docs.</i>
 
-Also, a prebuilt set of code documentation for both the releases and last 
+Also, a prebuilt set of code documentation for both the releases and last
 CVS snapshot can be found at: