plimagefr.3plplot man page

plimagefr — Plot a 2D matrix using cmap1

Synopsis

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

Description

Plot a 2D matrix using cmap1.

Redacted form: General: plimagefr(idata, xmin, xmax, ymin, ymax, zmin, zmax, valuemin, valuemax, pltr, pltr_data)

This function is used in example 20.

Arguments

idata (PLFLT_MATRIX(3plplot), input)

A matrix of values (intensities) to plot.  Should have dimensions of nx by ny.

nx, ny (PLINT(3plplot), input)

Dimensions of idata

xmin, xmax, ymin, ymax (PLFLT(3plplot), input)

See the discussion of pltr below for how these arguments are used (only for the special case when the callback function pltr is not supplied).

zmin, zmax (PLFLT(3plplot), input)

Only data between zmin and zmax (inclusive) will be plotted.

valuemin, valuemax (PLFLT(3plplot), input)

The minimum and maximum data values to use for value to color mappings.  A datum equal to or less than valuemin will be plotted with color 0.0, while a datum equal to or greater than valuemax will be plotted with color 1.0.  Data between valuemin and valuemax map linearly to colors in the range (0.0-1.0).

pltr (PLTRANSFORM_callback, input)

A callback function that defines the transformation between the zero-based indices of the matrix idata and world coordinates. If pltr is not supplied (e.g., is set to NULL in the C case), then the x indices of idata are mapped to the range xmin through xmax and the y indices of idata are mapped to the range ymin through ymax.For the C case, transformation functions are provided in the PLplot library: pltr0(3plplot) for the identity mapping, and pltr1(3plplot) and pltr2(3plplot) for arbitrary mappings respectively defined by vectors and matrices.  In addition, C callback routines for the transformation can be supplied by the user such as the mypltr function in examples/c/x09c.c which provides a general linear transformation between index coordinates and world coordinates.For languages other than C you should consult the PLplot documentation for the details concerning how PLTRANSFORM_callback arguments are interfaced. However, in general, a particular pattern of callback-associated arguments such as a tr vector with 6 elements; xg and yg vectors; or xg and yg matrices are respectively interfaced to a linear-transformation routine similar to the above mypltr function; pltr1(3plplot); and pltr2(3plplot). Furthermore, some of our more sophisticated bindings (see, e.g., the PLplot documentation) support native language callbacks for handling index to world-coordinate transformations.  Examples of these various approaches are given in examples/<language>x09*, examples/<language>x16*, examples/<language>x20*, examples/<language>x21*, and examples/<language>x22*, for all our supported languages.

pltr_data (PL_GENERIC_POINTER(3plplot), input)

Extra parameter to help pass information to pltr0(3plplot), pltr1(3plplot), pltr2(3plplot), or whatever routine is externally supplied.

Authors

Many developers (who are credited at http://plplot.sourceforge.net/credits.php) have contributed to PLplot over its long history.

See Also

PLplot documentation at http://plplot.sourceforge.net/documentation.php.

Info

January, 2017 PLplot API