-$ cvs -d:ext:username@gforge.mhpcc.hawaii.edu:/cvsroot/panstarrs co opt -$ cd opt -$ make -$ cd .. -+The installed code for psLib consists of header files and binary libraries in the form of static +(libpslib.a) and shared (libpslib.so or libpslib.dylib for OX/X.) Assuming these components +have been built and installed in the standard library path, psLib may be used within a program by +including the line #include
-$ cvs -d:ext:username@gforge.mhpcc.hawaii.edu:/cvsroot/panstarrs co -r rel4 IPP +$ cvs -d:ext:username@gforge.mhpcc.hawaii.edu:data/panstarrs/cvsroot co -P psLib+ -The source should build from the Makefile in the IPP/src directory. The +The source should build from the Makefile in the psLib/src directory. The recommended steps are:
-$ cd IPP/src -$ make distclean +$ cd psLib/src +$ make clean-
-This deletes any old object and target files -+This deletes any old object and target files.
$ make $ make install-this installs all the executables and shared objects to $INSTALLDIR/bin -and $INSTALLDIR/lib, respectively. If the environment-variable INSTALLDIR is -not set, the path to the top-level IPP directory is used. - -The environment variable CC can be set to specify what C compiler to use. If -the opt module is not checked out in the same parent directory as IPP, the -OPTDIR environment variable should be set to the path of the opt directory. - -@section run How to Run - -The package consists of an executable called IPP as well as a Perl module -version of a great many functions, either can be used as the 'engine' as -described in the SRS. - -@subsection complexengine "Simple Engine": - -The IPP executable tself does no image processing. It just parses a simple -pipeline scripting language that describes the processing steps of the pipeline. -Each line of this text file, starts with either a keyword or a module name -followed by a list of parameters in the form 'name=value'. Keywords currently -supported in the pipeline scripting language are 'GlobalParameters' and -'Message'. 'GlobalParameters' adds the parameters that follow to the -parameter list of every module that is called. 'Message' prints out the 'text' -parameter that follows. - -Modules are all loaded at the beginning of the process and then are called -sequentially. Data is passed between modules via their name, so modules -generally allow the specification of the name of the image input and output -names. - -The directory IPP/testsuite contains a sample pipeline configuration file that -performs all the stages of the pilot project. It assumes that the test data is -in a directory called testData that is at the same level as IPP. One can -download these files via cvs via 'cvs co testData', assuming the CVSROOT is set -for downloading the IPP from the MHPCC gForge server. - -@subsection simpleengine "Complex Engine": - -The Perl module is called 'imCal' and allows the image processing pipeline -functions to be accessed from a Perl script. A script should have the following -lines before the use of any of the pipeline functions: - use lib "path-to-IPP-module/bin"; - use imCal; - -An example Perl script of the pipeline is as follows: - -
-#! /usr/bin/perl
-# just a basic end-to-end test of the 'simple engine' Perl extensions.
-#
-use lib "../lib";
-use imCal;
-
-$dataPath = '/data/panstarrs/testData';
-$detectorGain = 1.0;
-$readoutNoise = 1.0;
-$bitPix = -32;
-$bZero = 0.0;
-$bScale = 1.0;
+This builds and installs files to psLib/lib and psLib/include.
-# read in the calibration data
-print "Reading flat field data\n";
-$flatField = readFits("$dataPath/calflat.i.o00.T0.fits");
-print "Reading bad pixel mask data\n";
-$badPixels = readFitsMask("$dataPath/badpix.i.o00.T0.fits");
-print "Reading sky fringe image\n";
-$sky[0] = readFits("$dataPath/sky0.i.o00.T0.fits");
+@section run How to Run Tests
-# read in the image.
-print "Reading imagery data\n";
-$img = readFits("$dataPath/e00000.o00.T0.fits");
+Since psLib is a library, there is no executable, per se. However, to test the installation, users
+may execute the FullUnitTest script:
+ |
+$ cd psLib/src +$ make docs ++This places documentation in psLib/docs. */