pcl::ImageGrabberBase Class ReferenceabstractModule io — PointCloudLibrary

Базовый класс для считывателя файлов изображений. Подробнее...

#include <pcl/io/image_grabber.h>

Открытые функции-члены
	ImageGrabberBase (const std::string &directory, float frames_per_second, bool repeat, bool pclzf_mode)
	Конструктор, принимающий папку с изображениями глубины+[RGB]. Подробнее...
	ImageGrabberBase (const std::string &depth_directory, const std::string &rgb_directory, float frames_per_second, bool repeat)
	ImageGrabberBase (const std::vector< std::string > &depth_image_files, float frames_per_second, bool repeat)
	Конструктор, принимающий список путей к файлам PCD, которые воспроизводятся в порядке их следования в списке. Подробнее...
	~ImageGrabberBase () noexcept override
	Виртуальный деструктор. Подробнее...
void	start () override
	Начинает воспроизведение списка файлов PCD, если frames_per_second > 0. Подробнее...
void	stop () override
	Останавливает воспроизведение списка файлов PCD, если frames_per_second > 0. Подробнее...
virtual void	trigger ()
	Вызывает обратный вызов с новыми данными. Подробнее...
bool	isRunning () const override
	Показывает, запущен ли считыватель (публикует ли данные). Подробнее...
std::string	getName () const override
virtual void	rewind ()
	Возвращается к первому файлу PCD в списке. Подробнее...
float	getFramesPerSecond () const override
	Возвращает frames_per_second. Подробнее...
bool	isRepeatOn () const
	Показывает, включён ли флаг повтора. Подробнее...
bool	atLastFrame () const
	Показывает, достигнут ли последний кадр. Подробнее...
std::string	getCurrentDepthFileName () const
	Возвращает имя файла с текущим индексом. Подробнее...
std::string	getPrevDepthFileName () const
	Возвращает имя файла с предыдущим индексом. SDM: возвращаю это обратно, но полезно ли это или только вводит в заблуждение? Подробнее...
std::string	getDepthFileNameAtIndex (std::size_t idx) const
	Возвращает имя файла глубины с заданным индексом. Подробнее...
bool	getTimestampAtIndex (std::size_t idx, std::uint64_t &timestamp) const
	Запрашивает временную метку по индексу, если она существует. Подробнее...
void	setRGBImageFiles (const std::vector< std::string > &rgb_image_files)
	Вручную задаёт файлы изображений RGB. Подробнее...
virtual void	setCameraIntrinsics (const double focal_length_x, const double focal_length_y, const double principal_point_x, const double principal_point_y)
	Задаёт пользовательские фокусное расстояние и координаты центрального пикселя. Подробнее...
virtual void	getCameraIntrinsics (double &focal_length_x, double &focal_length_y, double &principal_point_x, double &principal_point_y) const
	Возвращает текущие фокусное расстояние и координаты центрального пикселя. Подробнее...
void	setDepthImageUnits (float units)
	Задаёт единицы измерения, в которых хранятся данные глубины. Подробнее...
void	setNumberOfThreads (unsigned int nr_threads=0)
	Задаёт количество потоков, если требуется использовать OpenMP для ускорения заполнения облака. Подробнее...
Открытые функции-члены, унаследованные от pcl::Grabber
	Grabber ()=default
	Конструктор по умолчанию. Подробнее...
	Grabber (const Grabber &)=delete
	Конструктор копирования отсутствует, поскольку Grabber нельзя копировать. Подробнее...
Grabber &	operator= (const Grabber &)=delete
	Оператор присваивания копированием отсутствует, поскольку Grabber нельзя копировать. Подробнее...
	Grabber (Grabber &&)=default
	Перемещающий конструктор. Подробнее...
Grabber &	operator= (Grabber &&)=default
	Оператор перемещающего присваивания. Подробнее...
virtual	~Grabber () noexcept=default
	Виртуальный деструктор. Подробнее...
template<typename T >
boost::signals2::connection	registerCallback (const std::function< T > &callback)
	Регистрирует функцию/метод обратного вызова для сигнала с соответствующей сигнатурой. Подробнее...
template<typename T >
bool	providesCallback () const noexcept
	Показывает, существует ли сигнал с заданным типом параметров. Подробнее...
bool	toggle ()
	Для потоковых устройств: остановленные потоки запускаются, а работающие — останавливаются. Подробнее...

Защищённые функции-члены
std::size_t	numFrames () const
	Вспомогательная функция для определения количества кадров. Подробнее...
bool	getCloudAt (std::size_t idx, pcl::PCLPointCloud2 &blob, Eigen::Vector4f &origin, Eigen::Quaternionf &orientation) const
	Получает облако в формате ROS по индексу idx. Подробнее...
