irplib_plot.h

00001 /* $Id: irplib_plot.h,v 1.12 2009/05/12 13:06:43 llundin Exp $
00002  *
00003  * This file is part of the irplib package
00004  * Copyright (C) 2002,2003 European Southern Observatory
00005  *
00006  * This program is free software; you can redistribute it and/or modify
00007  * it under the terms of the GNU General Public License as published by
00008  * the Free Software Foundation; either version 2 of the License, or
00009  * (at your option) any later version.
00010  *
00011  * This program is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  * GNU General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU General Public License
00017  * along with this program; if not, write to the Free Software
00018  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02111-1307  USA
00019  */
00020 
00021 /*
00022  * $Author: llundin $
00023  * $Date: 2009/05/12 13:06:43 $
00024  * $Revision: 1.12 $
00025  * $Name: HEAD $
00026  */
00027 
00028 #ifndef IRPLIB_PLOT_H
00029 #define IRPLIB_PLOT_H
00030 
00031 /*-----------------------------------------------------------------------------
00032                                    Includes
00033  -----------------------------------------------------------------------------*/
00034 
00035 #include <cpl.h>
00036 
00037 /*-----------------------------------------------------------------------------
00038                                    Defines
00039  -----------------------------------------------------------------------------*/
00040 
00041 #define irplib_plot_manpage                                     \
00042     "The recipe can produce a number of predefined plots. "     \
00043     "Zero means that none of the plots are produced, while "    \
00044     "increasing values (e.g. 1 or 2) increases the number "     \
00045     "of plots produced. If the plotting fails a warning is "    \
00046     "produced, and the recipe continues. "                      \
00047     "The default behaviour of the plotting is to use "          \
00048     "gnuplot (with option -persist). The recipe currently "     \
00049     "produces 1D-plots using gnuplot commands. The recipe "     \
00050     "user can control the actual plotting-command used by "     \
00051     "the recipe to create the plot by setting the "             \
00052     "environment variable CPL_PLOTTER. Currently, if "          \
00053     "CPL_PLOTTER "                                              \
00054     "is set it must contain the string 'gnuplot'. Setting "     \
00055     "it to 'cat > my_gnuplot_$$.txt' causes a number of "       \
00056     "ASCII-files to be created, which each produce a plot "     \
00057     "when given as standard input to gnuplot (e.g. later "      \
00058     "or on a different computer). A finer control of the "      \
00059     "plotting options can be obtained by writing an "           \
00060     "executable script, e.g. my_gnuplot.pl, that "              \
00061     "executes gnuplot after setting the desired gnuplot "       \
00062     "options (e.g. set terminal pslatex color) "                \
00063     "and then setting CPL_PLOTTER to my_gnuplot.pl. "           \
00064     "The predefined plots include plotting of images. "         \
00065     "Images can be plotted not only with gnuplot, but also "    \
00066     "using the pnm format. This is controlled with the "        \
00067     "environment variable CPL_IMAGER. If CPL_IMAGER "           \
00068     "is set to a string that does not contain the word "        \
00069     "gnuplot, the recipe will generate the plot in pnm "        \
00070     "format. E.g. setting CPL_IMAGER to "                       \
00071     "'display - &' will produce a gray-scale image "            \
00072     "using the image viewer display."
00073 
00074 
00075 #define irplib_vector_plot cpl_plot_vector
00076 #define irplib_vectors_plot cpl_plot_vectors
00077 #define irplib_table_plot cpl_plot_column
00078 #define irplib_bivector_plot cpl_plot_bivector
00079 #define irplib_bivectors_plot cpl_plot_bivectors
00080 #define irplib_image_plot cpl_plot_image
00081 #define irplib_image_row_plot cpl_plot_image_row
00082 #define irplib_image_col_plot cpl_plot_image_col
00083 
00084 #endif

Generated on Thu Mar 24 11:59:39 2011 for VISIR Pipeline Reference Manual by  doxygen 1.5.8