gnuplot_open_filegnuplot_open_fileGnuplotOpenFilegnuplot_open_fileGnuplotOpenFileGnuplotOpenFile (Operator)

Name

gnuplot_open_filegnuplot_open_fileGnuplotOpenFilegnuplot_open_fileGnuplotOpenFileGnuplotOpenFile — Open a gnuplot file for visualization of images and control values.

Signature

gnuplot_open_file( : : FileName : GnuplotFileID)

Description

gnuplot_open_filegnuplot_open_fileGnuplotOpenFilegnuplot_open_fileGnuplotOpenFileGnuplotOpenFile allows the output of images and control values in a format which can be later processed by gnuplot. The parameter FileNameFileNameFileNameFileNameFileNamefileName determines the base-name of the files to be created by calls to gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImage. gnuplot_open_filegnuplot_open_fileGnuplotOpenFilegnuplot_open_fileGnuplotOpenFileGnuplotOpenFile generates a gnuplot control file with the name <Filename>.gp, in which the respective plot commands are written. Each image plotted by gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImage (or control values plotted by gnuplot_plot_ctrlgnuplot_plot_ctrlGnuplotPlotCtrlgnuplot_plot_ctrlGnuplotPlotCtrlGnuplotPlotCtrl) creates a data file with the name Filename.dat.<Number>, where Number is the number of the plot in the current sequence. The generated control file can later be edited to create the desired effect. After the last plot gnuplot_closegnuplot_closeGnuplotClosegnuplot_closeGnuplotCloseGnuplotClose has to be called in order to close all open files. The corresponding identifier for the gnuplot output stream is returned in GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileID.

Parallelization

Multithreading type: exclusive (runs in parallel only with independent operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

FileNameFileNameFileNameFileNameFileNamefileName (input_control) filename.write → (string)

Base name for control and data files.

File extension: .gp

GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileID (output_control) gnuplot_id → (integer)

Identifier for the gnuplot output stream.

gnuplot_open_filegnuplot_open_fileGnuplotOpenFilegnuplot_open_fileGnuplotOpenFileGnuplotOpenFile returns the value 2 (H_MSG_TRUE) if the control file could be opened. Otherwise, an exception is raised.