iRoCS Toolbox  1.1.0
Static Public Member Functions
BlitzImageReader Class Reference

Class that loads data from various image formats to blitz arrays. More...

#include <BlitzImageReader.hh>

Collaboration diagram for BlitzImageReader:

Static Public Member Functions

static int readPNG (blitz::Array< unsigned char, 3 > &data, const std::string &fileName)
 Reads a png image into a blitz dataset, in this case a 3D unsigned char image storage order is: colorlayer(r,g,b), y, x Gray images just have extent 1 in the first dimension. More...
 
static int readPNG (blitz::Array< blitz::TinyVector< unsigned char, 3 >, 2 > &data, const std::string &fileName)
 Reads a png image into a blitz dataset, in this case a 2D array with vectorial data (rgb) More...
 
static int readPNG (ImageAccessWrapper &data, const std::string &fileName)
 Reads a png image into a blitz dataset, in this case the wrapped version: in this function, the real processing is done. More...
 
static int readPNM (blitz::Array< unsigned char, 3 > &data, const std::string &fileName)
 Reads a pnm image into a blitz dataset, in this case a 3D unsigned char image. More...
 
static int readPNM (blitz::Array< blitz::TinyVector< unsigned char, 3 >, 2 > &data, const std::string &fileName)
 Reads a pnm image into a blitz dataset, in this case a 2D array with vectorial data (rgb). More...
 
static int readPNM (ImageAccessWrapper &data, const std::string &fileName)
 Reads a pnm image into a blitz dataset, in this case the wrapped version: in this function, the real processing is done. More...
 

Detailed Description

Class that loads data from various image formats to blitz arrays.

Definition at line 70 of file BlitzImageReader.hh.

Member Function Documentation

◆ readPNG() [1/3]

static int BlitzImageReader::readPNG ( blitz::Array< unsigned char, 3 > &  data,
const std::string &  fileName 
)
static

Reads a png image into a blitz dataset, in this case a 3D unsigned char image storage order is: colorlayer(r,g,b), y, x Gray images just have extent 1 in the first dimension.

Parameters
datadata Array where the data should be read in
fileNamename of the png file
Returns
int returns 0 if ok, -1 if something went wrong
Note
the data is just wrapped and the general function version is called

◆ readPNG() [2/3]

static int BlitzImageReader::readPNG ( blitz::Array< blitz::TinyVector< unsigned char, 3 >, 2 > &  data,
const std::string &  fileName 
)
static

Reads a png image into a blitz dataset, in this case a 2D array with vectorial data (rgb)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
datadata Array where the data should be read in
fileNamename of the png file
Returns
int returns 0 if ok, -1 if something went wrong
Note
the data is just wrapped and the general function version is called

◆ readPNG() [3/3]

static int BlitzImageReader::readPNG ( ImageAccessWrapper data,
const std::string &  fileName 
)
static

Reads a png image into a blitz dataset, in this case the wrapped version: in this function, the real processing is done.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
datadata Array where the data should be read in
fileNamename of the png file
Returns
int returns 0 if ok, -1 if something went wrong

◆ readPNM() [1/3]

static int BlitzImageReader::readPNM ( blitz::Array< unsigned char, 3 > &  data,
const std::string &  fileName 
)
static

Reads a pnm image into a blitz dataset, in this case a 3D unsigned char image.

pnm is a meta format applying to pbm, pgm and ppm. The actual file type is determined from the magic number and the file accordingly processed. storage order is: colorlayer(r,g,b), y, x Gray images just have extent 1 in the first dimension

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
datadata Array where the data should be read in
fileNamename of the pnm file
Returns
int returns 0 if ok, -1 if something went wrong
Note
the data is just wrapped and the general function version is called

◆ readPNM() [2/3]

static int BlitzImageReader::readPNM ( blitz::Array< blitz::TinyVector< unsigned char, 3 >, 2 > &  data,
const std::string &  fileName 
)
static

Reads a pnm image into a blitz dataset, in this case a 2D array with vectorial data (rgb).

pnm is a meta format applying to pbm, pgm and ppm. The actual file type is determined from the magic number and the file accordingly processed.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
datadata Array where the data should be read in
fileNamename of the pnm file
Returns
int returns 0 if ok, -1 if something went wrong
Note
the data is just wrapped and the general function version is called

◆ readPNM() [3/3]

static int BlitzImageReader::readPNM ( ImageAccessWrapper data,
const std::string &  fileName 
)
static

Reads a pnm image into a blitz dataset, in this case the wrapped version: in this function, the real processing is done.

pnm is a meta format applying to pbm, pgm and ppm. The actual file type is determined from the magic number and the file accordingly processed.

Parameters
datadata Array where the data should be read in
fileNamename of the pnm file
Returns
int returns 0 if ok, -1 if something went wrong

The documentation for this class was generated from the following file: