X-Git-Url: http://git.kpe.io/?p=ctsim.git;a=blobdiff_plain;f=README;h=9146dbcc7324d5dfde810a0200a6f59a3f32da90;hp=d2bd46564bcebddcef3b73e3a5ead14a29a583f3;hb=HEAD;hpb=fa52994392de0947079edfa69247f73520e850c4 diff --git a/README b/README index d2bd465..9146dbc 100644 --- a/README +++ b/README @@ -1,17 +1,25 @@ -COPYRIGHT -========= -This program is written by Kevin M. Rosenberg, M.D. +OVERVIEW +======== -It is covered by the GNU General Public License (GPL) which -allows copying and modifying this code with restrictions. See the -file COPYING for complete details. +CTSim simulates the process of collecting tomographic X-ray data of +phantom objects. These X-ray data through the objects are called +projections. CTSim reconstructs the original phantom image from the +projections using a variety of algorithms. + +CTSim is open-source and is covered by the GNU Public License (GPL). + +Please enjoy CTSim. I'd like to hear any feedback + +Kevin M. Rosenberg, M.D. +kevin@rosenberg.net HISTORY ======= CTSim development began in 1983 while I was in medical school. It was -written using Lattice C and MS-DOS. I used assembly language to write +written using Lattice C and MS-DOS. I used 8086 assembly language to +code convolution and backprojection routes and also to write graphics directly to an IBM EGA video adapter. In 1999, I ported CTsim to GNU/Linux. In April 2000, the source code @@ -20,26 +28,17 @@ for CTSim was published on the Internet. In June 2000, entire code for revised and converted to C++. -STATUS -====== - -The official home for CTsim is http://www.ctsim.org. From this site, -you can download the CTsim source code and use CTSim online using a -beowulf cluster. +WHERE +===== -I would be very pleased to have other developers join me in the -development of CTSim. Please see the TODO list for the most obvious -ideas. +The official home for CTsim is http://www.ctsim.org. -OVERVIEW +FEATURES ======== -CTSim simulates the collection of x-rays by a CT scanner. These x-rays -of objects are called projections. - -Phantom objects are defined. Several built-in phantoms are included, -as well as an extension to load files of phantom definitions. +Several standard phantom objects are built-in. Other phantoms can be +loaded from ASCII files. CTsim uses cross-platform compatible file formats for projection data and image data. @@ -63,10 +62,14 @@ SDF file. pj2if - Converts projection data to a raw sinugram image -if2img - Converts an image file to a variety of 8-bit and 16-bit image +pjinfo - Show information on a projection file + +ifexport - Converts an image file to a variety of 8-bit and 16-bit image formats -pjinfo - Show information on a projection file +if1 - Performs operations on a single image file + +if2 - Performs operations on two image files, such as comparisons ifinfo - Show statistics and history labels of image files @@ -87,16 +90,16 @@ When evaluating CT simulation, in general, these steps are followed: Create a phantom image and viewable image file phm2if ... - if2img ... + ifexport ... Simulate CT data collection and create a viewable image of raw projections phm2pj ... pj2if ... - if2img ... + ifexport ... Perform CT reconstruction and create viewable image file pjrec ... - if2img ... + ifexport ... Display image information and comparative statistics ifinfo ... @@ -108,13 +111,12 @@ These functions can be invoked via a web interface with a CGI program as described in the INSTALL file. -CLOSING -======= - -Please enjoy CTSim. I'd like to hear any feedback - -Kevin M. Rosenberg, M.D. -kevin@rosenberg.net +COPYRIGHT +========= +This program is written by Kevin M. Rosenberg, M.D. +It is covered by the GNU General Public License (GPL) which +allows copying and modifying this code with restrictions. See the +file COPYING for complete details.