gnuplot_plot_imageT_gnuplot_plot_imageGnuplotPlotImageGnuplotPlotImagegnuplot_plot_image (Operator)
Name
gnuplot_plot_imageT_gnuplot_plot_imageGnuplotPlotImageGnuplotPlotImagegnuplot_plot_image — Visualize images using gnuplot.
Warning
gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImagegnuplot_plot_image is obsolete and is only provided for
reasons of backward compatibility.
Signature
void GnuplotPlotImage(const HObject& Image, const HTuple& GnuplotFileID, const HTuple& SamplesX, const HTuple& SamplesY, const HTuple& ViewRotX, const HTuple& ViewRotZ, const HTuple& Hidden3D)
void HGnuplot::GnuplotPlotImage(const HImage& Image, Hlong SamplesX, Hlong SamplesY, const HTuple& ViewRotX, const HTuple& ViewRotZ, const HString& Hidden3D) const
void HGnuplot::GnuplotPlotImage(const HImage& Image, Hlong SamplesX, Hlong SamplesY, double ViewRotX, double ViewRotZ, const HString& Hidden3D) const
void HGnuplot::GnuplotPlotImage(const HImage& Image, Hlong SamplesX, Hlong SamplesY, double ViewRotX, double ViewRotZ, const char* Hidden3D) const
void HGnuplot::GnuplotPlotImage(const HImage& Image, Hlong SamplesX, Hlong SamplesY, double ViewRotX, double ViewRotZ, const wchar_t* Hidden3D) const
(
Windows only)
void HImage::GnuplotPlotImage(const HGnuplot& GnuplotFileID, Hlong SamplesX, Hlong SamplesY, const HTuple& ViewRotX, const HTuple& ViewRotZ, const HString& Hidden3D) const
void HImage::GnuplotPlotImage(const HGnuplot& GnuplotFileID, Hlong SamplesX, Hlong SamplesY, double ViewRotX, double ViewRotZ, const HString& Hidden3D) const
void HImage::GnuplotPlotImage(const HGnuplot& GnuplotFileID, Hlong SamplesX, Hlong SamplesY, double ViewRotX, double ViewRotZ, const char* Hidden3D) const
void HImage::GnuplotPlotImage(const HGnuplot& GnuplotFileID, Hlong SamplesX, Hlong SamplesY, double ViewRotX, double ViewRotZ, const wchar_t* Hidden3D) const
(
Windows only)
static void HOperatorSet.GnuplotPlotImage(HObject image, HTuple gnuplotFileID, HTuple samplesX, HTuple samplesY, HTuple viewRotX, HTuple viewRotZ, HTuple hidden3D)
void HGnuplot.GnuplotPlotImage(HImage image, int samplesX, int samplesY, HTuple viewRotX, HTuple viewRotZ, string hidden3D)
void HGnuplot.GnuplotPlotImage(HImage image, int samplesX, int samplesY, double viewRotX, double viewRotZ, string hidden3D)
void HImage.GnuplotPlotImage(HGnuplot gnuplotFileID, int samplesX, int samplesY, HTuple viewRotX, HTuple viewRotZ, string hidden3D)
void HImage.GnuplotPlotImage(HGnuplot gnuplotFileID, int samplesX, int samplesY, double viewRotX, double viewRotZ, string hidden3D)
Description
gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImagegnuplot_plot_image displays an image as a 3D-plot using
gnuplot. If there is an active gnuplot sub-process (started with
gnuplot_open_pipegnuplot_open_pipeGnuplotOpenPipeGnuplotOpenPipeGnuplotOpenPipegnuplot_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 GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileIDgnuplot_file_id. The parameters
SamplesXSamplesXSamplesXSamplesXsamplesXsamples_x and SamplesYSamplesYSamplesYSamplesYsamplesYsamples_y 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
ViewRotXViewRotXViewRotXViewRotXviewRotXview_rot_x and ViewRotZViewRotZViewRotZViewRotZviewRotZview_rot_z determine the rotation
of the plot with respect to the viewer. ViewRotXViewRotXViewRotXViewRotXviewRotXview_rot_x is the
rotation of the coordinate system about the x-axis, while
ViewRotZViewRotZViewRotZViewRotZviewRotZview_rot_z 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
Hidden3DHidden3DHidden3DHidden3Dhidden3Dhidden_3d 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.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
ImageImageImageImageimageimage (input_object) singlechannelimage → objectHImageHObjectHImageHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / real)
Image to be plotted.
GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileIDgnuplot_file_id (input_control) gnuplot → HGnuplot, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Identifier for the gnuplot output stream.
SamplesXSamplesXSamplesXSamplesXsamplesXsamples_x (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of samples in the x-direction.
Default:
64
Value range:
1
≤
SamplesX
SamplesX
SamplesX
SamplesX
samplesX
samples_x
SamplesYSamplesYSamplesYSamplesYsamplesYsamples_y (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of samples in the y-direction.
Default:
64
Value range:
1
≤
SamplesY
SamplesY
SamplesY
SamplesY
samplesY
samples_y
ViewRotXViewRotXViewRotXViewRotXviewRotXview_rot_x (input_control) number → HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Rotation of the plot about the x-axis.
Default:
60
Value range:
0
≤
ViewRotX
ViewRotX
ViewRotX
ViewRotX
viewRotX
view_rot_x
≤
180
Minimum increment:
0.01
Recommended increment:
10
ViewRotZViewRotZViewRotZViewRotZviewRotZview_rot_z (input_control) number → HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Rotation of the plot about the z-axis.
Default:
30
Value range:
0
≤
ViewRotZ
ViewRotZ
ViewRotZ
ViewRotZ
viewRotZ
view_rot_z
≤
360
Minimum increment:
0.01
Recommended increment:
10
Hidden3DHidden3DHidden3DHidden3Dhidden3Dhidden_3d (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Plot the image with hidden surfaces removed.
Default:
'hidden3d'
"hidden3d"
"hidden3d"
"hidden3d"
"hidden3d"
"hidden3d"
List of values:
'hidden3d'"hidden3d""hidden3d""hidden3d""hidden3d""hidden3d", 'nohidden3d'"nohidden3d""nohidden3d""nohidden3d""nohidden3d""nohidden3d"
Result
gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImagegnuplot_plot_image returns the value if
GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileIDgnuplot_file_id is a valid gnuplot output stream, and if
the data file for the current plot could be opened. Otherwise, an
exception is raised.
Possible Predecessors
gnuplot_open_pipegnuplot_open_pipeGnuplotOpenPipeGnuplotOpenPipeGnuplotOpenPipegnuplot_open_pipe,
gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFilegnuplot_open_file
Possible Successors
gnuplot_closegnuplot_closeGnuplotCloseGnuplotCloseGnuplotClosegnuplot_close
See also
gnuplot_open_pipegnuplot_open_pipeGnuplotOpenPipeGnuplotOpenPipeGnuplotOpenPipegnuplot_open_pipe,
gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFilegnuplot_open_file,
gnuplot_closegnuplot_closeGnuplotCloseGnuplotCloseGnuplotClosegnuplot_close
Module
Foundation