include/matio.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _matio_h
  40 #define _matio_h
  41 #include "visibility.h"
  42 #include "typedefs.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 GMX_LIBGMX_EXPORT
  49 gmx_bool matelmt_cmp(t_xpmelmt e1, t_xpmelmt e2);
  50
  51 GMX_LIBGMX_EXPORT
  52 t_matelmt searchcmap(int n, t_mapping map[], t_xpmelmt c);
  53 /* Seach in the map for code 'c' and return entry number.
  54  * return -1 if not found
  55  */
  56
  57 GMX_LIBGMX_EXPORT
  58 int getcmap(FILE *in, const char *fn, t_mapping **map);
  59 /* Read the mapping table from in, return number of entries */
  60
  61 int readcmap(const char *fn, t_mapping **map);
  62 /* Read the mapping table from fn, return number of entries */
  63
  64 void printcmap(FILE *out, int n, t_mapping map[]);
  65 /* print mapping table to out */
  66
  67 void writecmap(const char *fn, int n, t_mapping map[]);
  68 /* print mapping table to fn */
  69
  70 GMX_LIBGMX_EXPORT
  71 int read_xpm_matrix(const char *fnm, t_matrix **matrix);
  72 /* Reads a number of matrices from .xpm file fnm and returns this number */
  73
  74 GMX_LIBGMX_EXPORT
  75 real **matrix2real(t_matrix *matrix, real **mat);
  76 /* Converts an matrix in a t_matrix struct to a matrix of reals
  77  * When mat==NULL memory will be allocated
  78  * Returns NULL when something went wrong
  79  */
  80
  81 GMX_LIBGMX_EXPORT
  82 void write_xpm_m(FILE *out, t_matrix m);
  83 /* Writes a t_matrix struct to .xpm file */
  84
  85 GMX_LIBGMX_EXPORT
  86 void write_xpm3(FILE *out, unsigned int flags,
  87                 const char *title, const char *legend,
  88                 const char *label_x, const char *label_y,
  89                 int n_x, int n_y, real axis_x[], real axis_y[],
  90                 real *matrix[], real lo, real mid, real hi,
  91                 t_rgb rlo, t_rgb rmid, t_rgb rhi, int *nlevels);
  92 /* See write_xpm.
  93  * Writes a colormap varying as rlo -> rmid -> rhi.
  94  */
  95 GMX_LIBGMX_EXPORT
  96 void write_xpm_split(FILE *out, unsigned int flags,
  97                      const char *title, const char *legend,
  98                      const char *label_x, const char *label_y,
  99                      int n_x, int n_y, real axis_x[], real axis_y[],
 100                      real *matrix[],
 101                      real lo_top, real hi_top, int *nlevel_top,
 102                      t_rgb rlo_top, t_rgb rhi_top,
 103                      real lo_bot, real hi_bot, int *nlevel_bot,
 104                      gmx_bool bDiscreteColor,
 105                      t_rgb rlo_bot, t_rgb rhi_bot);
 106 /* See write_xpm.
 107  * Writes a colormap with separate above and below diagonal colormaps.
 108  * If bDiscrete then a colormap with 16 fixed colors is used, first  of
 109  * which is white.
 110  */
 111
 112 GMX_LIBGMX_EXPORT
 113 void write_xpm(FILE *out, unsigned int flags,
 114                const char *title, const char *legend,
 115                const char *label_x, const char *label_y,
 116                int n_x, int n_y, real t_x[], real t_y[],
 117                real *matrix[], real lo, real hi,
 118                t_rgb rlo, t_rgb rhi, int *nlevels);
 119 /* out        xpm file
 120  * flags      flags, defined types/matrix.h
 121  *            MAT_SPATIAL_X
 122  *            MAT_SPATIAL_Y
 123  *            Defines if x and y are spatial dimensions,
 124  *            when not, there are n axis ticks at the middle of the elements,
 125  *            when set, there are n+1 axis ticks at the edges of the elements.
 126  * title      matrix title
 127  * legend     label for the continuous legend
 128  * label_x    label for the x-axis
 129  * label_y    label for the y-axis
 130  * n_x, n_y   size of the matrix
 131  * axis_x[]   the x-ticklabels (n_x or n_x+1)
 132  * axis_y[]   the y-ticklables (n_y or n_y+1)
 133  * *matrix[]  element x,y is matrix[x][y]
 134  * lo         output lower than lo is set to lo
 135  * hi         output higher than hi is set to hi
 136  * rlo        rgb value for level lo
 137  * rhi        rgb value for level hi
 138  * nlevels    number of color levels for the output
 139  */
 140
 141 GMX_LIBGMX_EXPORT
 142 real **mk_matrix(int nx, int ny, gmx_bool b1D);
 143
 144 GMX_LIBGMX_EXPORT
 145 void done_matrix(int nx, real ***m);
 146
 147 void clear_matrix(int nx, int ny, real **m);
 148
 149 #ifdef __cplusplus
 150 }
 151 #endif
 152
 153 #endif  /* _matio_h */