UsTK : Ultrasound ToolKit
version 2.0.1 under development (2023-12-07)
|
#include <visp3/ustk_core/usSequenceReader.h>
Public Member Functions | |
usSequenceReader () | |
virtual | ~usSequenceReader () |
void | acquire (ImageType &image) |
void | acquire (ImageType &image, uint64_t ×tamp) |
bool | end () |
void | getFrame (ImageType &image, int index) |
ImageType & | getFrame (int index) |
long | getFrameCount () |
double | getFrameRate () const |
long | getImageNumber () const |
std::vector< uint64_t > | getSequenceTimestamps () const |
usImageSettingsXmlParser | getXmlParser () |
void | open (ImageType &image, uint64_t ×tamp) |
void | open (ImageType &image) |
void | setFirstFrameIndex (long firstIndex) |
void | setLastFrameIndex (long lastIndex) |
void | setLoopCycling (bool activateLoopCycling) |
void | setSequenceFileName (const std::string &sequenceFileName) |
Reading of sequences of ultrasound images.
This class is used to grab ultrasound images from a sequence.
Definition at line 67 of file usSequenceReader.h.
usSequenceReader< ImageType >::usSequenceReader |
Default constructor.
Definition at line 181 of file usSequenceReader.h.
|
virtual |
Destructor.
Definition at line 191 of file usSequenceReader.h.
void usSequenceReader< ImageType >::acquire | ( | ImageType & | image | ) |
Sequence image acquisition (grabber-style : an internal counter is incremented to open next image at the next call).
[out] | image | Image of the sequence to read. |
Definition at line 630 of file usSequenceReader.h.
Referenced by usImageIo::read().
void usSequenceReader< ImageType >::acquire | ( | ImageType & | image, |
uint64_t & | timestamp | ||
) |
Sequence image acquisition (grabber-style : an internal counter is incremented to open next image at the next call).
[out] | image | Image of the sequence to read. |
[out] | timestamp | Real timestamp of the image acquisition (optionnal). |
Definition at line 693 of file usSequenceReader.h.
|
inline |
Definition at line 119 of file usSequenceReader.h.
References usSequenceReader< ImageType >::open().
Referenced by usImageIo::read().
void usSequenceReader< ImageType >::getFrame | ( | ImageType & | image, |
int | index | ||
) |
Sequence image acquisition with selection of the index (bypassing the internal counter).
[out] | image | Image of the sequence to read. |
[in] | index | Index of the image you want to acquire. |
Definition at line 897 of file usSequenceReader.h.
ImageType & usSequenceReader< ImageType >::getFrame | ( | int | index | ) |
Sequence image acquisition with selection of the index (bypassing the internal counter).
index | Index of the image you want to acquire. |
Definition at line 921 of file usSequenceReader.h.
long usSequenceReader< ImageType >::getFrameCount |
Get the total number of frames in the sequence.
Definition at line 941 of file usSequenceReader.h.
Referenced by usImageIo::read().
|
inline |
Definition at line 155 of file usSequenceReader.h.
|
inline |
Definition at line 156 of file usSequenceReader.h.
|
inline |
Definition at line 159 of file usSequenceReader.h.
usImageSettingsXmlParser usSequenceReader< ImageType >::getXmlParser |
Get the xml parser used to access all the image settings written in the xml file.
Definition at line 952 of file usSequenceReader.h.
Referenced by usImageIo::read().
void usSequenceReader< ImageType >::open | ( | ImageType & | image | ) |
Sequence opening.
image | First image of the sequence to read. |
Definition at line 227 of file usSequenceReader.h.
void usSequenceReader< ImageType >::open | ( | ImageType & | image, |
uint64_t & | timestamp | ||
) |
Sequence opening.
image | First image of the sequence to read. | |
[out] | timestamp | Real timestamp of the image acquisition (optionnal). |
Definition at line 238 of file usSequenceReader.h.
Referenced by usSequenceReader< ImageType >::end(), and usImageIo::read().
void usSequenceReader< ImageType >::setFirstFrameIndex | ( | long | firstIndex | ) |
Sequence first index setter.
firstIndex | First index of the sequence. |
Definition at line 207 of file usSequenceReader.h.
void usSequenceReader< ImageType >::setLastFrameIndex | ( | long | lastIndex | ) |
Sequence last index setter.
lastIndex | Last index of the sequence. |
Definition at line 217 of file usSequenceReader.h.
void usSequenceReader< ImageType >::setLoopCycling | ( | bool | activateLoopCycling | ) |
Activate loop cycling mode
activateLoopCycling | True if you want to activate it, false to stop the loop. |
Definition at line 932 of file usSequenceReader.h.
void usSequenceReader< ImageType >::setSequenceFileName | ( | const std::string & | sequenceFileName | ) |
Settings fileName setter.
sequenceFileName | Relative or absolute file name of the sequence header. |
Definition at line 197 of file usSequenceReader.h.
Referenced by usImageIo::read().