Spec-Zone.ru › PointCloudLibrary

Основной класс PCL Plotter. Подробнее...

#include <pcl/visualization/pcl_plotter.h>

Общедоступные типы

using Ptr = shared_ptr< PCLPlotter >
using ConstPtr = shared_ptr< const PCLPlotter >
using PolynomialFunction = std::vector< double >
Представление полиномиальной функции. Подробнее...
using RationalFunction = std::pair< PolynomialFunction, PolynomialFunction >
Представление рациональной функции, определяемой как отношение двух полиномиальных функций. Подробнее...

Общедоступные функции-члены

PCLPlotter (char const *name="PCL Plotter")
Конструктор PCL Plotter. Подробнее...
~PCLPlotter ()
Деструктор. Подробнее...
void addPlotData (double const *array_X, double const *array_Y, unsigned long size, char const *name="Y Axis", int type=vtkChart::LINE, char const *color=nullptr)
Добавляет график по соответствующим значениям в массивах arrayX и arrayY. Подробнее...
void addPlotData (std::vector< double > const &array_x, std::vector< double >const &array_y, char const *name="Y Axis", int type=vtkChart::LINE, std::vector< char > const &color=std::vector< char >())
Добавляет график по соответствующим значениям в векторах arrayX и arrayY. Подробнее...
void addPlotData (std::vector< std::pair< double, double > > const &plot_data, char const *name="Y Axis", int type=vtkChart::LINE, std::vector< char > const &color=std::vector< char >())
Добавляет график по соответствующим значениям в векторе пар. Подробнее...
void addPlotData (PolynomialFunction const &p_function, double x_min, double x_max, char const *name="Y Axis", int num_points=100, int type=vtkChart::LINE, std::vector< char > const &color=std::vector< char >())
Добавляет график заданной полиномиальной функции в указанном диапазоне по оси X. Подробнее...
void addPlotData (RationalFunction const &r_function, double x_min, double x_max, char const *name="Y Axis", int num_points=100, int type=vtkChart::LINE, std::vector< char > const &color=std::vector< char >())
Добавляет график заданной рациональной функции в указанном диапазоне по оси X. Подробнее...
void addPlotData (double(*function)(double), double x_min, double x_max, char const *name="Y Axis", int num_points=100, int type=vtkChart::LINE, std::vector< char > const &color=std::vector< char >())
Добавляет график на основе пользовательской функции обратного вызова, представляющей функцию для построения. Подробнее...
void addPlotData (char const *filename, int type=vtkChart::LINE)
Добавляет график на основе таблицы с разделителями-пробелами или табуляцией, содержащейся в файле. Подробнее...
void addHistogramData (std::vector< double > const &data, int const nbins=10, char const *name="Histogram", std::vector< char > const &color=std::vector< char >())
Распределяет элементы вектора data по nbins равномерно расположенным интервалам и строит полученную гистограмму. Подробнее...
template<typename PointT >
bool addFeatureHistogram (const pcl::PointCloud< PointT > &cloud, int hsize, const std::string &id="cloud", int win_width=640, int win_height=200)
Добавляет гистограмму признаков на экран в отдельном окне из облака, содержащего одну гистограмму. Подробнее...
bool addFeatureHistogram (const pcl::PCLPointCloud2 &cloud, const std::string &field_name, const std::string &id="cloud", int win_width=640, int win_height=200)
Добавляет гистограмму признаков на экран в отдельном окне из облака, содержащего одну гистограмму. Подробнее...
template<typename PointT >
bool addFeatureHistogram (const pcl::PointCloud< PointT > &cloud, const std::string &field_name, const pcl::index_t index, const std::string &id="cloud", int win_width=640, int win_height=200)
Добавляет гистограмму признаков на экран в отдельном окне. Подробнее...
bool addFeatureHistogram (const pcl::PCLPointCloud2 &cloud, const std::string &field_name, const pcl::index_t index, const std::string &id="cloud", int win_width=640, int win_height=200)
Добавляет гистограмму признаков на экран в отдельном окне. Подробнее...
void plot ()
Отображает все графики, добавленные к этому моменту с помощью addPlotData() или addHistogramData(). Подробнее...
void spinOnce (const int spin_time=1)
Запускает цикл обработки событий интерактора на время spin_time. Подробнее...
void spin ()
Запускает цикл обработки событий интерактора на неопределённое время. Подробнее...
void clearPlots ()
Удаляет все графики из окна. Подробнее...
void setColorScheme (int scheme)
Задаёт цветовую схему графика. Подробнее...
int getColorScheme ()
Возвращает текущую цветовую схему. Подробнее...
void setBackgroundColor (const double r, const double g, const double b)
Метод задания и получения цвета фона области просмотра. Подробнее...
void setBackgroundColor (const double color[3])
Метод задания и получения цвета фона области просмотра. Подробнее...
double * getBackgroundColor ()
Метод задания и получения цвета фона области просмотра. Подробнее...
void setXRange (double min, double max)
Задаёт логический диапазон оси X в координатах графика. Подробнее...
void setYRange (double min, double max)
Задаёт логический диапазон оси Y в координатах графика. Подробнее...
void setTitle (const char *title)
Задаёт основной заголовок графика. Подробнее...
void setXTitle (const char *title)
Задаёт заголовок оси X. Подробнее...
void setYTitle (const char *title)
Задаёт заголовок оси Y. Подробнее...
void setShowLegend (bool flag)
Отображает легенду графика. Подробнее...
void setWindowSize (int w, int h)
Метод задания и получения размера окна. Подробнее...
void setWindowPosition (int x, int y)
Задаёт положение в экранных координатах. Подробнее...
void setWindowName (const std::string &name)
Задаёт имя окна визуализатора. Подробнее...
int * getWindowSize () const
Метод задания и получения размера окна. Подробнее...
vtkSmartPointer< vtkRenderWindow > getRenderWindow ()
Возвращает указатель на используемое базовое окно отрисовки VTK. Подробнее...
void setViewInteractor (vtkSmartPointer< vtkRenderWindowInteractor > interactor)
Задаёт интерактор представления. Подробнее...
void startInteractor ()
Инициализирует и запускает интерактор представления. Подробнее...
void renderOnce ()
Выполняет однократную отрисовку vtkWindow. Подробнее...
bool wasStopped () const
Возвращает true, если пользователь попытался закрыть окно. Подробнее...
void close ()
Останавливает взаимодействие и закрывает окно визуализации. Подробнее...

