Changeset 8569 for trunk/psModules/src/mainpage.dox
- Timestamp:
- Aug 24, 2006, 1:13:37 PM (20 years ago)
- File:
-
- 1 edited
-
trunk/psModules/src/mainpage.dox (modified) (9 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/psModules/src/mainpage.dox
r5710 r8569 1 /** @mainpage psModule Image Processing Library1 /** @mainpage psModules Image Processing Library 2 2 3 3 4 4 @section intro Introduction 5 This library contains the Pan-STARRS Image Processing Pipeline (IPP) modules (psModule ). These modules5 This library contains the Pan-STARRS Image Processing Pipeline (IPP) modules (psModules). These modules 6 6 use the functionality of the Pan-STARRS Library (psLib) to perform more complex tasks associated with image 7 7 processing. Modules were constructed to support each of the required processing stages and are listed according … … 9 9 structures and functions are prefixed with pm, an abbreviation for Pan-STARRS Modules. 10 10 11 The capabilities provided by psModule are grouped into the following areas which are11 The capabilities provided by psModules are grouped into the following areas which are 12 12 also reflected in the file system directory structure: 13 13 - Configuration … … 19 19 - Image Subtraction 20 20 21 The installed code for psModule consists of header files and a binary library.21 The installed code for psModules consists of header files and a binary library. 22 22 23 23 @section extinstall Required external Libraries … … 37 37 We recommend using the particular versions listed as compatibility tested, as 38 38 that is the only versions of the external libraries tested to work well with psLib 39 and psModule . Though it is quite possible that later versions of the libraries39 and psModules. Though it is quite possible that later versions of the libraries 40 40 listed will also work, care must be taken when upgrading these libraries to verify 41 41 that its functionality is compatible with the tested version. … … 43 43 @section install How to Build from Source 44 44 45 Tested versions of psModule are put into a tar file and can be downloaded from:45 Tested versions of psModules are put into a tar file and can be downloaded from: 46 46 47 47 https://mhpcc.pan-starrs.org/code/releases … … 58 58 59 59 60 @section build How to Build and Test the psModule Library.60 @section build How to Build and Test the psModules Library. 61 61 62 The psModule library and associated tests are made via the GNU autoconf/automake system.62 The psModules library and associated tests are made via the GNU autoconf/automake system. 63 63 64 The source should build using the configure script in the psModule directory. The64 The source should build using the configure script in the psModules directory. The 65 65 recommended steps are: 66 66 <pre> 67 $ cd ps Module67 $ cd psmodules 68 68 $ ./configure 69 69 $ make … … 77 77 78 78 Other configuration options, such as location of external libraries, are also available. 79 To get a list of options, type the following in the top psModule directory.79 To get a list of options, type the following in the top psModules directory. 80 80 <pre> 81 81 $ configure --help … … 94 94 95 95 96 @section usage Building and Linking your code to the psModule library96 @section usage Building and Linking your code to the psModules library 97 97 98 98 To assist the use of the library with your own code, a configuration tool is part 99 of the psModule library package. This tool, psmodule-config, is installed in the BIN99 of the psModules library package. This tool, psmodules-config, is installed in the BIN 100 100 directory, according to the options given to the configure script. 101 101 102 The required CFLAG options for the compiler stage of code that uses psModule can be103 obtained via 'psmodule -config --cflags'. This outputs the cc options that supplies104 include path(s) required to find the psModule headers.102 The required CFLAG options for the compiler stage of code that uses psModules can be 103 obtained via 'psmodules-config --cflags'. This outputs the cc options that supplies 104 include path(s) required to find the psModules headers. 105 105 106 The required linking options, can be obtained via 'psmodule -config --libs'. This106 The required linking options, can be obtained via 'psmodules-config --libs'. This 107 107 outputs the ld options that supplies the library paths and files required to 108 link to the psModule library.108 link to the psModules library. 109 109 110 Note: psmodule -config usage above refers to the install locations of the library.110 Note: psmodules-config usage above refers to the install locations of the library. 111 111 112 112 @section doc How to Create Code Documentation … … 115 115 documentation embedded in the code using the following commands: 116 116 <pre> 117 $ cd ps Module117 $ cd psmodules 118 118 $ make docs 119 119 </pre>
Note:
See TracChangeset
for help on using the changeset viewer.
