JWAVE_CONTOUR Function
This JWAVE wrapper function provides a convenient interface to the PV‑WAVE CONTOUR procedure. This function always returns a Viewable object (a contour plot) to the JWAVE client.
Parameters
This section lists the parameters that the JWAVE_CONTOUR wrapper can retrieve, unpack, and use to produce a contour plot. These parameters correspond to the parameters and keywords of the PV‑WAVE CONTOUR procedure. You must set these parameters in the client application with the JWaveView.setParam method.
Z—(required) A 2D array containing the values that make up the contour surface.
X—A 1D or 2D array specifying the x-coordinates for the contour surface.
Y—A 1D or 2D array specifying the y-coordinates for the contour surface.
Keyword Parameters
This section lists the keyword parameters that can be retrieved and unpacked in this wrapper function.
Nx, Ny—If set to 1, Z (and X and Y) are interpolated from their given size into these dimensions. If set to 0 (the default), the data is not interpolated.
Filled—If set to 1, the space between contours is filled with color. If set to 0 (the default), contours are not filled.
For detailed information on the keywords listed in the following table, refer to
Appendix C: Keyword and Named Color Parameters.
Charsize | Max_Value | [XY]Margin |
Charthick | NLevels | [XY]Minor |
Clip | Noclip | [XY]Range |
C_Annotation | Position | [XY]Style |
C_Charsize | Spline | [XY]Tickformat |
C_Labels | Subtitle | [XY]Ticklen |
C_Linestyle | Thick | [XY]Tickname |
C_Thick | Tickformat | [XY]Ticks |
Follow | Ticklen | [XY]Tickv |
Font | Title | [XY]Title |
Gridstyle | [XY]Charsize | [XY]Type |
Levels | [XY]Gridstyle | |
Named Color Parameters
These parameters must be set by the JWAVE client Java application with the JWaveView.setNamedColor method.
Named ColorSet Parameters
These parameters must be set by the JWAVE client Java application with the JWaveView.setNamedColorSet method.
Returns
This wrapper returns a Viewable object (of a contour plot) to the JWAVE Java client application.
Example
In the client Java application, the setParam method is used to set the parameters to be passed to this JWAVE wrapper on the server. JWAVE_CONTOUR unpacks the parameters and builds a PV‑WAVE CONTOUR command to produce a contour plot.
This Java code sets the name of the wrapper function and some parameters. These lines of code would appear in the JWAVE client application.
JWaveView myJWaveView = new JWaveView(connection, ”JWAVE_CONTOUR”)
myJWaveView.JWaveView.setParam(”X”, elev_data);
myJWaveView.JWaveView.setParam(”CHARSIZE”, 2);
myJWaveView.JWaveView.setParam(”TITLE”, ”Boulder”);
myJWaveView.setNamedColor(”BACKGROUND”, java.awt.Color.blue);
See Also
For more information on using JWAVE wrapper functions, see
Chapter 5: JWAVE Server Development.
For more information on the PV‑WAVE CONTOUR procedure, see the PV‑WAVE Reference.