Подробное описание

Основной класс PCL Plotter.

При наличии соответствий между точками этот класс можно использовать для построения графика зависимости одних данных от других и отображения его на экране. Он также содержит методы для построения графиков важных функций, таких как гистограмма и т. д. В этом классе переопределены важные функции PCLHistogramVisualizer, чтобы этот единственный класс мог отвечать за все функции, связанные с построением графиков.

Автор
Kripasindhu Sarkar

Определение в строке 75 файла pcl_plotter.h.

Описание псевдонимов типов класса

ConstPtr

using pcl::visualization::PCLPlotter::ConstPtr = shared_ptr<const PCLPlotter>

Определение в строке 79 файла pcl_plotter.h.

PolynomialFunction

using pcl::visualization::PCLPlotter::PolynomialFunction = std::vector<double>

Представление полиномиальной функции.

i-й элемент вектора обозначает коэффициент при x^i полинома от переменной x.

Определение в строке 83 файла pcl_plotter.h.

Ptr

using pcl::visualization::PCLPlotter::Ptr = shared_ptr<PCLPlotter>

Определение в строке 78 файла pcl_plotter.h.

RationalFunction

using pcl::visualization::PCLPlotter::RationalFunction = std::pair<PolynomialFunction, PolynomialFunction>

Представление рациональной функции, определённой как отношение двух полиномиальных функций.

pair::first обозначает числитель, а pair::second — знаменатель рациональной функции.

Определение в строке 87 файла pcl_plotter.h.

Описание конструктора и деструктора

PCLPlotter()

pcl::visualization::PCLPlotter::PCLPlotter ( char const * name = "PCL Plotter" )

Конструктор PCL Plotter.


Параметры
[in] name Название окна

