Visual Servoing Platform  version 3.0.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Public Attributes | Protected Attributes | List of all members
vpDiskGrabber Class Reference
Video I/O

#include <visp3/io/vpDiskGrabber.h>

+ Inheritance diagram for vpDiskGrabber:

Public Member Functions

 vpDiskGrabber ()
 
 vpDiskGrabber (const char *genericName)
 
 vpDiskGrabber (const char *dir, const char *basename, long number, int step, unsigned int noz, const char *ext)
 
virtual ~vpDiskGrabber ()
 
void open (vpImage< unsigned char > &I)
 
void open (vpImage< vpRGBa > &I)
 
void open (vpImage< float > &I)
 
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 ()
 
void setDirectory (const char *dir)
 
void setBaseName (const char *name)
 
void setImageNumber (long number)
 
void setStep (int a)
 
void setNumberOfZero (unsigned int noz)
 
void setExtension (const char *ext)
 
void setGenericName (const char *genericName)
 
long getImageNumber ()
 
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
vpDiskGrabber g;
// 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
g.setNumberOfZero(4);
// Set the first frame number of the sequence
g.setImageNumber(1);
// 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 106 of file vpDiskGrabber.h.

Constructor & Destructor Documentation

vpDiskGrabber::vpDiskGrabber ( )

Elementary constructor.

Definition at line 45 of file vpDiskGrabber.cpp.

References vpFrameGrabber::init, setBaseName(), setDirectory(), and setExtension().

vpDiskGrabber::vpDiskGrabber ( const char *  genericName)

Definition at line 56 of file vpDiskGrabber.cpp.

References vpFrameGrabber::init, vpException::memoryAllocationError, setBaseName(), setDirectory(), and setExtension().

vpDiskGrabber::vpDiskGrabber ( const char *  dir,
const char *  basename,
long  number,
int  step,
unsigned int  noz,
const char *  ext 
)

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

References vpFrameGrabber::init, setBaseName(), setDirectory(), and setExtension().

vpDiskGrabber::~vpDiskGrabber ( )
virtual

Destructor

In fact nothing to destroy...

Definition at line 342 of file vpDiskGrabber.cpp.

Member Function Documentation

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

Acquire an image: read a pgm image from the disk. After this call, the image number is incremented considering the step.

Parameters
Ithe read image

Implements vpFrameGrabber.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 168 of file vpDiskGrabber.cpp.

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

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

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

Acquire an image: read a ppm image from the disk. After this call, the image number is incremented considering the step.

Parameters
Ithe read image

Implements vpFrameGrabber.

Definition at line 195 of file vpDiskGrabber.cpp.

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

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

Acquire an image: read a pfm image from the disk. After this call, the image number is incremented considering the step.

Parameters
Ithe read image

Definition at line 223 of file vpDiskGrabber.cpp.

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

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

Acquire an image: read a pgm image 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 252 of file vpDiskGrabber.cpp.

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

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

Acquire an image: read a ppm image 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 278 of file vpDiskGrabber.cpp.

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

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

Acquire an image: read a pfm image 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 306 of file vpDiskGrabber.cpp.

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

void vpDiskGrabber::close ( )
virtual

Not useful

Here for compatibility issue with the vpFrameGrabber class

Implements vpFrameGrabber.

Definition at line 331 of file vpDiskGrabber.cpp.

unsigned int vpFrameGrabber::getHeight ( ) const
inlineinherited

Return the number of rows in the image.

Examples:
AROgre.cpp, and AROgreBasic.cpp.

Definition at line 115 of file vpFrameGrabber.h.

long vpDiskGrabber::getImageNumber ( )
inline

Return the current image number.

Definition at line 152 of file vpDiskGrabber.h.

Referenced by open().

unsigned int vpFrameGrabber::getWidth ( ) const
inlineinherited

Return the number of columns in the image.

Examples:
AROgre.cpp, and AROgreBasic.cpp.

Definition at line 117 of file vpFrameGrabber.h.

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

