Visual Servoing Platform  version 3.2.0 under development (2018-12-17)
vpDiskGrabber Class Reference

#include <visp3/io/vpDiskGrabber.h>

+ Inheritance diagram for vpDiskGrabber:

Public Member Functions

 vpDiskGrabber ()
 
 vpDiskGrabber (const std::string &genericName)
 
 vpDiskGrabber (const std::string &dir, const std::string &basename, long number, int step, unsigned int noz, const std::string &ext)
 
virtual ~vpDiskGrabber ()
 
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 ()
 
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)
 
Inherited functionalities from vpFramegrabber
unsigned int getHeight () const
 
unsigned int getWidth () const
 

Public Attributes

bool init
 

Protected Attributes

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) ;
}
}
Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 108 of file vpDiskGrabber.h.

Constructor & Destructor Documentation

vpDiskGrabber::vpDiskGrabber ( )

Elementary constructor.

Definition at line 44 of file vpDiskGrabber.cpp.

References vpFrameGrabber::init.

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

Constructor that takes a generic image sequence as input.

Definition at line 54 of file vpDiskGrabber.cpp.

References vpFrameGrabber::init.

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 72 of file vpDiskGrabber.cpp.

References vpFrameGrabber::init.

vpDiskGrabber::~vpDiskGrabber ( )
virtual

Destructor

In fact nothing to destroy...

Definition at line 319 of file vpDiskGrabber.cpp.

Member Function Documentation

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 144 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().

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 171 of file vpDiskGrabber.cpp.

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

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

Acquire an image reading the next pfm 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 199 of file vpDiskGrabber.cpp.

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

void vpDiskGrabber::acquire ( vpImage< unsigned char > &  I,
long  img_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.
img_number: The number of the desired image.

Definition at line 227 of file vpDiskGrabber.cpp.

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

void vpDiskGrabber::acquire ( vpImage< vpRGBa > &  I,
long  img_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.
img_number: The number of the desired image.

Definition at line 255 of file vpDiskGrabber.cpp.

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

void vpDiskGrabber::acquire ( vpImage< float > &  I,
long  img_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.
img_number: The number of the desired image.

Definition at line 283 of file vpDiskGrabber.cpp.

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

void vpDiskGrabber::close ( )
virtual

Not useful.

Here for compatibility issue with the vpFrameGrabber class.

Implements vpFrameGrabber.

Definition at line 309 of file vpDiskGrabber.cpp.

unsigned int vpFrameGrabber::getHeight ( ) const
inlineinherited

Return the number of rows in the image.

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

Definition at line 114 of file vpFrameGrabber.h.

long vpDiskGrabber::getImageNumber ( )
inline

Return the current image number.

Definition at line 143 of file vpDiskGrabber.h.

References vpFrameGrabber::open().

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

unsigned int vpFrameGrabber::getWidth ( ) const
inlineinherited

Return the number of columns in the image.

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

Definition at line 116 of file vpFrameGrabber.h.

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 84 of file vpDiskGrabber.cpp.

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

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 102 of file vpDiskGrabber.cpp.

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

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

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

Definition at line 122 of file vpDiskGrabber.cpp.

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

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

Set the image base name.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 329 of file vpDiskGrabber.cpp.

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

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

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 324 of file vpDiskGrabber.cpp.

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

Set the image extension.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 334 of file vpDiskGrabber.cpp.

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

Definition at line 354 of file vpDiskGrabber.cpp.

Referenced by vpVideoReader::setFileName().

void vpDiskGrabber::setImageNumber ( long  number)

Set the number of the image to be read.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 339 of file vpDiskGrabber.cpp.

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

void vpDiskGrabber::setNumberOfZero ( unsigned int  noz)

Set the step between two images.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 352 of file vpDiskGrabber.cpp.

void vpDiskGrabber::setStep ( long  step)

Set the step between two images.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 348 of file vpDiskGrabber.cpp.

Referenced by vpVideoReader::acquire(), and vpVideoReader::setFileName().

Member Data Documentation