2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014, 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.
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.
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.
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.
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.
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.
38 #ifndef GMX_FILEIO_MATIO_H
39 #define GMX_FILEIO_MATIO_H
43 #include "../legacyheaders/types/matrix.h"
49 gmx_bool matelmt_cmp(t_xpmelmt e1, t_xpmelmt e2);
51 t_matelmt searchcmap(int n, t_mapping map[], t_xpmelmt c);
52 /* Seach in the map for code 'c' and return entry number.
53 * return -1 if not found
56 int getcmap(FILE *in, const char *fn, t_mapping **map);
57 /* Read the mapping table from in, return number of entries */
59 int readcmap(const char *fn, t_mapping **map);
60 /* Read the mapping table from fn, return number of entries */
62 void printcmap(FILE *out, int n, t_mapping map[]);
63 /* print mapping table to out */
65 void writecmap(const char *fn, int n, t_mapping map[]);
66 /* print mapping table to fn */
68 int read_xpm_matrix(const char *fnm, t_matrix **mat);
69 /* Reads a number of matrices from .xpm file fnm and returns this number */
71 real **matrix2real(t_matrix *in, real **out);
72 /* Converts an matrix in a t_matrix struct to a matrix of reals
73 * When mat==NULL memory will be allocated
74 * Returns NULL when something went wrong
77 void write_xpm_m(FILE *out, t_matrix m);
78 /* Writes a t_matrix struct to .xpm file */
80 void write_xpm3(FILE *out, unsigned int flags,
81 const char *title, const char *legend,
82 const char *label_x, const char *label_y,
83 int n_x, int n_y, real axis_x[], real axis_y[],
84 real *mat[], real lo, real mid, real hi,
85 t_rgb rlo, t_rgb rmid, t_rgb rhi, int *nlevels);
87 * Writes a colormap varying as rlo -> rmid -> rhi.
89 void write_xpm_split(FILE *out, unsigned int flags,
90 const char *title, const char *legend,
91 const char *label_x, const char *label_y,
92 int n_x, int n_y, real axis_x[], real axis_y[],
94 real lo_top, real hi_top, int *nlevel_top,
95 t_rgb rlo_top, t_rgb rhi_top,
96 real lo_bot, real hi_bot, int *nlevel_bot,
97 gmx_bool bDiscreteColor,
98 t_rgb rlo_bot, t_rgb rhi_bot);
100 * Writes a colormap with separate above and below diagonal colormaps.
101 * If bDiscrete then a colormap with 16 fixed colors is used, first of
105 void write_xpm(FILE *out, unsigned int flags,
106 const char *title, const char *legend,
107 const char *label_x, const char *label_y,
108 int n_x, int n_y, real t_x[], real t_y[],
109 real *mat[], real lo, real hi,
110 t_rgb rlo, t_rgb rhi, int *nlevels);
112 * flags flags, defined types/matrix.h
115 * Defines if x and y are spatial dimensions,
116 * when not, there are n axis ticks at the middle of the elements,
117 * when set, there are n+1 axis ticks at the edges of the elements.
119 * legend label for the continuous legend
120 * label_x label for the x-axis
121 * label_y label for the y-axis
122 * n_x, n_y size of the matrix
123 * axis_x[] the x-ticklabels (n_x or n_x+1)
124 * axis_y[] the y-ticklables (n_y or n_y+1)
125 * *mat[] element x,y is mat[x][y]
126 * lo output lower than lo is set to lo
127 * hi output higher than hi is set to hi
128 * rlo rgb value for level lo
129 * rhi rgb value for level hi
130 * nlevels number of color levels for the output
133 real **mk_matrix(int nx, int ny, gmx_bool b1D);
135 void done_matrix(int nx, real ***m);
137 void clear_matrix(int nx, int ny, real **m);
143 #endif /* GMX_FILEIO_MATIO_H */