~PCLPlotter()

pcl::visualization::PCLPlotter::~PCLPlotter ( )

Деструктор.

Описание функций-членов

addFeatureHistogram() [1/4]

bool pcl::visualization::PCLPlotter::addFeatureHistogram ( const pcl::PCLPointCloud2 & cloud,
const std::string & field_name,
const pcl::index_t index,
const std::string & id = "cloud",
int win_width = 640,
int win_height = 200
)

Добавляет на экран гистограмму признака в отдельном окне.

Параметры
[in] cloud набор данных PointCloud, содержащий гистограмму
[in] field_name имя поля, содержащего гистограмму
[in] index индекс точки, из которой извлекается гистограмма
[in] id идентификатор объекта облака точек (по умолчанию: cloud)
[in] win_width ширина окна
[in] win_height высота окна

addFeatureHistogram() [2/4]

bool pcl::visualization::PCLPlotter::addFeatureHistogram ( const pcl::PCLPointCloud2 & cloud,
const std::string & field_name,
const std::string & id = "cloud",
int win_width = 640,
int win_height = 200
)

Добавляет на экран гистограмму признака в отдельном окне на основе облака, содержащего одну гистограмму.

Параметры
[in] cloud набор данных PointCloud, содержащий гистограмму
[in] field_name имя поля, содержащего гистограмму
[in] id идентификатор объекта облака точек (по умолчанию: cloud)
[in] win_width ширина окна
[in] win_height высота окна

addFeatureHistogram() [3/4]

template<typename PointT >
bool pcl::visualization::PCLPlotter::addFeatureHistogram ( const pcl::PointCloud< PointT > & cloud,
const std::string & field_name,
const pcl::index_t index,
const std::string & id = "cloud",
int win_width = 640,
int win_height = 200
)

Добавляет на экран гистограмму признака в отдельном окне.

Параметры
[in] cloud набор данных PointCloud, содержащий гистограмму
[in] field_name имя поля, содержащего гистограмму
[in] index индекс точки, из которой извлекается гистограмма
[in] id идентификатор объекта облака точек (по умолчанию: cloud)
[in] win_width ширина окна
[in] win_height высота окна

Определение в строке 69 файла pcl_plotter.hpp.

Ссылки: addPlotData(), setWindowSize() и pcl::PointCloud< PointT >::size().

addFeatureHistogram() [4/4]

template<typename PointT >
bool pcl::visualization::PCLPlotter::addFeatureHistogram ( const pcl::PointCloud< PointT > & cloud,
int hsize,
const std::string & id = "cloud",
int win_width = 640,
int win_height = 200
)

Добавляет на экран гистограмму признака в отдельном окне на основе облака, содержащего одну гистограмму.

Параметры
[in] cloud набор данных PointCloud, содержащий гистограмму
[in] hsize длина гистограммы
[in] id идентификатор объекта облака точек (по умолчанию: cloud)
[in] win_width ширина окна
[in] win_height высота окна

Определение в строке 49 файла pcl_plotter.hpp.

Ссылки: addPlotData() и setWindowSize().

addHistogramData()

void pcl::visualization::PCLPlotter::addHistogramData ( std::vector< double > const & data,
int const nbins = 10,
char const * name = "Histogram",
std::vector< char > const & color = std::vector< char >()
)

Распределяет элементы вектора data по nbins равномерно расположенным интервалам и строит полученную гистограмму.

Параметры
[in] data исходные данные
[in] nbins количество интервалов гистограммы
[in] name название гистограммы, отображаемое в легенде, если она включена
[in] color массив символов из 4 элементов, задающих компоненты R, G, B и A цвета графика в диапазоне от 0 до 255. Если этот аргумент не указан (или передан пустой вектор), цвет гистограммы выбирается на основе текущей цветовой схемы

addPlotData() [1/7]

void pcl::visualization::PCLPlotter::addPlotData ( char const * filename,
int type = vtkChart::LINE
)

Добавляет график на основе таблицы с разделителями-пробелами или табуляцией, содержащейся в файле.

