gnuplot_open_fileT_gnuplot_open_fileGnuplotOpenFileGnuplotOpenFilegnuplot_open_file (Operator)
Name
gnuplot_open_fileT_gnuplot_open_fileGnuplotOpenFileGnuplotOpenFilegnuplot_open_file — Open a gnuplot file for visualization of images and control values.
Warning
gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFilegnuplot_open_file is obsolete and is only provided for
reasons of backward compatibility.
Signature
def gnuplot_open_file(file_name: str) -> HHandle
Description
gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFilegnuplot_open_file allows the output of images and
control values in a format which can be later processed by gnuplot.
The parameter FileNameFileNameFileNameFileNamefileNamefile_name determines the base-name of the
files to be created by calls to gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImagegnuplot_plot_image.
gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFilegnuplot_open_file 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_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImagegnuplot_plot_image (or control values plotted by
gnuplot_plot_ctrlgnuplot_plot_ctrlGnuplotPlotCtrlGnuplotPlotCtrlGnuplotPlotCtrlgnuplot_plot_ctrl) 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_closeGnuplotCloseGnuplotCloseGnuplotClosegnuplot_close has to be
called in order to close all open files. The corresponding
identifier for the gnuplot output stream is returned in
GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileIDgnuplot_file_id.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive 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
FileNameFileNameFileNameFileNamefileNamefile_name (input_control) filename.write → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Base name for control and data files.
File extension:
.gp
GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileIDgnuplot_file_id (output_control) gnuplot → HGnuplot, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Identifier for the gnuplot output stream.
Result
gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFilegnuplot_open_file returns the value 2 (
H_MSG_TRUE)
if the control
file could be opened. Otherwise, an exception is raised.
Possible Successors
gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImagegnuplot_plot_image,
gnuplot_closegnuplot_closeGnuplotCloseGnuplotCloseGnuplotClosegnuplot_close
Alternatives
gnuplot_open_pipegnuplot_open_pipeGnuplotOpenPipeGnuplotOpenPipeGnuplotOpenPipegnuplot_open_pipe
See also
gnuplot_open_pipegnuplot_open_pipeGnuplotOpenPipeGnuplotOpenPipeGnuplotOpenPipegnuplot_open_pipe,
gnuplot_closegnuplot_closeGnuplotCloseGnuplotCloseGnuplotClosegnuplot_close,
gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImagegnuplot_plot_image
Module
Foundation