Visual Servoing Platform  version 3.6.1 under development (2024-05-26)
vpDiskGrabber Class Reference

#include <visp3/io/vpDiskGrabber.h>

+ Inheritance diagram for vpDiskGrabber:

Public Member Functions

 vpDiskGrabber ()
 
 vpDiskGrabber (const std::string &genericName)
 
virtual ~vpDiskGrabber ()
 
 vpDiskGrabber (const std::string &dir, const std::string &basename, long number, int step, unsigned int noz, const std::string &ext)
 
void acquire (vpImage< unsigned char > &I)
 
void acquire (vpImage< vpRGBa > &I)
 
void acquire (vpImage< float > &I)
 
void acquire (vpImage< unsigned char > &I, long image_number)
 
void acquire (vpImage< vpRGBa > &I, long image_number)
 
void acquire (vpImage< float > &I, long image_number)
 
void close ()
 
long getImageNumber () const
 
std::string getImageName () const
 
void open (vpImage< unsigned char > &I)
 
void open (vpImage< vpRGBa > &I)
 
void open (vpImage< float > &I)
 
void setBaseName (const std::string &name)
 
void setDirectory (const std::string &dir)
 
void setExtension (const std::string &ext)
 
void setGenericName (const std::string &genericName)
 
void setImageNumber (long number)
 
void setNumberOfZero (unsigned int noz)
 
void setStep (long step)
 

Public Attributes

bool init
 

Inherited functionalities from vpFramegrabber

unsigned int getHeight () const
 
unsigned int getWidth () const
 
unsigned int height
 
unsigned int width
 

Detailed Description

Class to grab (ie. read) images from the disk.

Defined a virtual video device. "Grab" the images from the disk. Derived from the vpFrameGrabber class.

See also
vpFrameGrabber

Here an example of capture from the directory "/local/soft/ViSP/ViSP-images/cube". We want to acquire 10 images from the first named "image.0001.pgm" by steps of 2.

#include <visp3/core/vpImage.h>
#include <visp3/io/vpDiskGrabber.h>
int main(){
vpImage<unsigned char> I; // Grey level image
// Declare a framegrabber able to read a sequence of successive
// images from the disk
// Set the path to the directory containing the sequence
g.setDirectory("/local/soft/ViSP/ViSP-images/cube");
// Set the image base name. The directory and the base name constitute
// the constant part of the full filename
g.setBaseName("image.");
// Set the step between two images of the sequence
g.setStep(2);
// Set the number of digits to build the image number
// Set the first frame number of the sequence
// Set the image file extension
g.setExtension("pgm");
// Open the framegrabber by loading the first image of the sequence
g.open(I) ;
unsigned int cpt = 1;
// this is the loop over the image sequence
while(cpt ++ < 10)
{
// read the image and then increment the image counter so that the next
// call to acquire(I) will get the next image
g.acquire(I) ;
}
}
Class to grab (ie. read) images from the disk.
void setStep(long step)
void setDirectory(const std::string &dir)
void setExtension(const std::string &ext)
void open(vpImage< unsigned char > &I)
void setImageNumber(long number)
void setNumberOfZero(unsigned int noz)
void setBaseName(const std::string &name)
void acquire(vpImage< unsigned char > &I)
Examples
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 103 of file vpDiskGrabber.h.

Constructor & Destructor Documentation

◆ vpDiskGrabber() [1/3]

vpDiskGrabber::vpDiskGrabber ( )

Default constructor.

Definition at line 36 of file vpDiskGrabber.cpp.

References vpFrameGrabber::init.

◆ vpDiskGrabber() [2/3]

vpDiskGrabber::vpDiskGrabber ( const std::string &  genericName)
explicit

Constructor that takes a generic image sequence as input.

Definition at line 44 of file vpDiskGrabber.cpp.

References vpFrameGrabber::init.

◆ ~vpDiskGrabber()