Параметры
[in] filename имя файла с таблицей. В первом столбце содержатся значения оси X. В остальных столбцах содержатся соответствующие значения осей Y. Первая строка файла используется для присвоения имени или метки графику. Имена графиков не должны содержать пробелов.
[in] type тип строящегося графика. vtkChart::LINE — линейный график, vtkChart::BAR — столбчатая диаграмма, vtkChart::POINTS — точечный график

addPlotData() [2/7]

void pcl::visualization::PCLPlotter::addPlotData ( double const * array_X,
double const * array_Y,
unsigned long size,
char const * name = "Y Axis",
int type = vtkChart::LINE,
char const * color = nullptr
)

Добавляет график по соответствующим значениям в массивах arrayX и arrayY.

Параметры
[in] array_X координаты X точек массива соответствий
[in] array_Y координаты Y точек массива соответствий
[in] size длина массивов arrayX и arrayY
[in] name название графика, отображаемое в легенде, если она включена
[in] type тип строящегося графика. vtkChart::LINE — линейный график, vtkChart::BAR — столбчатая диаграмма, vtkChart::POINTS — точечный график
[in] color массив символов из 4 элементов, задающих компоненты R, G, B и A цвета графика в диапазоне от 0 до 255. Если этот аргумент не указан (или передан NULL), цвет графика выбирается на основе цветовой схемы

Используется в addFeatureHistogram().

addPlotData() [3/7]

void pcl::visualization::PCLPlotter::addPlotData ( double(*)(double) function,
double x_min,
double x_max,
char const * name = "Y Axis",
int num_points = 100,
int type = vtkChart::LINE,
std::vector< char > const & color = std::vector< char >()
)

Добавляет график на основе определённой пользователем функции обратного вызова, задающей функцию для построения.

Параметры
[in] function определённая пользователем функция обратного вызова, задающая зависимость y = function(x)
[in] x_min левая граница диапазона отображения графика
[in] x_max правая граница диапазона отображения графика
[in] name название графика, отображаемое в легенде, если она включена
[in] num_points Количество точек, используемых для построения графика. Чем больше это число, тем выше разрешение графика.
[in] type тип строящегося графика. vtkChart::LINE — линейный график, vtkChart::BAR — столбчатая диаграмма, vtkChart::POINTS — точечный график
[in] color массив символов из 4 элементов, задающих компоненты R, G, B и A цвета графика в диапазоне от 0 до 255. Если этот аргумент не указан (или передан NULL), цвет графика выбирается на основе цветовой схемы

addPlotData() [4/7]

void pcl::visualization::PCLPlotter::addPlotData ( PolynomialFunction const & p_function,
double x_min,
double x_max,
char const * name = "Y Axis",
int num_points = 100,
int type = vtkChart::LINE,
std::vector< char > const & color = std::vector< char >()
)

Добавляет график заданной полиномиальной функции в указанном диапазоне по оси X.

Параметры
[in] p_function Полиномиальная функция, представленная вектором коэффициентов. См. описание псевдонима типа.
[in] x_min левая граница диапазона отображения графика
[in] x_max правая граница диапазона отображения графика
[in] name название графика, отображаемое в легенде, если она включена
[in] num_points Количество точек, используемых для построения графика. Чем больше это число, тем выше разрешение графика.
[in] type тип строящегося графика. vtkChart::LINE — линейный график, vtkChart::BAR — столбчатая диаграмма, vtkChart::POINTS — точечный график
[in] color массив символов из 4 элементов, задающих компоненты R, G, B и A цвета графика в диапазоне от 0 до 255. Если этот аргумент не указан (или передан NULL), цвет графика выбирается на основе цветовой схемы

addPlotData() [5/7]

void pcl::visualization::PCLPlotter::addPlotData ( RationalFunction const & r_function,
double x_min,
double x_max,
char const * name = "Y Axis",
int num_points = 100,
int type = vtkChart::LINE,
std::vector< char > const & color = std::vector< char >()
)

Добавляет график заданной рациональной функции в указанном диапазоне по оси X.

