README

   1 PyPlotSuite README File
   2 =======================
   3
   4 .Copyright and License
   5 *************************************************
   6 Copyright (C) 2006-2007 Antonino Ingargiola <tritemio@gmail.com>
   7
   8 This program is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2 of the License, or
  11 (at your option) any later version.
  12
  13 This program is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 For more information read the file LICENSE.txt in the source directory.
  19 *************************************************
  20
  21
  22 Project Description
  23 -------------------
  24
  25 *PyPlotSuite* is a set of graphical tools to quick visualize and explore/analyze
  26 monodimentional and bidimensional data. The plot produced can be saved in a
  27 variety of image formats to produce publication quality graphs.
  28
  29 At the moment the project is composed by two little stand alone applications:
  30 *ImageAnalyzer* and *Plotfile2*. ImageAnalyzer is focused towards images (or any
  31 2D data, such as arrays) visualization, analysis, and measurement. Plotfile2
  32 focus is towards simple data series visualization, with the possibility to
  33 quick modify many plot characteristics. Both applications can save the result
  34 on a multitude of image file formats (png, eps, jpeg, pdf, and more).
  35
  36 PyPlotSuite is written in python, using the GTK gui toolkit (through the python
  37 binding pygtk, and using Glade-2 to layout the windows). All plots are created
  38 with the great Matplotlib python 2D graphic library. Matplotlib is such a good
  39 tool that the PyPlotSuite applications are only tiny wrapper around Matplotlib
  40 functionality. Also some Numpy functionality are used both through Matplotlib
  41 (which requires Numpy) and both directly.
  42
  43 Home Page::         http://pyplotsuite.sourceforge.net[]
  44 *Latest Version*::  0.1-alpha6
  45
  46
  47 NEWS
  48 ----
  49
  50 This is the first version of PyPlotSuite released as a single tarball. It
  51 includes both ImageAnalyzer and Plotfile2.
  52
  53 A new plot property dialog in Plotfile2 allows to change many plot parameters
  54 (line style and width, marker style and size). There's also the GUI for
  55 changing the colors of the various plot elements but this functions is not
  56 implemented in the underlying code yet.
  57
  58
  59 Release Notice
  60 --------------
  61
  62 Early versions of *ImageAnalyzer* and *Plotfile2* were released in separated
  63 tarballs with separated version number. Now they are released together in the
  64 same tarball with the same version number (and I plan to integrate them more).
  65 However they retain separated changelogs, so you can keep track of each
  66 application separately.
  67
  68 The development version of *PyPlotSuite* is hosted on a
  69 http://repo.or.cz/w/pyplotsuite.git[git repository]. To download the latest
  70 (possibly broken) development version just install http://git.or.cz/[git]
  71 and type:
  72
  73 -------------------
  74 $ git clone ssh://repo.or.cz/srv/git/pyplotsuite.git
  75 -------------------
  76
  77 Now you have a complete working version of PyPlotSuite to test/hack on. If git
  78 and cogito does not work on your OS (i.e. windows) look at
  79 http://bazaar-vcs.org/[bazar] that is multiplatform SCM with a git plugin too.
  80
  81
  82 Requirements
  83 ------------
  84
  85 You must have this software installed in order to be able to run the program:
  86
  87 - Any recent version of Linux, Mac OSX or Windows
  88
  89 - Python 2.4 or newer (2.3 may still work, not tested):
  90     http://www.python.org[]
  91
  92 - PyGTK 2.x:
  93     http://www.pygtk.org/[]
  94
  95 - NumPy (1.0 or newer)
  96     http://numpy.scipy.org/[]
  97
  98 - MatPlotLib (tested on 0.87):
  99     http://matplotlib.sourceforge.net/[]
 100
 101 - SciPy (only the module scipy.ndimage.filters):
 102     http://www.scipy.org/[]
 103
 104 - Python Image Library (PIL):
 105     http://www.pythonware.com/products/pil/[]
 106
 107 NOTE: Typically Numpy is a prerequisite for Matplotlib, so you may have
 108 installed it in bundle with Matplotlib.
 109
 110 NOTE: The Scipy module and the PIL library are a requirement only if you want
 111 to run ImageAnalyzer. Plotfile2 does not requires them.
 112
 113
 114 Image Analyzer
 115 --------------
 116
 117 Name::              Image Analyzer
 118 Description::       A tool to extract and make measures on scientific images.
 119
 120
 121 Description
 122 ~~~~~~~~~~~
 123
 124 Image Analyzer is a python[0] program written with the purpose to analyze
 125 scientific images to extract information such dimensions, and to reveal some
 126 subtle features. You can also create and save publication quality figures in a
 127 variety of hard-copy formats (using Matplotlib[3]).
 128
 129 To execute the program type "python imageanalyzer.py".
 130 But before check the software requirement above.
 131
 132
 133 Image formats supported
 134 ~~~~~~~~~~~~~~~~~~~~~~~
 135
 136 All format supported by the PIL[4] library, with the following format:
 137 - L (Luminance, aka black&white) 8 bit and 14 bit
 138 - RBG(A) with 8bit per channel
 139
 140
 141 Features
 142 ~~~~~~~~
 143
 144 The features currently implemented are:
 145
 146     - Load, zoom and navigate on any RBG(A) or L (Luminance, aka black&white)
 147       images.
 148     - The possibility to choose one of the following 17 interpolation algorithms:
 149           Bessel, Bicubic, Bilinear, Blackman, Catrom, Gaussian, Hamming,
 150           Hanning, Hermite, Kaiser, Lanczos, Mitchell, Nearest, Quadric, Sinc,
 151           Spline16, Spline36.
 152       The default one is Nearest which is, in a way, "absence of interpolation".
 153     - Select one of the 14 color-maps (only for L images)
 154     - Select a dynamic range either numerically and graphically through an
 155       histogram of the image (only for L images).
 156     - Grid on/off, black/white (to match various color-maps).
 157     - Calculate the distance between two points with the option to set the pixel
 158       dimension for the image (x and y separately).
 159     - Plot the pixel-precise profile of an arbitrary number of sections of the
 160       image (only for L images).
 161
 162
 163 Plotfile2
 164 ---------
 165
 166 Name::              Plotfile2
 167 Description::       A tool plot 1D data series.
 168
 169
 170 Description
 171 ~~~~~~~~~~~
 172
 173 Plotfile2 is is a python[0] program written with the purpose to quick plot data
 174 series stored in standard ascii text files. Multiple data series can be plotted,
 175 compared and the resulting plot can be saved in a variety of image file formats
 176 with a customizable size and resolution. This feature come particularly handy
 177 if you want to embed your plot in a document and you what size the final image
 178 will have.
 179
 180 Plotfile2 is written using the GTK toolkit[1] and embeds Matplotlib[2] plot
 181 facility.
 182
 183 To execute the program, enter the Plotfile2 dir and type "python plotfile2.py".
 184
 185 See also the software requirements above.
 186
 187
 188 Features
 189 ~~~~~~~~
 190
 191 At the moment Plotfile2 can:
 192
 193     - Load one or more data series from a two column (space separated) ascii
 194       text file.
 195     - Change the X and Y axis range
 196     - Change the X and Y scale (linear or log)
 197     - Toggle the grid
 198     - Customize the plot showing points, lines or both (more advanced
 199       customization is in development)
 200     - Set the plot title and axis labels
 201     - Set the figure size (both in inches or in cm) and resolution (in dpi).
 202       This is useful to export a plot to be included in a document with a know
 203       size.
 204     - Zoom, un-zoom and pan the plot.
 205     - Save the plot in a multitude of image formats (png, jpeg, eps, pdf, ...
 206       all Matplotlib supported formats)
 207
 208
 209 Plotfile2 Roadmap
 210 ~~~~~~~~~~~~~~~~~
 211
 212 - Possibility to customize plot line style, line color, line width, marker
 213   color, marker size, marker type for each series.
 214 - Possibility to use spline interpolation (with various orders), and
 215   exponential-spline interpolation.
 216
 217
 218 Plotfile2 Known Problems
 219 ~~~~~~~~~~~~~~~~~~~~~~~~
 220 - When you change figure size and resolution through the proper dialog, the
 221   main window may show a scrambled plot (or only an corner of the entire plot).
 222   This is only a visualization issue. Therefore, if you save the file (without
 223   resizing the window!) you will obtain the image file with the correct size
 224   and resolution ready to be included in your documents.
 225
 226 NOTE: If you have any suggestion to solve this problem please contact mailto:
 227 tritemio@gmail.com[me] via mail.
 228
 229
 230 Links
 231 -----
 232
 233 1. *Python*: a dynamic object-oriented programming language.
 234
 235     * http://www.python.org[]
 236
 237
 238 2. *Numpy*: The fundamental package needed for numerical computing with Python.
 239     It is the successor (and unifier) of all the old projects (Numeric and
 240     Numarray) for python numerical computing.
 241
 242     * http://numpy.scipy.org/[]
 243
 244
 245 3. *SciPy*: Many modules that were not specific to Numpy are gathered under the
 246     broader project SciPy:
 247
 248     * http://numpy.scipy.org/[]
 249
 250
 251 4. *MatPlotLib*: A python 2D plotting library which produces publication quality
 252     figures in a variety of hard-copy formats and interactive environments
 253     across platforms.
 254
 255     * http://matplotlib.sourceforge.net/[]
 256
 257
 258 5. *Python Imaging Library* (PIL).
 259
 260     * http://www.pythonware.com/products/pil/[]
 261
 262
 263
 264 ***********************
 265 The html version of this README was generated from the ASCII file with:
 266
 267 ---------
 268 $ asciidoc -a icons -a badges README
 269 ---------
 270 ***********************
 271