virtual vpDiskGrabber::~vpDiskGrabber ( )
inlinevirtual

Destructor. In fact nothing to destroy...

Definition at line 135 of file vpDiskGrabber.h.

◆ vpDiskGrabber() [3/3]

vpDiskGrabber::vpDiskGrabber ( const std::string &  dir,
const std::string &  basename,
long  number,
int  step,
unsigned int  noz,
const std::string &  ext 
)
explicit

Constructor.

Parameters
dir: Location of the image sequence.
basename: Base name of each image.
number: Initial image number.
step: Increment between two images.
noz: Number of zero to code the image number.
ext: Extension of the image file.

Definition at line 51 of file vpDiskGrabber.cpp.

References vpFrameGrabber::init.

Member Function Documentation

◆ acquire() [1/6]

void vpDiskGrabber::acquire ( vpImage< float > &  I)

Acquire an image reading the next image from the disk. After this call, the image number is incremented considering the step.

Parameters
I: The image read from a file.

Definition at line 151 of file vpDiskGrabber.cpp.

References vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpFrameGrabber::height, vpImageIo::readPFM(), and vpFrameGrabber::width.

◆ acquire() [2/6]

void vpDiskGrabber::acquire ( vpImage< float > &  I,
long  image_number 
)

Acquire an image reading the pfm image with number img_number from the disk. After this call, the image number is incremented considering the step.

Parameters
I: The image read from a file.
image_number: The number of the desired image.

Definition at line 217 of file vpDiskGrabber.cpp.

References vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpFrameGrabber::height, vpImageIo::readPFM(), and vpFrameGrabber::width.

◆ acquire() [3/6]

void vpDiskGrabber::acquire ( vpImage< unsigned char > &  I)
virtual

Acquire an image reading the next image from the disk. After this call, the image number is incremented considering the step.

Parameters
I: The image read from a file.

Implements vpFrameGrabber.

Examples
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 105 of file vpDiskGrabber.cpp.

References vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpFrameGrabber::height, vpImageIo::read(), and vpFrameGrabber::width.

Referenced by vpVideoReader::acquire(), vpVideoReader::getFrame(), and open().

◆ acquire() [4/6]

void vpDiskGrabber::acquire ( vpImage< unsigned char > &  I,
long  image_number 
)

Acquire an image reading the image with number img_number from the disk. After this call, the image number is incremented considering the step.

Parameters
I: The image read from a file.
image_number: The number of the desired image.

Definition at line 173 of file vpDiskGrabber.cpp.

References vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpFrameGrabber::height, vpImageIo::read(), and vpFrameGrabber::width.

◆ acquire() [5/6]

void vpDiskGrabber::acquire ( vpImage< vpRGBa > &  I)
virtual

Acquire an image reading the next image from the disk. After this call, the image number is incremented considering the step.

Parameters
I: The image read from a file.

Implements vpFrameGrabber.

Definition at line 128 of file vpDiskGrabber.cpp.

References vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpFrameGrabber::height, vpImageIo::read(), and vpFrameGrabber::width.

◆ acquire() [6/6]

void vpDiskGrabber::acquire ( vpImage< vpRGBa > &  I,
long  image_number 
)

Acquire an image reading the image with number img_number from the disk. After this call, the image number is incremented considering the step.

Parameters
I: The image read from a file.
image_number: The number of the desired image.

Definition at line 195 of file vpDiskGrabber.cpp.

References vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpFrameGrabber::height, vpImageIo::read(), and vpFrameGrabber::width.

◆ close()

void vpDiskGrabber::close ( )
inlinevirtual

Not useful.

Does nothing. Here for compatibility issue with the vpFrameGrabber class.

Implements vpFrameGrabber.

Definition at line 206 of file vpDiskGrabber.h.

◆ getHeight()

unsigned int vpFrameGrabber::getHeight ( ) const
inherited

Return the number of rows in the image.

Examples
AROgre.cpp, AROgreBasic.cpp, and testPylonGrabber.cpp.