Параметры
[in] r_function Рациональная функция, представленная отношением двух полиномиальных функций. Подробнее см. описание псевдонима типа.
[in] x_min левая граница диапазона отображения графика
[in] x_max правая граница диапазона отображения графика
[in] name название графика, отображаемое в легенде, если она включена
[in] num_points Количество точек, используемых для построения графика. Чем больше это число, тем выше разрешение графика.
[in] type тип строящегося графика. vtkChart::LINE — линейный график, vtkChart::BAR — столбчатая диаграмма, vtkChart::POINTS — точечный график
[in] color массив символов из 4 элементов, задающих компоненты R, G, B и A цвета графика в диапазоне от 0 до 255. Если этот аргумент не указан (или передан NULL), цвет графика выбирается на основе цветовой схемы

addPlotData() [6/7]

void pcl::visualization::PCLPlotter::addPlotData ( std::vector< double > const & array_x,
std::vector< double >const & array_y,
char const * name = "Y Axis",
int type = vtkChart::LINE,
std::vector< char > const & color = std::vector< char >()
)

Добавляет график с соответствиями в векторах arrayX и arrayY.

Это версия функции addPlotData, принимающая векторы.

Параметры
[in] array_x X-координаты массива соответствий точек
[in] array_y Y-координаты массива соответствий точек
[in] name имя графика, отображаемое в легенде, если она включена
[in] type тип строящегося графика. vtkChart::LINE — линейный график, vtkChart::BAR — столбчатый график, а vtkChart::POINTS — точечный график
[in] color массив символов из 4 элементов, задающих компоненты R, G, B и A цвета графика в диапазоне от 0 до 255. Если этот аргумент не передан (или передан NULL), цвет графика определяется цветовой схемой

addPlotData() [7/7]

void pcl::visualization::PCLPlotter::addPlotData ( std::vector< std::pair< double, double > > const & plot_data,
char const * name = "Y Axis",
int type = vtkChart::LINE,
std::vector< char > const & color = std::vector< char >()
)

Добавляет график с соответствиями в векторе пар.

Первый и второй элементы пар вектора образуют соответствие.

Параметры
plot_data
[in] name имя графика, отображаемое в легенде, если она включена
[in] type тип строящегося графика. vtkChart::LINE — линейный график, vtkChart::BAR — столбчатый график, а vtkChart::POINTS — точечный график
[in] color массив символов из 4 элементов, задающих компоненты R, G, B и A цвета графика в диапазоне от 0 до 255. Если этот аргумент не передан (или передан NULL), цвет графика определяется цветовой схемой

clearPlots()

void pcl::visualization::PCLPlotter::clearPlots ( )

Удаляет все графики из окна.

close()

void pcl::visualization::PCLPlotter::close ( )

Останавливает взаимодействие и закрывает окно визуализации.

getBackgroundColor()

double* pcl::visualization::PCLPlotter::getBackgroundColor ( )

Метод установки/получения цвета фона области просмотра.

Возвращает
[out] color массив, содержащий 3 компонента цвета RGB

getColorScheme()

int pcl::visualization::PCLPlotter::getColorScheme ( )

Возвращает используемую в данный момент цветовую схему

Возвращает
[out] используемая в данный момент цветовая схема. Возможные значения: WARM, COOL, BLUES, WILD_FLOWER, CITRUS, CUSTOM

getRenderWindow()

vtkSmartPointer<vtkRenderWindow> pcl::visualization::PCLPlotter::getRenderWindow ( )

Возвращает указатель на используемый внутренний объект VTK RenderWindow.

getWindowSize()

int* pcl::visualization::PCLPlotter::getWindowSize ( ) const

Метод установки/получения размера окна.

Возвращает
[in] массив, содержащий ширину и высоту окна

plot()

void pcl::visualization::PCLPlotter::plot ( )

Отображает все графики, добавленные на данный момент с помощью addPlotData() или addHistogramData().

renderOnce()

void pcl::visualization::PCLPlotter::renderOnce ( )

Выполняет однократную отрисовку vtkWindow.

setBackgroundColor() [1/2]

void pcl::visualization::PCLPlotter::setBackgroundColor ( const double color[3] )

Метод установки/получения цвета фона области просмотра.

Параметры
[in] color массив, содержащий 3 компонента цвета RGB

