ENVISION commands


PROGRAM NAME

putdata - General Non-Interactive Data Display Functions

DESCRIPTION

Putdata is a generic visualization program that can display data in a variety of ways. Data may be displayed as an image [-image], as a grid of numbers displaying the value data [-pixel], as a set of 3 grids displaying the map data [-mapval], as an icon [-imageicon], as an animated sequence [-animate], as a palette of colors defined by the colormap [-palette], as a zoom window [-zoom], as a 2D plot [-plot2d], or as a 3D plot [-plot3d].

IMPORTANT NOTE: when the [-plot2d] visualization type is used, set [-axis2d] to "true" (1) if you wish a 2D axis system to be displayed along with the 2D plot. Axes are not supported for 3D plots as of yet.

The method with which putdata displays the data is specified by the user; however, it is expected that the method chosen to display the data will be compatible with the contents of the data itself and the method used to create it. For example, signals do not work well displayed as images, and data displayed as an animated sequence should have multiple frames.

The input file containing the data being visualized is monitored by default; the file is checked every 2 seconds for change, and if it has been modified, the visualization display is updated accordingly. The interval at which the input file is checked for modification may be specified using the [-update] argument.

An alternate input color map may be used to change the current color map using the [-cmap] argument. Color maps do not make sense with visualization types of mapval, palette, pixel, plot2d, and plot3d.

A clip mask may be used to dictate the portion of the data that is displayed as an image, imageicon, animation, or zoom window. Clip masks do not make sense with visualization types of pixel, palette, plot2d, or plot3d.

By default, the visualization display will share its colormap will all other applications running at the same time; that is, it does not not use a private colormap, but rather makes use of the default colormap. It is possible to specify that the visualization display allocate its own private colormap or "grab" all available colors for its own use. This is done using the [-priv] argument. When [-priv] is specified, moving the mouse pointer into the display window will cause the display to have its private colormap installed; moving the pointer out of the display window will cause the private colormap to be de-installed. This results in the "technoflashing" phenomenon characteristic of private colormap installation.

Color allocation can also be controlled and set to either Read Only or Read Write using the [-alloc] argument. When set to read only, once a color cell has been allocated, it can have its color set only once; from then on, the color cell can be shared by multiple applications, but not changed. If the visualization display requires the color displayed to change, it must re-allocate the color cell, forcing a re-display of data. This can be an expensive procedure. In contrast, after a read/write color cell is allocated, it can have its color changed at any time without re-allocation; the data being displayed does not need to be redisplayed, and the color update process is much more efficient. However, the colors used in the visualization display cannot be shared by other applications.

On creation, the visual display window may be placed manually (the default method), or placed automatically. For automatic placement of the visual display window, specify the desired location in device (screen) coordinates, using the [-x] and [-y] arguments.

While the visual display window should be created with a default size that is appropriate to the type of visualization being used, a width and height for the visual display window can be specified explicitly using the [-width] and [-height] arguments. Alternatively, you may allow the visual display window to size itself initially, and then use the window manager to interactively modify its size as desired.

NOTE: Interactive resizing IS supported for visualization types of pixel, mapval, palette, plot2d, and plot3d. Interactive resizing is NOT supported YET for visualization types of image, imageicon, animate, or zoom.

REQUIRED ARGUMENTS

-i
type: infile
desc: File containing data

Mutually Exclusive Group; you must specify ONE of:

ALL OF the Mutually Inclusive Group:

-xoffset
type: integer
desc: Specifies the horizontal offset within the image display
default: 0
bounds: 0 < [-xoffset] < 10000
AND
-yoffset
type: integer
desc: Specifies the vertical offset within the image display
default: 0
bounds: 0 < [-yoffset] < 10000
AND
-image
type: flag
desc: Displays the image, given image data
AND
-complex
type: list
desc: Specifies the conversion type for complex data
default: 5 "Log Mangnitude + 1 "
AND
-normaltype
type: cycle
desc: Specifies how data is normalized for display
default: 1 "Global"
AND
-normalmethod
type: list
desc: Defines the algorithm used in data normalization
default: 1 "Range: Maximum"
AND
-redcol
type: list
desc: Specify which column in a map is to be displayed as red
default: 1 "Map Column 0"
AND
-greencol
type: list
desc: Specify which column in a map is to be displayed as green
default: 2 "Map Column 1"
AND
-bluecol
type: list
desc: Specify which column in a map is to be displayed as blue
default: 3 "Map Column 2"
AND
-redfn
type: string
desc: Provides an equation that specifies the red map column
default: M0
AND
-greenfn
type: string
desc: Provides an equation that specifies the green map column
default: M1
AND
-bluefn
type: string
desc: Provides an equation that specifies the blue map column
default: M2

ALL OF the Mutually Inclusive Group:

-imageicon
type: flag
desc: Displays an icon image, given image data
AND
-iconsize
type: integer
desc: Controls the size of the icon in pixels
default: 100
bounds: 0 < [-iconsize] < 512

ALL OF the Mutually Inclusive Group:

-zoom
type: flag
desc: Zooms in on image data
AND
-zoomx
type: integer
desc: Specifies the x position where the zoom window is focused
default: 0
bounds: value >= 0
AND
-zoomy
type: integer
desc: Specifies the y position in the which where the zoom window is focused
default: 0
bounds: value >= 0
AND
-zoomfactor
type: double
desc: Specifies the zoom factor
default: 8
bounds: 0.001 < [-zoomfactor] < 100

ALL OF the Mutually Inclusive Group:

