Visual Servoing Platform
version 3.5.1 under development (2023-09-22)
|
#include <visp3/io/vpImageQueue.h>
Classes | |
struct | cancelled |
Public Member Functions | |
vpImageQueue (const std::string &seqname, int record_mode) | |
void | cancel () |
int | getRecordingMode () const |
bool | getRecordingTrigger () const |
std::string | getSeqName () const |
void | pop (vpImage< Type > &I, std::string &data) |
void | push (const vpImage< Type > &I, std::string *data) |
bool | record (const vpImage< Type > &I, std::string *data=NULL, bool trigger_recording=false, bool disable_left_click=false) |
void | setMaxQueueSize (const size_t max_queue_size) |
Create a queue containing images and optional additional strings that could be useful to save additional information like the timestamp.
This call is to use with vpImageStorageWorker.
Definition at line 61 of file vpImageQueue.h.
|
inline |
Queue (FIFO) constructor. By default the max queue size is set to 1024*8.
[in] | seqname | : Generic sequence name like "folder/I%04d.png" . If this name contains a parent folder, it will be created. |
[in] | record_mode | : 0 to record a sequence of images, 1 to record single images. |
Definition at line 73 of file vpImageQueue.h.
References vpIoTools::checkDirectory(), and vpIoTools::getParent().
|
inline |
Emit cancel signal.
Definition at line 91 of file vpImageQueue.h.
|
inline |
Return record mode; 0 when recording a sequence of images, 1 when recording recording single imagess.
Definition at line 102 of file vpImageQueue.h.
Referenced by vpImageStorageWorker< Type >::vpImageStorageWorker().
|
inline |
Return recording trigger indicating if recording is started.
Definition at line 107 of file vpImageQueue.h.
|
inline |
Return generic name of the sequence of images.
Definition at line 112 of file vpImageQueue.h.
Referenced by vpImageStorageWorker< Type >::vpImageStorageWorker().
|
inline |
Pop the image to save from the queue (FIFO).
[out] | I | : Image to record. |
[out] | data | : Data to record. |
Definition at line 121 of file vpImageQueue.h.
|
inline |
Push data to save in the queue (FIFO).
[in] | I | : Image to record. |
[in] | data | : Data to record. |
Definition at line 153 of file vpImageQueue.h.
Referenced by vpImageQueue< Type >::record().
|
inline |
Record helper that display information in the windows associated to the image, pop current image and additional data in the queue.
[in] | I | : Image to record. |
[in] | data | : Data to record. Set to NULL when no additional data have to be considered. |
[in] | trigger_recording | : External trigger to start data saving. |
[in] | disable_left_click | : Disable left click usage to trigger data saving. |
Definition at line 186 of file vpImageQueue.h.
References vpMouseButton::button1, vpMouseButton::button3, vpImage< Type >::display, vpDisplay::displayText(), vpDisplay::getClick(), vpDisplay::getDownScalingFactor(), vpIoTools::makeDirectory(), vpImageQueue< Type >::push(), and vpColor::red.
|
inline |
Set queue size.
[in] | max_queue_size | : Queue size. |
Definition at line 261 of file vpImageQueue.h.