JWAVE Bean Tools Reference

This appendix describes a set of JWAVE Beans that are provided by Visual Numerics. The data input and customizable parameters for each tool are described.

See Using JWAVE Beans with the BeanBox for more information on using these Bean Tools.

• JWAVE Bar3d Tool on page E-2

• JWAVE Contour Tool on page E-3

• JWAVE Generic Tool on page E-6

• JWAVE Histogram Tool on page E-7

• JWAVE Pie Tool on page E-8

• JWAVE Plot Tool on page E-10

• JWAVE Surface Tool on page E-13

JWAVE Bar3d Tool

The JWAVE Bar3D Tool is a Bean that displays a 3D bar plot.

See Chapter 7, Using JWAVE Beans for information on using this Bean in the BeanBox.

The JWAVE Bar3d Tool uses a DoubleTable object as data input to the PV-WAVE BAR3D procedure. (Default: 30 columns of data)

The JWAVE Bean Tools provided by Visual Numerics each have a Customizer for modifying the appearance of the plot produced by the Bean. This section describes the features of the Bar3D Tool Customizer.

Title Defines the text for the main title that appears centered above the plot. The text size of this main title is larger than the other text by a factor of 1.25.

Sub Title Defines the text for the subtitle that appears underneath the x-axis.

X Axis Title Defines the text for the title that appears below the x-axis.

Y Axis Title Defines the text for the title that appears below the y-axis.

Z Axis Title Defines the text for the title that appears below the z-axis.

Character Size Sets the overall character size for the annotation. A value of 1.0 is normal. The main title is written with a character size of 1.25 times this parameter.

X Rotation Specifies the clockwise rotation about the x-axis. (Default: 30°)

Z Rotation Specifies the clockwise rotation about the z-axis. (Default: 30°)

Background Color Brings up a color tool for selecting the background color of the plot.

Foreground Color Brings up a color tool for selecting the foreground color of the plot.

Column Names Sets the column you want to work with while selecting the Column Color parameter.

Column Color Brings up a color tool for selecting the color of the selected column.

JWAVE Contour Tool

The JWAVE Contour Tool is a Bean that displays a contour plot.

See Chapter 7, Using JWAVE Beans for information on using this Bean in the BeanBox.

This Tool uses up to three data arrays (z, x, and y) as input to the PV-WAVE CONTOUR procedure.

z A 2D array containing the values that make up the contour surface.

x (optional) A 1D or 2D array specifying the x-coordinates for the contour surface.

y (optional) A 1D or 2D array specifying the y-coordinates for the contour surface.

The JWAVE Beans provided by Visual Numerics each have a Customizer for modifying the appearance of the plot produced by the Bean. This section describes the features of the Contour Tool Customizer.

Grid On When selected, a grid is displayed behind the contour.

Fill Contours When selected, a color other than the background color is used to fill the areas between contour lines. When Fill Contours is selected, the intervals between the contour lines are filled with the contour line colors.

Number of Levels Sets the number of equally-spaced contour levels that are produced. The maximum is 150. (Default: 6)

X Range Sets the data range of the x-axis, a two-element vector. The first element is the axis minimum and the second is the maximum.

Y Range Sets the data range of the y-axis, a two-element vector. The first element is the axis minimum and the second is the maximum.

Cell The cell-drawing method, the default, examines each array cell and draws all contours emanating from that cell before proceeding to the next cell. This method is efficient in terms of computer resources but does not allow contour labeling.

Follow Method The line-following method searches for each contour line and then follows the line until it reaches a boundary or closes. This method gives better looking results with dashed line styles and allows contour labeling, but requires more computer time.

Spline Allows you to spline the contour lines. This function can be used when either the Follow method of contour drawing or Fill Contours is selected.

Splines are especially useful with small data sets (less than 15 array dimensions). With larger data sets the smoothing is not as noticeable and the expense of splines increases rapidly with the number of data points.

Spline Size Specifies the length of each interpolated line segment in normalized coordinates. Smaller values for this parameter yield smoother lines, up to the resolution of the output device, at the expense of more computations. (Default: 0.005)

Interpolation (CONGRID) When selected, applies interpolation, which shrinks or expands the number of elements in the contour by interpolating values at intervals where there might not have been values before.

Number of X Points Sets the number of columns desired in the output image.