-animate
type: flag
desc: Animates an image, given sequenced image data
AND
-dir
type: list
desc: Controls the direction in which images are sequenced
default: 5 ">> (Sequence Forward) "
AND
-control
type: list
desc: Controls how animation sequencing is performed
default: 1 "Loop"
AND
-speed
type: double
desc: Controls the frame speed
default: 1
bounds: 0 < [-speed] < 5

ALL OF the Mutually Inclusive Group:

-pixel
type: flag
desc: Displays the value data of the object
AND
-valuewidth
type: integer
desc: Specifies the number of pixel values along width
default: 7
bounds: value >= 0
AND
-valueheight
type: integer
desc: Specifies the number of pixel values along height
default: 9
bounds: value >= 0
AND
-showcolorvalue
type: boolean
desc: Specifies the background color of the pixel
default: true

ALL OF the Mutually Inclusive Group:

-mapval
type: flag
desc: Displays the map value data of the object
AND
-mapwidth
type: integer
desc: Specifies the number of map values along width
default: 7
bounds: value >= 0
AND
-mapheight
type: integer
desc: Specifies the number of map values along height
default: 9
bounds: value >= 0
AND
-showcolormap
type: boolean
desc: Specifies the background color of the pixel
default: true
AND
-displaypolicy
type: cycle
desc: Specifies whether to display normalized or un-normalized map values
default: 1 "Display Normalized Values"

ALL OF the Mutually Inclusive Group:

-palette
type: flag
desc: Displays the colormap of the object
AND
-palettetype
type: list
desc: Specifies how the color palette is presented
default: 1 "Color Bar"

ALL OF the Mutually Inclusive Group:

-plot2d
type: flag
desc: Creates a 2D plot of the data
AND
-axis2d
type: boolean
desc: Display 2D axes with 2D plot
default: true
AND
-ptype2d
type: list
desc: Specifies the plot type for 2D plots
default: 1 "Line"
AND
-ltype2d
type: list
desc: Specifies the line type for 2D plots
default: 7 "Grid Dotted "
AND
-mtype2d
type: list
desc: Specifies the marker type for 2D plots
default: 12 "Square "
AND
-pcolor2d
type: string
desc: Specifies the plot color for 2D plots
default: Red

ALL OF the Mutually Inclusive Group:

-plot3d
type: flag
desc: Creates a 3D plot of the data
AND
-ptype3d
type: list
desc: Specifies the plot type for 3D plots
default: 20 "Line"
AND
-ltype3d
type: list
desc: Specifies the line type for 3D plots
default: 1 "Solid"
AND
-mtype3d
type: list
desc: Specifies the marker type for 3D plots
default: 12 "Square"
AND
-stype3d
type: list
desc: Specifies the surface shade type for 3D plots
default: 1 "Imagery"
AND
-pcolor3d
type: string
desc: Specifies the plot color for 3D plots
default: Red
AND
-fcolor3d
type: string
desc: Specifies the fill color for 3D plots
default: White
AND
-xrot3d
type: float
desc: Specifies the rotation angle about the X axis
default: 100
bounds: 0 < [-xrot3d] < 360
AND
-zrot3d
type: float
desc: Specifies the rotation angle about the Z axis
default: 100
bounds: 0 < [-zrot3d] < 360
AND
-edist3d
type: float
desc: Specifies the eye distance
default: 0
bounds: -50 < [-edist3d] < 50

OPTIONAL ARGUMENTS

-priv
type: boolean
desc: Use private colormap?
default: false
-alloc
type: cycle
desc: Color allocation policy
default: 1 "Read Only"
-cmap
type: infile
desc: File containing alternate colormap
default: {none}
-x
type: integer
desc: X location for GUI autoplacement
default: -1
bounds: -1 < [-x] < 1000
-width
type: integer
desc: Window width
default: 512
bounds: -1 < [-width] < 1000
-clip
type: infile
desc: File containing clip mask
default: {none}
-y
type: integer
desc: Y location for GUI autoplacement
default: -1
bounds: -1 < [-y] < 1000
-height
type: integer
desc: Window height
default: 512
bounds: -1 < [-height] < 1000
-update
type: float
desc: How often to check input file for modification
default: 2
bounds: value >= 0.0

EXAMPLES

% putdata -i image:ball -image -xoffset 0 -yoffset 0 

-complex 5 -normaltype 1 -normalmethod 1 -redcol 2
-greencol 2 -bluecol 3 -redfn M0 -greenfn M1 -bluefn M2

% putdata -i image:lizard -imageicon -iconsize 75

% putdata -i image:mandril -pixel -valuewidth 7
-valueheight 9 -showcolorvalue y

% putdata -i sequence:bushes -animate -dir 5
-control 1 -speed 0.5

% putdata -i clust:albq1 -mapval -mapwidth 7 -mapheight 9
-showcolormap y -displaypolicy 1

% putdata -i image:moon -palette -palettetype 1

% putdata -i plot2d:brain -plot2d -axis2d y -ptype2d 5
-ltype2d 1 -mtype2d 2 -pcolor2d green

% putdata -i plot3d:flow -plot3d -ptype3d 22 -ltype3d 1
-mtype3d 3 -stype3d 1 -pcolor3d green -fcolor3d white
-xrot3d 100 -zrot3d 100 -edist3d 0

SEE ALSO

putimage(1), puticon(1), putpixel(1), putanimate(1), putmapval(1), putpalette(1), putplot2(1), putplot3(1), putzoom(1), animate(1), editimage(1), xprism(1)

RESTRICTIONS

REFERENCES

Putdata is covered in Chapter 6 of the Envision manual.

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.