This JWAVE wrapper function provides a convenient interface to the PV‑WAVE HISTOGRAM procedure. This function always returns a Viewable object (a histogram plot) to the JWAVE Java client.

This section lists the parameters that the JWAVE_HISTOGRAM wrapper can retrieve, unpack, and use to produce a histogram plot. These parameters correspond to the parameters and keywords of the PV‑WAVE HISTOGRAM procedure. You must set these parameters in the client application with the JWaveView.setParam method.

Y—(required) The array for which the density function will be computed. The size of each dimension of Y may be any integer value.

This section lists the keyword parameters that can be retrieved and unpacked in this wrapper function.

Axiscolor—(integer) Specifies the index of the axis color.

Binsize—Specifies the width of the bins displayed in the histogram. (Default: 1)

Fillcolor—(integer) Specifies the index of the color used to fill the histogram. (Default: Color)

Filled—If present and nonzero, the histogram is filled with color. (Default: 0)

Stepped—If present and nonzero, the histogram is plotted as “steps” rather than as “bars”. (Default: 0)

Xmax—The maximum value for which histogram data is plotted. Any data that falls above this value will be clipped.

Xmin—The minimum value for which histogram data is plotted. This corresponds to the leftmost point on the x-axis where the plot begins. By default, this minimum is set to zero. If there are negative values in your histogram data, you may need to adjust this value to shift the data to the left. Otherwise, the plot starts at the origin.

For detailed information on the keywords listed in the following table, refer to Appendix C: Keyword and Named Color Parameters.

These parameters must be set by the JWAVE client Java application with the JWaveView.setNamedColor method.

This wrapper returns a Viewable object (of a histogram plot) to the JWAVE Java client application.

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_HISTOGRAM unpacks the parameters and builds a PV‑WAVE HISTOGRAM command to produce a histogram plot.

These lines of Java code set 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_HISTOGRAM”) 

myJWaveView.JWaveView.setParam(”X”, histdata); 

myJWaveView.JWaveView.setParam(”CHARSIZE”, 2);

myJWaveView.JWaveView.setParam(”TITLE”, ”CO2 Content”);

myJWaveView.setNamedColor(”BACKGROUND”, java.awt.Color.blue); 

For more information on using JWAVE wrapper functions, see Chapter 5: JWAVE Server Development.

For more information on the PV‑WAVE HISTOGRAM procedure, see the PV‑WAVE Reference.