libdspl-2.0/dspl/dox/ru/gnuplot.dox

80 wiersze
4.4 KiB
Plaintext
Czysty Wina Historia

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

/*! ****************************************************************************
\ingroup PLOT_GROUP
\fn int gnuplot_create(int argc, char* argv[], int w, int h, char* fn_png,
void** hplot)
\brief Создать график GNUPLOT.
Данная функция открывает пакет GNUPLOT в зависимости от передаваемых в программу
параметров `argv`. После вызова данной функции по адресу `hplot` будет записан
handle графика и появляется возможность посылать GNUPLOT команды для отображения
графиков.
\note С точки зрения системы, `hplot` является указателем на открытый файл,
в который можно записывать команды для исполнения пакетом GNUPLOT.
\param[in] argc Количество аргументов вызова программы. \n
(количество переменных `argv`). \n
Данное значение не должно быть меньше единицы,
потому что `argv[0]` хранит имя исполняемого
файла программы.\n \n
\param[in] argv Указатель на массив строк параметров исполняемого файла. \n
Размер массива `argc` строк. \n
`argv[0]` хранит имя исполняемого файла программы. \n
`argv[1]` задает формат отображения графика: \n
`--plotwin` отображать график в отдельном окне
(данный параметр используется по умолчанию);\n
`--plotpng` сохранить график в png-файл, заданный именем
`fn_png`; \n
`--noplot` график не создавать, игнорировать все команды
GNUPLOT.\n \n
\param[in] w Ширина окна графика или png-файла в пикселях. \n \n
\param[in] h Высота окна графика или png-файла в пикселях. \n \n
\param[in] fn_png Имя png-файла, в который будет сохранен график. \n
Путь сохранения графика совпадает с путем исполняемого файла
программы. \n
\param[in, out] hplot Указатель на адрес хэндла пакета GNUPLOT. \n
По данному адресу будет записан указатель
на текщий график. \n \n
\return
`RES_OK` если функция выполнена успешно. \n
В противном случае \ref ERROR_CODE_GROUP "код ошибки".\n
При возникновении ошибки по адресу `hplot` будет записан `NULL`.\n
\note Если в `argv[1]` задан параметр `--noplot`, то функция вернет `RES_OK`,
но по адресу `hplot` также будет записан `NULL`.
\n
После построения графиков необходимо закрыть хэндл GNUPLOT функцией
\ref `gnuplot_close`.
Пример построения графиков синуса и косинуса привден в следующем листинге:
\include gnuplot_script_test.c
Данная программа рассчитвает значения функций синуса и косинуса,
а также сохрянет текстовые файлы `dat/cosine.txt` и `dat/sine.txt`.\n
Сохраненные данные отображаются на трех графиках (с данными синуса, косинуса
и обоими данными):
\image html gnuplot_script_sin.png
\image html gnuplot_script_cos.png
\image html gnuplot_script_sincos.png
\author Бахурин Сергей, www.dsplib.org
**************************************************************************** */