Защищённые функции-члены, унаследованные от pcl::Grabber
virtual void	signalsChanged ()
template<typename T >
boost::signals2::signal< T > *	find_signal () const noexcept
template<typename T >
int	num_slots () const noexcept
template<typename T >
void	disconnect_all_slots ()
template<typename T >
void	block_signal ()
template<typename T >
void	unblock_signal ()
void	block_signals ()
void	unblock_signals ()
template<typename T >
boost::signals2::signal< T > *	createSignal ()

Дополнительные унаследованные элементы
Защищённые атрибуты, унаследованные от pcl::Grabber
std::map< std::string, std::unique_ptr< boost::signals2::signal_base > >	signals_
std::map< std::string, std::vector< boost::signals2::connection > >	connections_
std::map< std::string, std::vector< boost::signals2::shared_connection_block > >	shared_connections_

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

Базовый класс для средства захвата изображений из файлов.

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

Документация конструкторов и деструктора

ImageGrabberBase() [1/3]

pcl::ImageGrabberBase::ImageGrabberBase	(	const std::string &	directory,
		float	frames_per_second,
		bool	repeat,
		bool	pclzf_mode
	)

Конструктор, принимающий каталог с изображениями глубины+[RGB].

Параметры

[in]	directory	Каталог, содержащий упорядоченный набор изображений, соответствующих видео [RGB]D и сохранённых в файлах TIFF, PNG, JPG или PPM. Соглашение об именовании: frame_[timestamp]_["depth"/"rgb"].[extension]
[in]	frames_per_second	Количество кадров в секунду. Если равно 0, функция start() работает как триггер и публикует следующий PCD из списка.
[in]	repeat	Следует ли воспроизводить файл PCD в бесконечном цикле.
	pclzf_mode

ImageGrabberBase() [2/3]

pcl::ImageGrabberBase::ImageGrabberBase	(	const std::string &	depth_directory,
		const std::string &	rgb_directory,
		float	frames_per_second,
		bool	repeat
	)

ImageGrabberBase() [3/3]

pcl::ImageGrabberBase::ImageGrabberBase	(	const std::vector< std::string > &	depth_image_files,
		float	frames_per_second,
		bool	repeat
	)

Конструктор, принимающий список путей к файлам PCD, которые воспроизводятся в порядке их следования в списке.

Параметры

[in]	depth_image_files	Путь к файлам изображений глубины.
[in]	frames_per_second	Количество кадров в секунду. Если равно 0, функция start() работает как триггер и публикует следующий PCD из списка.
[in]	repeat	Следует ли воспроизводить файл PCD в бесконечном цикле.

~ImageGrabberBase()

pcl::ImageGrabberBase::~ImageGrabberBase ( )

overridenoexcept

Виртуальный деструктор.

Документация функций-членов

atLastFrame()

bool pcl::ImageGrabberBase::atLastFrame ( ) const

Возвращает, достигнут ли последний кадр.

getCameraIntrinsics()

virtual void pcl::ImageGrabberBase::getCameraIntrinsics	(	double &	focal_length_x,
		double &	focal_length_y,
		double &	principal_point_x,
		double &	principal_point_y
	)		const

virtual

Получает текущее фокусное расстояние и координаты центрального пикселя.

Если внутренние параметры были заданы вручную с помощью setCameraIntrinsics, возвращаются эти значения. В противном случае, если был вызван start () и средство захвата обнаружило файл frame_[timestamp].xml, возвращаются последние прочитанные значения. Иначе возвращаются заводские значения по умолчанию.

Параметры

[out]	focal_length_x	Горизонтальное фокусное расстояние (fx)
[out]	focal_length_y	Вертикальное фокусное расстояние (fy)
[out]	principal_point_x	Горизонтальная координата главной точки (cx)
[out]	principal_point_y	Вертикальная координата главной точки (cy)

getCloudAt()

bool pcl::ImageGrabberBase::getCloudAt	(	std::size_t	idx,
		pcl::PCLPointCloud2 &	blob,
		Eigen::Vector4f &	origin,
		Eigen::Quaternionf &	orientation
	)		const

protected

Получает облако в формате ROS по индексу idx.

getCurrentDepthFileName()

std::string pcl::ImageGrabberBase::getCurrentDepthFileName ( ) const

Возвращает имя файла с текущим индексом.

getDepthFileNameAtIndex()

std::string pcl::ImageGrabberBase::getDepthFileNameAtIndex ( std::size_t idx ) const

Получает имя файла глубины по указанному индексу.

getFramesPerSecond()

