cylinder_plot_unif

Synopsis

produce a set of cylindrical glyphs that allow you to visualize two dimensional table data

Input Port

in_field	Mesh_Unif+Dim2 + Node_Data
in_locations	Grid mesh used to position the cylinders
ui_parent	user interface parent object

Parameters

Data Component	UIradioBoxLabel	select data component to visualize
vertical segmentation	UItoggle	selects angular/vertical segmentation of the cylinders
scale height by total	UItoggle	scales height of the cylinders by column total
scale radius by total	UItoggle	scales radius of the cylinders by column total
color sides by total	UItoggle	colors the sides of the cylinders by column total
radius	UIfield	scale factor for cylinders radius
height scale	UIfield	scale factor for cylinders height
nsegments	UIslider	number of segment subdivisions for the cylinders
start angle	UIslider	beginning angle of first cylinder's segment
Normalize	UItoggle	normalizes glyph size
red	UIslider	default red value for cylinder sides
green	UIslider	default green value for cylinder sides
blue	UIslider	default blue value for cylinder sides

Output Port

out_fld	Mesh + Cell_Data
out_obj	output renderable object

Description

cylinder_plot_unif allows you to visualize two dimensional node data that can be thought of as a table having some number of columns and rows. Each column in the table is represented with a cylinder glyph. A cylinder is divided in either vertical or angular direction into a number of segments equal to the number of rows in the column. Each segment is scaled (in either vertical or angular direction) proportionally to the data value of the row. The height or radius of each cylinder can optionally be scaled by the total value of the column (sum of all rows). The sides of the cylinder can optionally be colored by the total column value.The resultant image looks like a 3D pie chart.

Input

in_field

The input must contain a 2-dimensional uniform mesh (Mesh_Unif+Dim2) plus Node_Data.

in_locations

This port is optional. It is a grid describing the location of the cylinders. If nothing is connected to this port, the module will use coordinates of in_field to position the cylinders. This port is useful, for example, to position a cylindrical glyph at certain locations on a map.

ui_parent

.

A port to connect to a user interface object that contains the macro's widgets. By default, it is connected to the default user interface object in the application in which the macro is instanced. This default connection is not drawn

Parameters

in_field

The input must contain a 2-dimensional uniform mesh (Mesh_Unif+Dim2) plus Node_Data.

ui_parent

A port to connect to a user interface object that contains the macro's widgets. By default, it is connected to the default user interface object in the application in which the macro is instanced. This default connection is not drawn.

Parameters

Data Component

UIradioBoxLabel. Radio buttons to pick which input Node_Data component to use to create cylinders. The default is the first (0th) component.

vertical segmentation

UItoggle. Indicates whether to use angular of vertical segmentation for each cylinder. The default is off (angular segmentation).

scale height by total

UItoggle. Indicates whether a height for each cylinder (representing a column of an input table data) is scaled by the total value of the column (sum of all rows).

in_locations

This port is optional. It is a grid describing the location of the cylinders. If nothing is connected to this port, the module will use coordinates of in_field to position the cylinders. This port is useful, for example, to position a cylindrical glyph at certain locations on a map.

scale radius by total

UItoggle. Indicates whether a radius for each cylinder (representing a column of an input table data) is scaled by the total value of the column (sum of all rows).

color sides by total

UItoggle. Indicates whether the sides of each cylinder (representing a column of an input table data) are colored by the total value of the column (sum of all rows).

radius

UIfield. Represents a default radius value for all cylinders. If "scale radius by total" is set to on, this value is used as the scale for radii of the cylinders.

height

UIfield. Represents a scale value for heights for the cylinders. If "scale height by total" is set to off, this value is used as the height for all the cylinders.

nsegments

UIslider. An integer value that represents the total number of sub-divisions for each cylinder. This number is used to control the graphical accuracy of the cylinders shape -- the higher the value, the more accurate the cylinder is drawn (with a corresponding increase in drawing time). If this value is set to 4 you will get rectangular (4-sided) blocks instead of a cylinder. The default is 36.

start angle

UIslider. Controls the start angle for the first segment in a case when vertical segmentation is off (angular segmentation is specified). Changing this angle is equivalent to rotating all cylinders around their vertical axis. The default is 0.

Default side color (red, green, blue)

UIsliders. Float sliders to adjust the color of the cylinder side. These colors are used only when "color sides by total" is off. The defaults are 1.0.

Output Port

out_fld

The output field contains cylindrical glyphs.

out_obj

This is a renderable version of the output field.

Example

Libraries.Examples.Visualization.Cylinder_Plot_Unif
v/dv_examp/cyl_plot_unif.v

File

v/modules.v

See also related modules

Bubbleviz

extrude_cells

shrink_cells