Number of Y Points Sets the number of rows desired in the output image.

Title Defines the text for the main title that appears centered above the plot. The text size of this main title is larger than the other text by a factor of 1.25.

Sub Title Defines the text for the subtitle that appears underneath the x-axis.

X Axis Title Defines the text for the title that appears below the x-axis.

Y Axis Title Defines the text for the title that appears below the y-axis.

Character Size Sets the overall character size for the annotation. A value of 1.0 is normal. The main title is written with a character size of 1.25 times this parameter.

Background Color Brings up a color tool for selecting the background color of the plot.

Foreground Color Brings up a color tool for selecting the foreground color of the plot.

Default Annotation Labels the selected contour level with its elevation.

No Annotation Turns off annotation of the selected contour level.

Special Annotation Applies the specified annotation for the selected contour level. When the Special Annotation button is selected, you can enter annotation text in the text field located below the button.

Line Color Brings up a color tool for selecting the line color for the selected level.

Fill Color Brings up a color tool for selecting the fill color for the selected level.

Line Thickness Sets the value for the thickness of the lines in the selected level. A value of 1.0 is normal thickness, 2.0 is double-wide, and so on.

Line Style Sets the line style of the lines in the selected level. Choices are: Solid, Dotted, Dashed, Dash dot, Dash-dot-dot-dot, and Long dashes.

JWAVE Generic Tool

The JWAVE Generic Tool is a Bean that contains a property that determines which PV-WAVE procedure to invoke to generate and display a plot. This Bean can take up to ten data Proxy's (all 2D arrays) as input to the PV-WAVE procedure.

See Chapter 7, Using JWAVE Beans for information on using this Bean in the BeanBox.

The JWAVE Beans provided by Visual Numerics each have a Customizer for modifying the appearance of the plot produced by the Bean. This section describes the features of the Generic Tool Customizer.

Plot Type Specifies the name of a JWAVE procedure file stored in:

(UNIX)VNI_DIR/jwave-3_0/lib

(Windows)VNI_DIR\jwave-3_0\lib

where VNI_DIR is the main Visual Numerics installation directory.

Title Defines the text for the main title that appears centered above the plot.

Background Color Brings up a color tool for selecting the background color of the plot.

Foreground Color Brings up a color tool for selecting the foreground color of the plot.

JWAVE Histogram Tool

The JWAVE Histogram Tool is a Bean that displays a histogram plot.

This Tool uses a 1D array containing histogram data as input to the PV-WAVE HISTOGRAM procedure.

See Chapter 7, Using JWAVE Beans for information on using this Bean in the BeanBox.

The JWAVE Beans provided by Visual Numerics each have a Customizer for modifying the appearance of the plot produced by the Bean. This section describes the features of the Histogram Tool Customizer.

Title Defines the text for the main title that appears centered above the plot.

X Axis Title Defines the text for the title that appears below the x-axis.

Y Axis Title Defines the text for the title that appears below the y-axis.

Bin Size The range of values to consider as having a single value. If no value is specified, the Bin Size range defaults to a value of 1.

Stepped When selected, the histogram is displayed without the vertical lines between the bars, which produces a histogram plot that resembles ascending and descending stair steps.

Background Color Brings up a color tool for selecting the background color of the histogram plot.

Foreground Color Brings up a color tool for selecting the foreground color of the histogram plot.

Fill Histogram When selected, the color set with the Fill Color parameter is used to fill the bins of the histogram.

Fill Color Brings up a color tool used to select a color for filling the bins in the histogram.

Axis Color Brings up a color tool for selecting a color for the axes.

X Max Defines the maximum for the data range of the x-axis.

X Min Defines the minimum for the data range of the x-axis

JWAVE Pie Tool

The JWAVE Pie Tool is a Bean that displays a pie chart.

This Tool uses a DoubleTable object as input to the PV-WAVE PIE_CHART procedure.

See Chapter 7, Using JWAVE Beans for information on using this Bean in the BeanBox.

The JWAVE Beans provided by Visual Numerics each have a Customizer for modifying the appearance of the plot produced by the Bean. This section describes the features of the Pie Tool Customizer.

Title Defines the text for the main title that appears centered above the pie chart.

Show Slice Percentages When selected, each slice is labeled with the percentage it represents out of the total pie.

Show Slice Values When selected, each slice is labeled with the value it represents.