Implements vpFrameGrabber.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 99 of file vpDiskGrabber.cpp.

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

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

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

Implements vpFrameGrabber.

Definition at line 121 of file vpDiskGrabber.cpp.

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

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

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

Definition at line 144 of file vpDiskGrabber.cpp.

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

void vpDiskGrabber::setBaseName ( const char *  name)

Set the image base name.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 360 of file vpDiskGrabber.cpp.

Referenced by vpDiskGrabber().

void vpDiskGrabber::setDirectory ( const char *  dir)

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

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 351 of file vpDiskGrabber.cpp.

Referenced by vpDiskGrabber().

void vpDiskGrabber::setExtension ( const char *  ext)

Set the image extension.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 369 of file vpDiskGrabber.cpp.

Referenced by vpDiskGrabber().

void vpDiskGrabber::setGenericName ( const char *  genericName)

Definition at line 403 of file vpDiskGrabber.cpp.

References vpException::memoryAllocationError.

Referenced by vpVideoReader::open().

void vpDiskGrabber::setImageNumber ( long  number)

Set the number of the image to be read.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 378 of file vpDiskGrabber.cpp.

References vpDEBUG_TRACE.

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

void vpDiskGrabber::setNumberOfZero ( unsigned int  noz)

Set the step between two images.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 397 of file vpDiskGrabber.cpp.

void vpDiskGrabber::setStep ( int  step)

Set the step between two images.

Examples:
grabDisk.cpp, and manGrabDisk.cpp.

Definition at line 389 of file vpDiskGrabber.cpp.

Member Data Documentation

unsigned int vpFrameGrabber::height
protectedinherited

Number of rows in the image.

Definition at line 108 of file vpFrameGrabber.h.

Referenced by acquire(), vpFlyCaptureGrabber::acquire(), vpV4l2Grabber::acquire(), vp1394TwoGrabber::acquire(), vp1394TwoGrabber::dequeue(), vp1394TwoGrabber::getHeight(), open(), vpV4l2Grabber::open(), vp1394CMUGrabber::open(), vpVideoReader::open(), vp1394TwoGrabber::setFormat7ROI(), vp1394CMUGrabber::setVideoMode(), vp1394TwoGrabber::setVideoMode(), vp1394CMUGrabber::vp1394CMUGrabber(), and vp1394TwoGrabber::vp1394TwoGrabber().

bool vpFrameGrabber::init
inherited

Set to true if the frame grabber has been initialized.

Definition at line 105 of file vpFrameGrabber.h.

Referenced by vpV4l2Grabber::acquire(), vp1394CMUGrabber::close(), vp1394TwoGrabber::close(), vpFlyCaptureGrabber::connect(), vpFlyCaptureGrabber::disconnect(), open(), vpV4l2Grabber::open(), vp1394TwoGrabber::resetBus(), vpFlyCaptureGrabber::startCapture(), vpFlyCaptureGrabber::stopCapture(), vp1394CMUGrabber::vp1394CMUGrabber(), vp1394TwoGrabber::vp1394TwoGrabber(), vpDiskGrabber(), and vpV4l2Grabber::vpV4l2Grabber().

unsigned int vpFrameGrabber::width
protectedinherited

Number of columns in the image.

Definition at line 109 of file vpFrameGrabber.h.

Referenced by acquire(), vpFlyCaptureGrabber::acquire(), vpV4l2Grabber::acquire(), vp1394TwoGrabber::acquire(), vp1394TwoGrabber::dequeue(), vp1394TwoGrabber::getWidth(), open(), vpV4l2Grabber::open(), vp1394CMUGrabber::open(), vpVideoReader::open(), vp1394TwoGrabber::setFormat7ROI(), vp1394CMUGrabber::setVideoMode(), vp1394TwoGrabber::setVideoMode(), vp1394CMUGrabber::vp1394CMUGrabber(), and vp1394TwoGrabber::vp1394TwoGrabber().