Changeset 28604 for trunk/ippMonitor/def/README

Timestamp:

Jul 2, 2010, 4:14:01 PM (16 years ago)

Author:

Serge CHASTEL

Message:

Doc + Missign plot definitions

File:

• trunk/ippMonitor/def/README (modified) (1 diff)

trunk/ippMonitor/def/README

@@ -98 +98 @@
 output column in the HTML table.
 
+Drawing Figures
+===============
+- Definition files (def/*.d) MUST be appended with Image.d to allow specific
+  processing (the template is not def/autocode.php but autocodeImage.php)
+     e.g.:        plotMyStuffImage.php
+- No changes to the previous file content except for these 4 items:
+
+     1) The 'restrict' keyword should be used in the 'show' column of
+        FIELD entry if displaying the column values is wanted.
+        Such FIELDs are used in the WHERE restriction clause, not in
+        the query.
+
+        Note for developpers: actually any word different from the
+        existing keywords '', 'value', 'none', 'image=xxx',
+        'value=xxx' are ok.  No code was developped to support this
+        keyword in the scritps/generate script.
+
+     2) 'TOPLOT <list of db columns>': defines the list of columns to
+        query.
+        e.g.: 
+              TOPLOT camProcessedExp.fwhm_major
+              TOPLOT chipProcessedImfile.bg, rawExp.sun_angle
+        All values (no LIMIT) are written to a temporary (text) file
+        of the /tmp directory.
+        In a row, the different values are separated by a single space
+        (i.e. ' ').
+
+     3) 'PLOTTER <php_script_name>': defines the name of the PHP
+        script that will call an external tool (e.g. a DVO script).
+        
+        It is expected that the PHP script named 'php_script_name'
+        supports the following parameters:
+        - input: the name of an input text filename;
+        - output: the name of an output image filename;
+        - title: a string (see item 4) PLOTTITLE).
+
+        e.g.:
+                PLOTTER scatterPlot.php 
+                PLOTTER plotHistogram.php
+
+        The list of existing plotters are detailed further.
+
+     4) 'PLOTTITLE <A title>': defines the title of a figure. Could be
+        used in the external program which is effectively used for
+        rendering the figure.
+
+        e.g.:
+                PLOTTITLE A title
+
+Existing plotting scripts
+=========================
+raw/skyplot.php (calls scripts/skyplot.dvo)
+        Text input file needs to contain 3 columns
+
+raw/plotHistogram.php (calls scripts/build_histogram.dvo)
+        Text input file needs to contain 1 column
+        Computes the histogram of the input file data for 100 bins.
+
+raw/scatterPlot.php (calls scripts/pot_x_vs_y.dvo)
+        Text input file needs to contain 2 columns
+        Scatter plot of the first column values vs the second ones
+        Regression line is also plotted (correlation coefficient is
+        shown in title).
+
+Known bugs of the plotting scripts
+==================================
+- the temporary files are not deleted.