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