Definition at line 37 of file vpFrameGrabber.cpp.

References vpFrameGrabber::height.

◆ getImageName()

std::string vpDiskGrabber::getImageName ( ) const
inline

Return the name of the file in which the last frame was read.

Definition at line 216 of file vpDiskGrabber.h.

Referenced by vpVideoReader::acquire().

◆ getImageNumber()

long vpDiskGrabber::getImageNumber ( ) const
inline

Return the current image number.

Examples
grabDisk.cpp.

Definition at line 211 of file vpDiskGrabber.h.

Referenced by vpVideoReader::acquire(), vpVideoReader::getFrame(), and open().

◆ getWidth()

unsigned int vpFrameGrabber::getWidth ( ) const
inherited

Return the number of columns in the image.

Examples
AROgre.cpp, AROgreBasic.cpp, and testPylonGrabber.cpp.

Definition at line 42 of file vpFrameGrabber.cpp.

References vpFrameGrabber::width.

◆ open() [1/3]

void vpDiskGrabber::open ( vpImage< float > &  I)

Read the first image of the sequence. The image number is not incremented.

Definition at line 89 of file vpDiskGrabber.cpp.

References acquire(), vpImage< Type >::getHeight(), getImageNumber(), vpImage< Type >::getWidth(), vpFrameGrabber::height, vpFrameGrabber::init, setImageNumber(), and vpFrameGrabber::width.

◆ open() [2/3]

void vpDiskGrabber::open ( vpImage< unsigned char > &  I)
virtual

Read the first image of the sequence. The image number is not incremented.

Implements vpFrameGrabber.

Examples
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 59 of file vpDiskGrabber.cpp.

References acquire(), vpImage< Type >::getHeight(), getImageNumber(), vpImage< Type >::getWidth(), vpFrameGrabber::height, vpFrameGrabber::init, setImageNumber(), and vpFrameGrabber::width.

◆ open() [3/3]

void vpDiskGrabber::open ( vpImage< vpRGBa > &  I)
virtual

Read the first image of the sequence. The image number is not incremented.

Implements vpFrameGrabber.

Definition at line 73 of file vpDiskGrabber.cpp.

References acquire(), vpImage< Type >::getHeight(), getImageNumber(), vpImage< Type >::getWidth(), vpFrameGrabber::height, vpFrameGrabber::init, setImageNumber(), and vpFrameGrabber::width.

◆ setBaseName()

void vpDiskGrabber::setBaseName ( const std::string &  name)
inline

Set the image base name.

Examples
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 239 of file vpDiskGrabber.h.

◆ setDirectory()

void vpDiskGrabber::setDirectory ( const std::string &  dir)
inline

Set the main directory name (ie location of the image sequence).

Examples
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 244 of file vpDiskGrabber.h.

◆ setExtension()

void vpDiskGrabber::setExtension ( const std::string &  ext)
inline

Set the image extension.

Examples
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 249 of file vpDiskGrabber.h.

◆ setGenericName()

void vpDiskGrabber::setGenericName ( const std::string &  genericName)

Set the image generic name like image-%04d.png.

Definition at line 245 of file vpDiskGrabber.cpp.

◆ setImageNumber()

void vpDiskGrabber::setImageNumber ( long  number)

Set the number of the image to be read.

Examples
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 239 of file vpDiskGrabber.cpp.

Referenced by vpVideoReader::acquire(), vpVideoReader::getFrame(), and open().

◆ setNumberOfZero()

void vpDiskGrabber::setNumberOfZero ( unsigned int  noz)
inline

Set the step between two images.

Examples
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 264 of file vpDiskGrabber.h.

◆ setStep()

void vpDiskGrabber::setStep ( long  step)
inline

Set the step between two images.

Examples
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 269 of file vpDiskGrabber.h.

Referenced by vpVideoReader::acquire().

Member Data Documentation

◆ height

◆ init

◆ width