MShareGraph3D

DESCRIPTION

MShareGraph3D generates a 3D histogram of blocks, cylinders, or cones, from the data lattice on its input port. The height of the display may be scaled by a height factor; the ground area of the histogram components may be scaled by a surface scale factor. The maximum size of the ground area is such that components touch. Components are centred on the coordinates of the input lattice.

Optionally, the components are colored according to row, column, or height of the data values using the attached color map to set the color coding.

Additionally, this module has been extended to be collaboratively aware using the COVISA collaborative toolkit (version 2.0). This allows it to be used in single-user mode, or (if connected to a collaborative session using the MServer module) as a collaborative module. In collaborative mode it shares the control panel widgets with its companion modules in the Map Editors of the collaborators.

A full description of the COVISA module suite and API is given in the IRIS Explorer Collaborative User Guide. You are strongly advised to read this guide before using MShareGraph3D as a collaborative module.

INPUTS

Port: Data In
Type: Lattice
Optional: This port is optional.
Constraints: 2-D
Constraints: 1-vector
Constraints: uniform

Input data from which the 3D histogram is to be constructed.

Port: ColorMap
Type: Lattice
Optional: This port is optional.
Constraints: 1-D
Constraints: 4-vector
Constraints: float

Color map which may be used for the color coding. For maximum effect the range of the color map should be equal to the range of values in the input data lattice when the histogram is colored according to magnitude, and 0.0 to 1.0 otherwise.

WIDGETS

Port: Graph Type
Type: Option Menu
Menu Item: Blocks
Menu Item: Cylinders
Menu Item: Cones

The shape of the histogram components may be specified as blocks, cylinders, or cones.

Port: Color By What
Type: Option Menu
Menu Item: 1st Direction
Menu Item: 2nd Direction
Menu Item: Magnitude

If a color map is attached, color coding may be according to the position of the components (row, or column),or according to their data value.

Port: Height Scale
Type: Dial

The height of the histogram may be scaled using the height scale factor. The default height scale factor is 1.0.

Port: Surface Scale
Type: Dial

The ground area of the histogram components may be specified using the surface scale factor. By default the size is 80 percent of the smallest distance between nodes (scale factor = 0.8).

If an attempt is made to increase the size to more than the smallest distance between nodes (scale factor > 1.0), then the scale factor is clamped to 1.0, and the widget setting is changed accordingly.

Likewise, the size factor may not be reduced below the value of 0.01.

Port: Treat Negatives As ?
Type: Option Menu
Menu Item: Normal
Menu Item: Absolute
Menu Item: Ignore

Negative values in the data may be plotted in 3 different ways:- Normal places them below the X-Axis; Absolute plots the absolute value; or Ignore where no geometric representation is used.

Port: Initiate
Type: Button

Makes the module connect to the COVISA Server to be used in collaborative mode. This should only be used once an MServer module has been started and connected to a COVISA Server.

Port: Connection_State
Type: Option Menu
Menu Item: Reconnect
Menu Item: Disconnect

This menu box allows the module to be disconnected and reconnected from/to the COVISA Server once the initial connection has been made.

Port: Sync Values
Type: Button

Pressing this button passes the values of all of the widgets on the control panel to all of the other collaborators. It is only available once the module has joined a collaborative session.

Port: Join
Type: Button

DO NOT USE THIS PORT. It is reserved for communication by underlying Skm commands.

Port: ID
Type: Slider

DO NOT USE THIS PORT. It is reserved for communication by underlying Skm commands.

Port: Name
Type: Text

DO NOT USE THIS PORT. It is reserved for communication by underlying Skm commands.

Port: Application
Type: Text

DO NOT USE THIS PORT. It is reserved for communication by underlying Skm commands.

OUTPUTS

Port: Graph
Type: Geometry

Geometry containing the histogram.

Port: Scale
Type: Parameter

The actual height scale value used to create the geometry. This is useful for scaling axis objects.

KNOWN PROBLEMS

Wiring parameters into Join, ID, Name, and Application may interfere with the data communication between COVISA modules and this may lead to unexpected results.

SEE ALSO

Other COVISA toolkit modules:

MAdvisor, MServer, MShareGeom, MShareLat, MShareLatToGeom, MShareParam, MSharePointer, MSharePyr.

The IRIS Explorer COVISA collaborative module suite and API was developed at the University of Leeds.

You are referred to the IRIS Explorer Collaborative User Guide for more information.


[Documentation Home]