float pcl::ImageGrabberBase::getFramesPerSecond ( ) const

Возвращает значение frames_per_second.

0, если средство захвата работает в режиме триггера

Реализует pcl::Grabber.

getName()

std::string pcl::ImageGrabberBase::getName ( ) const

Возвращает: Имя средства захвата

Реализует pcl::Grabber.

getPrevDepthFileName()

std::string pcl::ImageGrabberBase::getPrevDepthFileName ( ) const

Возвращает имя файла с предыдущим индексом. SDM: возвращаю это обратно, но полезно ли это или только запутает?

getTimestampAtIndex()

bool pcl::ImageGrabberBase::getTimestampAtIndex	(	std::size_t	idx,
		std::uint64_t &	timestamp
	)		const

Получает только временную метку для индекса, если она существует.

isRepeatOn()

bool pcl::ImageGrabberBase::isRepeatOn ( ) const

Возвращает состояние флага повтора.

isRunning()

bool pcl::ImageGrabberBase::isRunning ( ) const

Запущено ли средство захвата (идёт ли публикация).

Возвращает: true только во время публикации.

Реализует pcl::Grabber.

numFrames()

std::size_t pcl::ImageGrabberBase::numFrames ( ) const

Вспомогательная функция для получения количества кадров.

rewind()

virtual void pcl::ImageGrabberBase::rewind ( )

Возвращается к первому файлу PCD в списке.

setCameraIntrinsics()

virtual void pcl::ImageGrabberBase::setCameraIntrinsics	(	const double	focal_length_x,
		const double	focal_length_y,
		const double	principal_point_x,
		const double	principal_point_y
	)

Задаёт пользовательское фокусное расстояние и координаты центрального пикселя.

Эти параметры будут иметь приоритет над ЛЮБЫМИ другими настройками на протяжении всего времени существования средства захвата, будь то заводские значения по умолчанию или значения, явно считанные из файла frame_[timestamp].xml.

Параметры

[in]	focal_length_x	Горизонтальное фокусное расстояние (fx)
[in]	focal_length_y	Вертикальное фокусное расстояние (fy)
[in]	principal_point_x	Горизонтальная координата главной точки (cx)
[in]	principal_point_y	Вертикальная координата главной точки (cy)

setDepthImageUnits()

void pcl::ImageGrabberBase::setDepthImageUnits ( float units )

Задаёт единицы измерения, в которых хранятся данные глубины.

По умолчанию используются миллиметры (0.001), то есть яркость 1000 соответствует 1 м

setNumberOfThreads()

void pcl::ImageGrabberBase::setNumberOfThreads ( unsigned int nr_threads = 0 )

Задаёт количество потоков, если для более быстрого заполнения облака требуется использовать OpenMP.

Обратите внимание: на обычном компьютере (менее чем с 4 ядрами) это вряд ли даст существенное ускорение.

setRGBImageFiles()

void pcl::ImageGrabberBase::setRGBImageFiles ( const std::vector< std::string > & rgb_image_files )

Вручную задаёт файлы изображений RGB.

Параметры

[in] rgb_image_files Вектор файлов [tiff/png/jpg/ppm], используемых в качестве входных данных. Между ними и заданными изображениями глубины должно быть взаимно однозначное соответствие

start()

void pcl::ImageGrabberBase::start ( )

Начинает воспроизведение списка файлов PCD, если frames_per_second > 0.

В противном случае функция работает как триггер: публикует только следующий файл PCD из списка.

Реализует pcl::Grabber.

stop()

void pcl::ImageGrabberBase::stop ( )

Останавливает воспроизведение списка файлов PCD, если frames_per_second > 0.

В противном случае метод не выполняет никаких действий.

Реализует pcl::Grabber.

trigger()

virtual void pcl::ImageGrabberBase::trigger ( )

Вызывает обратный вызов с новыми данными.

Документация для этого класса была создана на основе следующего файла:

pcl/io/image_grabber.h

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

Открытые функции-члены

Защищённые функции-члены

Дополнительные унаследованные элементы

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

Документация конструкторов и деструктора

ImageGrabberBase() [1/3]

ImageGrabberBase() [2/3]

ImageGrabberBase() [3/3]

~ImageGrabberBase()

Документация функций-членов

atLastFrame()

getCameraIntrinsics()

getCloudAt()

getCurrentDepthFileName()

getDepthFileNameAtIndex()

getFramesPerSecond()

getName()

getPrevDepthFileName()

getTimestampAtIndex()

isRepeatOn()

isRunning()

numFrames()

rewind()

setCameraIntrinsics()

setDepthImageUnits()

setNumberOfThreads()

setRGBImageFiles()

start()

stop()

trigger()