libPET

Readme

2005-01-17
Turku PET Centre

LibPET is distributed under the GNU Lesser General Public Licence
http://www.turkupetcentre.net/programs/lgpl-license.html
More information on open source licences: http://www.opensource.org

Description
------------------------

The LibPET library is a collection of commonly used C files in Turku PET Centre.
It's purpose is to aid version control and keep all the files in one place.

List of files
------------------------

include/     -	Includes all the .h files for the .c files

Makefile     -	The makefile.

history      -  Change history

Doxygen      -  Configuration file for Doxygen

README       -  This file

 .C files **

aic.c        -  Model selection and weighting using Akaike's information criteria.

analyze.c    -  reading and writing Analyze 7.5 image files.

bootstrap.c  -  Bootstrap algorithm for computing parameter confidence limits and
                standard deviations.

dft.c	     -	Reading and writing DFT (TAC) files.

ecat63ml.c   -  Procedures for ECAT 6.3 matrix list.

ecat63p.c    -  Printing ECAT 6.3 headers.

ecat63r.c    -  Reading ECAT 6.3 files.

ecat63w.c    -  Writing ECAT 6.3 files.

ecat7ml.c    -  Procedures for ECAT 7.x matrix list.

ecat7p.c     -  Printing ECAT 7.x headers.

ecat7r.c     -  Reading ECAT 7.x files.

ecat7w.c     -  Writing ECAT 7.x files.

gaussdev.c   -  Adds normally distributed Gaussian deviate with zero mean and unit variance.

halflife.c   -  Procedures for isotopes and correction of physical decay.

hholder.c    -  Householder transform.

idcrypt.c    -  String encryption/decryption

img.c        -  Procedures for 4D image data (common to all image file formats).

imgfile.c    -  Procedures for 4D image read/write.

imgproc.c    -  Additional procedures for 4D image data.

integr.c     -	TAC interpolation and integration.

intex.c      -  Expanding string expressions of integers to an array of ints.

libpetv.c    -  For displaying compilation time of this library.

llsqwt.c     -  Methods for line fit with errors in both coordinates.

mathfunc.c   -  Procedures for FIT files and mathematical functions.

ncifile.c    -  Support for previous TAC format (*.roi.kbq/*.roi.nci).

nnls.c       -  Nonnegative linear least squares (Lawson-Hanson algorithm).

pearson.c    -  Calculation of Pearson's correlation coefficient.

petc99.c     -  ISO C99 functions that are not yet widely available in
                common compilers.

powell.c     -  Powell-Brent minimization routine.

qr.c         -  QR decomposition for overdetermined systems.

result.c     -  Reading and writing result files.

roi.c        -  Reading and writing CTI ECAT 6.3 region-of-interest files.

simplex.c    -  Simplex (Nelder-Mead) minimization routine.

simulate.c   -  Simulation of compartmental model curves.

studynr.c    -  Functions for processing PET study number.

swap.c       -  Byte swapping between little and big endian platforms.

tgo.c        -  Topographical global optimization, based on algorithm by Törn & Viitanen.

vol.c        -  Procedures for 3D image volume data (no time information).

Installation
------------------------

This library has been tested to compile under Solaris, SunOS and DOS with gcc and djgpp.
To compile, just type 'make'. No modifications should be necessary to the Makefile.
The compiled library is kept in /usr/local/lib and the header files in /usr/local/include.

Using the library
------------------------

The program that uses the library should include the .h file it needs
eg. #include <dft.h>
To compile, link the library with -lpetIf the library and/or the .h files are outside normal compiler search path,
add these lines when compiling
-L<path to="" library="">  eg. -L/usr/local/lib
-I<path to .h files> eg. -I/usr/local/include

Extending the library
------------------------

To add new files to the library, first copy the .c file(s) to the libpet directory
and the .h file(s) to the libpet/include directory.
Modify the C file if necessary.
Add the .c file(s) to the Makefile's CFILES line.
Then just recompile and copy the libpet.a to its place.
PLEASE update the README and HISTORY file to include the new .c file !

---