Show Label Border When selected, a filled rectangle displays behind each label.

Slice Label Position Defines the position of slice labels.

Internal Places the label in the slice.

External Places the label outside the slice.

External Aligned Places the label outside the slice and lined-up on each side of the pie.

X Center The x-axis coordinate for the center of the pie.

Y Center The y-axis coordinate for the center of the pie.

Shade Displacement Specifies the percentage of displacement for the center of the drop shadow displayed behind the pie chart. The direction of the displacement is 315°.

Background Color Brings up a color tool for selecting the background color of the pie chart.

Foreground Color Brings up a color tool for selecting the foreground color of the pie chart.

Label Border Color If Show Label Border (in the Labels tab) is selected, brings up a color tool for selecting the color of the filled rectangle that displays behind each label.

Slices Sets the slice you want to work with while using the parameters in the Slices tab.

Slice Color Brings up a color tool for selecting the color for the selected slice.

Slice Label Color Brings up a color tool for selecting the color of the text in the label for the selected slice.

Percent Explode for Slice Defines the percentage to explode the selected slice from the center of the pie.

JWAVE Plot Tool

The JWAVE Plot Tool is a Bean that displays an XY (2D) graph.

See Chapter 7, Using JWAVE Beans for information on using this Bean in the BeanBox.

This Tool uses one or two data arrays (X and Y) as input to the PV-WAVE PLOT procedure.

The JWAVE Beans provided by Visual Numerics each have a Customizer for modifying the appearance of the plot produced by the Bean. This section describes the features of the Plot Tool Customizer.

Title Defines the text for the main title that appears centered above the plot. The text size of this main title is larger than the other text by a factor of 1.25.

Sub Title Defines the text for the subtitle that appears underneath the x-axis.

X Axis Title Defines the text for the title that appears below the x-axis.

Y Axis Title Defines the text for the title that appears below the y-axis.

Character Size Sets the overall character size for the annotation. A value of 1.0 is normal. The main title is written with a character size of 1.25 times this parameter.

Background Color Brings up a color tool for selecting the background color of the plot.

Axis Color Brings up a color tool for selecting the axis color of the plot.

Y Data Color Brings up a color tool for selecting the color of the y data.

X Data Color Brings up a color tool for selecting the color of the x data.

Grid On When selected, a grid is displayed behind the plot.

Polar Plot When selected, a polar plot is produced.

Axis Scaling Sets the type of scaling to be used for the X and Y axes.

Linear - Linear Produces a plot with linear scaling on both axes.

Log - Linear Produces a plot with logarithmic scaling on the x-axis and linear scaling on the y-axis.

Linear - Log Produces a plot with linear scaling on the x-axis and logarithmic scaling on the y-axis.

Log - Log Produces a plot with logarithmic scaling on both axes.

X Range Defines the data range of the x-axis, a two-element vector. The first element is the axis minimum and the second is the maximum.

Y Range Defines the data range of the y-axis, a 2-element vector. The first element is the axis minimum and the second is the maximum.

Plot X vs. Y If one data array is present, graphs the array vs. the index. If two data arrays are present, graphs one array vs. the other.

Plot X and Y data arrays Only available if two data arrays are present. Graphs both arrays vs. the index.

Line Style Sets the line style of the y data line. Choices are: Solid, Dotted, Dashed, Dash dot, Dash-dot-dot-dot, and Long dashes.

Line Thickness Sets the value for the thickness of the y data line. A value of 1.0 is normal thickness, 2.0 is double-wide, and so on.

Symbol Sets the type of symbol to used to plot each y data point.

None Specifies that no symbols display at each y data point. The None setting results in a line drawn between data points.

Plus Sign Specifies a + at each y data point.

Asterisk Specifies an * at each y data point.

Period Specifies a . at each y data point.

Diamond Specifies a diamond shape at each y data point.

Triangle Specifies a triangle shape at each y data point.

Square Specifies a square shape at each y data point.

X Specifies an X at each y data point.

Symbol Size Sets the value for the size of y data plot symbols. A value of 1.0 is normal size, 2.0 is double-size, and so on.

Connect Symbols with Lines When selected, symbols are connected with lines. This parameter can be used when the value of Symbol is other than None.

Line Style Sets the line style of the x data line. Choices are: Solid, Dotted, Dashed, Dash dot, Dash-dot-dot-dot, and Long dashes.

