gnuplot_plot_image ( Image : : GnuplotFileID, SamplesX, SamplesY, ViewRotX, ViewRotZ, Hidden3D : )

Visualize images using gnuplot.

gnuplot_plot_image displays an image as a 3D-plot using gnuplot. If there is an active gnuplot sub-process (started with gnuplot_open_pipe), the image is displayed in a gnuplot window. Otherwise, the image is output to a file, which can be later read by gnuplot. In both cases the gnuplot output stream is identified by GnuplotFileID. The parameters SamplesX and SamplesY determine the number of data points in the x- and y-direction, respectively, which gnuplot should use to display the image. They are the equivalent of the gnuplot variables samples and isosamples. The parameters ViewRotX und ViewRotZ determine the rotation of the plot with respect to the viewer. ViewRotX is the rotation of the coordinate system about the x-axis, while ViewRotZ is the rotation of the plot about the z-axis. These two parameters correspond directly to the first two parameters of the 'set view' command in gnuplot. The parameter Hidden3D determines whether hidden surfaces should be removed. This is equivalent to the 'set hidden3d' command in gnuplot. If a single image is passed to the operator, it is displayed in a separate plot. If multiple images are passed, they are displayed in the same plot.


Parameters

Image (input_object)
image -> object : byte / direction / cyclic / int1 / int2 / uint2 / int4 / real
Image to be plotted.

GnuplotFileID (input_control)
gnuplot_id -> integer
Identifier for the gnuplot output stream.

SamplesX (input_control)
integer -> integer
Number of samples in the x-direction.
Default value: 64
Typical range of values: 2 <= SamplesX <= 10000
Restriction: SamplesX >= 2

SamplesY (input_control)
integer -> integer
Number of samples in the y-direction.
Default value: 64
Typical range of values: 2 <= SamplesY <= 10000
Restriction: SamplesY >= 2

ViewRotX (input_control)
number -> real / integer
Rotation of the plot about the x-axis.
Default value: 60
Typical range of values: 0 <= ViewRotX <= 180
Minimum increment: 0.01
Recommended increment: 10
Restriction: (0 <= ViewRotX) && (ViewRotX <= 180)

ViewRotZ (input_control)
number -> real / integer
Rotation of the plot about the z-axis.
Default value: 30
Typical range of values: 0 <= ViewRotZ <= 360
Minimum increment: 0.01
Recommended increment: 10
Restriction: (0 <= ViewRotZ) && (ViewRotZ <= 360)

Hidden3D (input_control)
string -> string
Plot the image with hidden surfaces removed.
Default value: 'hidden3d'
List of values: 'hidden3d', 'nohidden3d'


Result

gnuplot_plot_image returns the value if GnuplotFileID is a valid gnuplot output stream, and if the data file for the current plot could be opened. Otherwise, an exception handling is raised.


Parallelization Information

gnuplot_plot_image is processed completely exclusively without parallelization.


Possible Predecessors

gnuplot_open_pipe, gnuplot_open_file


Possible Successors

gnuplot_close


See also

gnuplot_open_pipe, gnuplot_open_file, gnuplot_close


Module

System



Copyright © 1996-2005 MVTec Software GmbH