1PLIMAGEFR(3plplot)                PLplot API                PLIMAGEFR(3plplot)
2
3
4

NAME

6       plimagefr - Plot a 2D matrix using cmap1
7

SYNOPSIS

9       plimagefr(idata,  nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, valuemin,
10       valuemax, pltr, pltr_data)
11

DESCRIPTION

13       Plot a 2D matrix using cmap1.
14
15       Redacted form: General: plimagefr(idata, xmin, xmax, ymin, ymax,  zmin,
16       zmax, valuemin, valuemax, pltr, pltr_data)
17
18
19       This function is used in example 20.
20

ARGUMENTS

22       idata (PLFLT_MATRIX(3plplot), input)
23              A  matrix  of  values (intensities) to plot.  Should have dimen‐
24              sions of nx by ny.
25
26       nx, ny (PLINT(3plplot), input)
27              Dimensions of idata
28
29       xmin, xmax, ymin, ymax (PLFLT(3plplot), input)
30              See the discussion of pltr below for  how  these  arguments  are
31              used  (only for the special case when the callback function pltr
32              is not supplied).
33
34       zmin, zmax (PLFLT(3plplot), input)
35              Only data between zmin and zmax (inclusive) will be plotted.
36
37       valuemin, valuemax (PLFLT(3plplot), input)
38              The minimum and maximum data values to use for  value  to  color
39              mappings.   A datum equal to or less than valuemin will be plot‐
40              ted with color 0.0, while a datum equal to or greater than  val‐
41              uemax will be plotted with color 1.0.  Data between valuemin and
42              valuemax map linearly to colors in the range (0.0-1.0).
43
44       pltr (PLTRANSFORM_callback(3plplot), input)
45              A callback function that defines the transformation between  the
46              zero-based indices of the matrix idata and world coordinates. If
47              pltr is not supplied (e.g., is set to NULL in the C case),  then
48              the x indices of idata are mapped to the range xmin through xmax
49              and the y indices of idata are mapped to the range ymin  through
50              ymax.For  the  C  case, transformation functions are provided in
51              the PLplot library: pltr0(3plplot) for the identity mapping, and
52              pltr1(3plplot) and pltr2(3plplot) for arbitrary mappings respec‐
53              tively defined by vectors and matrices.  In addition, C callback
54              routines for the transformation can be supplied by the user such
55              as the mypltr function in  examples/c/x09c.c  which  provides  a
56              general  linear  transformation  between  index  coordinates and
57              world coordinates.For languages other than C you should  consult
58              the PLplot documentation for the details concerning how PLTRANS‐
59              FORM_callback(3plplot) arguments  are  interfaced.  However,  in
60              general,  a  particular pattern of callback-associated arguments
61              such as a tr vector with 6 elements; xg and yg  vectors;  or  xg
62              and  yg  matrices are respectively interfaced to a linear-trans‐
63              formation  routine  similar  to  the  above   mypltr   function;
64              pltr1(3plplot);  and  pltr2(3plplot).  Furthermore,  some of our
65              more sophisticated bindings (see, e.g.,  the  PLplot  documenta‐
66              tion)  support  native  language callbacks for handling index to
67              world-coordinate transformations.   Examples  of  these  various
68              approaches  are given in examples/<language>x09*, examples/<lan‐
69              guage>x16*,  examples/<language>x20*,   examples/<language>x21*,
70              and examples/<language>x22*, for all our supported languages.
71
72       pltr_data (PLPointer(3plplot), input)
73              Extra  parameter  to  help  pass  information to pltr0(3plplot),
74              pltr1(3plplot), pltr2(3plplot), or whatever  routine  is  exter‐
75              nally supplied.
76
77

AUTHORS

79       Many  developers  (who  are  credited at http://plplot.org/credits.php)
80       have contributed to PLplot over its long history.
81

SEE ALSO

83       PLplot documentation at http://plplot.org/documentation.php.
84
85
86
87                                September, 2020             PLIMAGEFR(3plplot)
Impressum