Line Thickness Sets the value for the thickness of the x data line. A value of 1.0 is normal thickness, 2.0 is double-wide, and so on.

Symbol Sets the type of symbol to used to plot each x data point.

None Specifies that no symbols display at each x data point. The None setting results in a line drawn between data points.

Plus Sign Specifies a + at each x data point.

Asterisk Specifies an * at each x data point.

Period Specifies a . at each x data point.

Diamond Specifies a diamond shape at each x data point.

Triangle Specifies a triangle shape at each x data point.

Square Specifies a square shape at each x data point.

X Specifies an X at each x data point.

Symbol Size Sets the value for the size of x data plot symbols. A value of 1.0 is normal size, 2.0 is double-size, and so on.

Connect Symbols with Lines When selected, symbols are connected with lines. This parameter can be used when the value of Symbol is other than None.

JWAVE Surface Tool

The JWAVE Surface Tool is a Bean that displays the surface of a 2D array. The surface can be displayed with hidden lines removed or shaded. This Tool uses the PV-WAVE SURFACE procedure to render the plot.

See Chapter 7, Using JWAVE Beans for information on using this Bean in the BeanBox.

This Tool takes up to four data arrays (z, x, y, and shade values).

z A 2D array containing the values that make up the surface. If x and y are supplied, the surface is plotted as a function of the X,Y locations specified by their contents. Otherwise, the surface is generated as a function of the array index of each element of z.

x (optional) A 1D or 2D array specifying the x-coordinates for the surface.

• If x is a 1D array, each element of x specifies the x-coordinate for a column of z. For example, x(0) specifies the x-coordinate for z(0, *).

• If x is a 2D array, each element of x specifies the x-coordinate of the corresponding point in z.

y (optional) A 1D or 2D array specifying the y-coordinates for the surface.

• If y is a 1D array, each element of y specifies the y-coordinate for a row of z. For example, y(0) specifies the y-coordinate for z(*, 0).

• If y is a 2D array, each element of y specifies the y-coordinate of the corresponding point in z.

The JWAVE Beans provided by Visual Numerics each have a Customizer for modifying the appearance of the plot produced by the Bean. This section describes the features of the Surface Tool Customizer.

Title Defines the text for the main title that appears centered above the plot. The text size of this main title is larger than the other text by a factor of 1.25.

Sub Title Defines the text for the subtitle that appears underneath the x-axis.

X Title Defines the text for the title that appears below the x-axis.

Y Title Defines the text for the title that appears below the y-axis.

Z Title Defines the text for the title that appears below the z-axis.

Character Size Sets the overall character size for the annotation. A value of 1.0 is normal. The main title is written with a character size of 1.25 times this parameter.

Background Color Brings up a color tool for selecting the background color of the plot.

Foreground Color Brings up a color tool for selecting the foreground color of the plot.

Bottom Color Brings up a color tool for selecting the color of the bottom of the plot.

Color Table Sets the color table used for the plot.

Grid When selected, a grid is displayed behind the plot.

Shade When selected, the plot will be shaded.

Overplot with Surface When selected, plot lines appear on top of the surface if Shade is also selected.

Z Axis Location Sets the position of the z-axis origin to lower-right, lower-left, upper-right, or upper-left.

Z Rotation Specifies the rotation about the z-axis. (Default: 30°)

X Rotation Specifies the rotation about the x-axis. (Default: 30°)

Skirt When selected, a skirt is added to the surface. A skirt helps establish a frame of reference between the surface and the x-, y-, and z-axes. Skirt can be used when Shade is not set.

Skirt Value Defines the value along the z-axis at which the bottom of the skirt begins. (Default = minimum z value for the variable)

X Range Sets the data range of the x-axis, a two-element vector. The first element is the axis minimum and the second is the maximum.

Y Range Sets the data range of the y-axis, a two-element vector. The first element is the axis minimum and the second is the maximum.

Z Range Sets the data range of the z-axis, a two-element vector. The first element is the axis minimum and the second is the maximum.

Interpolation When selected, applies interpolation, which shrinks or expands the number of elements in the surface plot by interpolating values at intervals where there might not have been values before.

Number of X Points Sets the number of columns desired in the output image.

Number of Y Points Sets the number of rows desired in the output image.