YARP  2.3.70.1
Yet Another Robot Platform
yarp::sig::file Namespace Reference

Image file operations. More...

Classes

class  soundStreamReader
 

Enumerations

enum  {
  FORMAT_NULL,
  FORMAT_ANY,
  FORMAT_PGM,
  FORMAT_PPM,
  FORMAT_NUMERIC
}
 

Functions

bool read (ImageOf< PixelRgb > &dest, const yarp::os::ConstString &src)
 
bool read (ImageOf< PixelBgr > &dest, const yarp::os::ConstString &src)
 
bool read (ImageOf< PixelRgba > &dest, const yarp::os::ConstString &src)
 
bool read (ImageOf< PixelMono > &dest, const yarp::os::ConstString &src)
 
bool read (ImageOf< PixelFloat > &dest, const yarp::os::ConstString &src)
 
bool write (const ImageOf< PixelRgb > &src, const yarp::os::ConstString &dest)
 
bool write (const ImageOf< PixelBgr > &src, const yarp::os::ConstString &dest)
 
bool write (const ImageOf< PixelRgba > &src, const yarp::os::ConstString &dest)
 
bool write (const ImageOf< PixelMono > &src, const yarp::os::ConstString &dest)
 
bool write (const ImageOf< PixelFloat > &src, const yarp::os::ConstString &dest)
 
bool write (const Image &src, const yarp::os::ConstString &dest)
 
bool read (Sound &dest, const char *src)
 Read a sound from file. More...
 
bool write (const Sound &src, const char *dest)
 Write a sound to file. More...
 

Detailed Description

Image file operations.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
FORMAT_NULL 
FORMAT_ANY 
FORMAT_PGM 
FORMAT_PPM 
FORMAT_NUMERIC 

Definition at line 22 of file ImageFile.h.

Function Documentation

◆ read() [1/6]

bool yarp::sig::file::read ( Sound dest,
const char *  src 
)

Read a sound from file.

Parameters
destsound to read
srcname of file (should be a WAV file)
Returns
true on success

Definition at line 143 of file SoundFile.cpp.

◆ read() [2/6]

bool yarp::sig::file::read ( ImageOf< PixelRgb > &  dest,
const yarp::os::ConstString src 
)
Examples:
cuda/cuda_gpu.cpp, and dev/file_grabber.cpp.

Definition at line 389 of file ImageFile.cpp.

◆ read() [3/6]

bool yarp::sig::file::read ( ImageOf< PixelBgr > &  dest,
const yarp::os::ConstString src 
)

Definition at line 395 of file ImageFile.cpp.

◆ read() [4/6]

bool yarp::sig::file::read ( ImageOf< PixelRgba > &  dest,
const yarp::os::ConstString src 
)

Definition at line 401 of file ImageFile.cpp.

◆ read() [5/6]

bool yarp::sig::file::read ( ImageOf< PixelMono > &  dest,
const yarp::os::ConstString src 
)

Definition at line 432 of file ImageFile.cpp.

◆ read() [6/6]

bool yarp::sig::file::read ( ImageOf< PixelFloat > &  dest,
const yarp::os::ConstString src 
)

Definition at line 44 of file ImageFile.cpp.

◆ write() [1/7]

bool yarp::sig::file::write ( const Sound src,
const char *  dest 
)

Write a sound to file.

Parameters
srcsound to write
destname of file (will be a WAV file)
Returns
true on success

Definition at line 187 of file SoundFile.cpp.

◆ write() [2/7]

bool yarp::sig::file::write ( const ImageOf< PixelRgb > &  src,
const yarp::os::ConstString dest 
)
Examples:
opencv/main.cpp.

Definition at line 412 of file ImageFile.cpp.

◆ write() [3/7]

bool yarp::sig::file::write ( const ImageOf< PixelBgr > &  src,
const yarp::os::ConstString dest 
)

Definition at line 418 of file ImageFile.cpp.

◆ write() [4/7]

bool yarp::sig::file::write ( const ImageOf< PixelRgba > &  src,
const yarp::os::ConstString dest 
)

Definition at line 424 of file ImageFile.cpp.

◆ write() [5/7]

bool yarp::sig::file::write ( const ImageOf< PixelMono > &  src,
const yarp::os::ConstString dest 
)

Definition at line 438 of file ImageFile.cpp.

◆ write() [6/7]

bool yarp::sig::file::write ( const ImageOf< PixelFloat > &  src,
const yarp::os::ConstString dest 
)

Definition at line 26 of file ImageFile.cpp.

◆ write() [7/7]

bool yarp::sig::file::write ( const Image src,
const yarp::os::ConstString dest 
)

Definition at line 444 of file ImageFile.cpp.