ClassesClasses | | Operators

gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImage (Operator)

Name

gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImage — Visualize images using gnuplot.

Warning

gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImage is obsolete and is only provided for reasons of backward compatibility.

Signature

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

Herror gnuplot_plot_image(const Hobject Image, const Hlong GnuplotFileID, const Hlong SamplesX, const Hlong SamplesY, double ViewRotX, double ViewRotZ, const char* Hidden3D)

Herror T_gnuplot_plot_image(const Hobject Image, const Htuple GnuplotFileID, const Htuple SamplesX, const Htuple SamplesY, const Htuple ViewRotX, const Htuple ViewRotZ, const Htuple Hidden3D)

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 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

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_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImage displays an image as a 3D-plot using gnuplot. If there is an active gnuplot sub-process (started with gnuplot_open_pipegnuplot_open_pipeGnuplotOpenPipeGnuplotOpenPipeGnuplotOpenPipe), 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 GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileID. The parameters SamplesXSamplesXSamplesXSamplesXsamplesX and SamplesYSamplesYSamplesYSamplesYsamplesY 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 ViewRotXViewRotXViewRotXViewRotXviewRotX and ViewRotZViewRotZViewRotZViewRotZviewRotZ determine the rotation of the plot with respect to the viewer. ViewRotXViewRotXViewRotXViewRotXviewRotX is the rotation of the coordinate system about the x-axis, while ViewRotZViewRotZViewRotZViewRotZviewRotZ 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 Hidden3DHidden3DHidden3DHidden3Dhidden3D 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

Parameters

ImageImageImageImageimage (input_object)  singlechannelimage objectHImageHImageHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / real)

Image to be plotted.

GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileID (input_control)  gnuplot_id HGnuplot, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Identifier for the gnuplot output stream.

SamplesXSamplesXSamplesXSamplesXsamplesX (input_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of samples in the x-direction.

Default value: 64

Typical range of values: 2 ≤ SamplesX SamplesX SamplesX SamplesX samplesX ≤ 10000

Restriction: SamplesX >= 2

SamplesYSamplesYSamplesYSamplesYsamplesY (input_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of samples in the y-direction.

Default value: 64

Typical range of values: 2 ≤ SamplesY SamplesY SamplesY SamplesY samplesY ≤ 10000

Restriction: SamplesY >= 2

ViewRotXViewRotXViewRotXViewRotXviewRotX (input_control)  number HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Rotation of the plot about the x-axis.

Default value: 60

Typical range of values: 0 ≤ ViewRotX ViewRotX ViewRotX ViewRotX viewRotX ≤ 180

Minimum increment: 0.01

Recommended increment: 10

Restriction: 0 <= ViewRotX && ViewRotX <= 180

ViewRotZViewRotZViewRotZViewRotZviewRotZ (input_control)  number HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Rotation of the plot about the z-axis.

Default value: 30

Typical range of values: 0 ≤ ViewRotZ ViewRotZ ViewRotZ ViewRotZ viewRotZ ≤ 360

Minimum increment: 0.01

Recommended increment: 10

Restriction: 0 <= ViewRotZ && ViewRotZ <= 360

Hidden3DHidden3DHidden3DHidden3Dhidden3D (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Plot the image with hidden surfaces removed.

Default value: 'hidden3d' "hidden3d" "hidden3d" "hidden3d" "hidden3d"

List of values: 'hidden3d'"hidden3d""hidden3d""hidden3d""hidden3d", 'nohidden3d'"nohidden3d""nohidden3d""nohidden3d""nohidden3d"

Result

gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImage returns the value if GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileID 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_pipeGnuplotOpenPipeGnuplotOpenPipeGnuplotOpenPipe, gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFile

Possible Successors

gnuplot_closegnuplot_closeGnuplotCloseGnuplotCloseGnuplotClose

See also

gnuplot_open_pipegnuplot_open_pipeGnuplotOpenPipeGnuplotOpenPipeGnuplotOpenPipe, gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFile, gnuplot_closegnuplot_closeGnuplotCloseGnuplotCloseGnuplotClose

Module

Foundation


ClassesClasses | | Operators