setBackgroundColor() [2/2]

void pcl::visualization::PCLPlotter::setBackgroundColor ( const double r,
const double g,
const double b
)

Метод установки/получения цвета фона области просмотра.

Параметры
[in] r красный компонент цвета RGB
[in] g зелёный компонент цвета RGB
[in] b синий компонент цвета RGB

setColorScheme()

void pcl::visualization::PCLPlotter::setColorScheme ( int scheme )

Устанавливает цветовую схему графика.

Цвета графиков автоматически выбираются в соответствии с цветовой схемой.

Параметры
[in] scheme цветовая схема. Возможные значения: vtkColorSeries::SPECTRUM, vtkColorSeries::WARM, vtkColorSeries::COOL, vtkColorSeries::BLUES, vtkColorSeries::WILD_FLOWER, vtkColorSeries::CITRUS

setShowLegend()

void pcl::visualization::PCLPlotter::setShowLegend ( bool flag )

Отображает легенду графика.

Параметры
[in] flag передайте flag = true, чтобы отобразить легенду графика

setTitle()

void pcl::visualization::PCLPlotter::setTitle ( const char * title )

Устанавливает основной заголовок графика.

Параметры
[in] title задаваемый заголовок

setViewInteractor()

void pcl::visualization::PCLPlotter::setViewInteractor ( vtkSmartPointer< vtkRenderWindowInteractor > interactor )

Устанавливает интерактор представления.

setWindowName()

void pcl::visualization::PCLPlotter::setWindowName ( const std::string & name )

Задаёт имя окна визуализатора.

Параметры
[in] name имя окна

setWindowPosition()

void pcl::visualization::PCLPlotter::setWindowPosition ( int x,
int y
)

Задаёт положение в экранных координатах.

Параметры
[in] x координата, в которую следует переместить окно (X)
[in] y координата, в которую следует переместить окно (Y)

setWindowSize()

void pcl::visualization::PCLPlotter::setWindowSize ( int w,
int h
)

Метод установки/получения размера окна.

Параметры
[in] w ширина окна
[in] h высота окна

Цитируется в addFeatureHistogram().

setXRange()

void pcl::visualization::PCLPlotter::setXRange ( double min,
double max
)

Задаёт логический диапазон оси X в координатах графика.

Параметры
[in] min левая граница диапазона
[in] max правая граница диапазона

setXTitle()

void pcl::visualization::PCLPlotter::setXTitle ( const char * title )

Задаёт заголовок оси X.

Параметры
[in] title задаваемый заголовок

setYRange()

void pcl::visualization::PCLPlotter::setYRange ( double min,
double max
)

Задаёт логический диапазон оси Y в координатах графика.

Параметры
[in] min левая граница диапазона
[in] max правая граница диапазона

setYTitle()

void pcl::visualization::PCLPlotter::setYTitle ( const char * title )

Задаёт заголовок оси Y.

Параметры
[in] title задаваемый заголовок

spin()

void pcl::visualization::PCLPlotter::spin ( )

Непрерывно выполняет цикл обработки событий интерактора.

Аналогично plot(); добавлен для единообразия с другими существующими классами визуализации.

spinOnce()

void pcl::visualization::PCLPlotter::spinOnce ( const int spin_time = 1 )

Выполняет цикл обработки событий интерактора в течение времени spin_time.

Это название сбивает с толку и, вероятно, устареет в одном из будущих выпусков, когда будет добавлена единственная функция spin()/display() с перегрузкой.

Параметры
[in] spin_time — время (в мс), в течение которого разрешено выполнять цикл визуализации.

startInteractor()

void pcl::visualization::PCLPlotter::startInteractor ( )

Инициализирует и запускает интерактор представления.

wasStopped()

bool pcl::visualization::PCLPlotter::wasStopped ( ) const

Возвращает true, если пользователь попытался закрыть окно.


Документация этого класса создана на основе следующих файлов:
  • pcl/visualization/pcl_plotter.h
  • pcl/visualization/impl/pcl_plotter.hpp

© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/classpcl_1_1visualization_1_1_p_c_l_plotter.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API