Data Structures | Macros | Typedefs | Functions
rgbimageio.hh File Reference
#include <vector>
#include <mia/2d/defines2d.hh>
#include <mia/2d/vector.hh>
#include <mia/core/iodata.hh>
#include <mia/core/ioplugin.hh>
#include <mia/core/iohandler.hh>

Go to the source code of this file.

Data Structures

class  CRGB2DImage
 

Macros

#define mia_2drgbimageio_hh
 

Typedefs

typedef
C2DRGBImageIOPluginPluginHandler::Instance::DataKey 
C2DRGBImageDataKey
 The data key type for the CDatapool storage. More...
 
typedef mia::TIOPlugin
< CRGB2DImage
C2DRGBImageIOPlugin
 Base type for 2D RGB image IO plugins. More...
 
typedef mia::THandlerSingleton
< mia::TIOPluginHandler
< C2DRGBImageIOPlugin > > 
C2DRGBImageIOPluginPluginHandler
 The 2D RGB image plugin handler. More...
 
typedef CRGB2DImage::Pointer PRGB2DImage
 The shared pointer type of the image. More...
 

Functions

bool EXPORT_2D save_image (const std::string &filename, const CRGB2DImage &image)
 

Macro Definition Documentation

#define mia_2drgbimageio_hh

Definition at line 22 of file rgbimageio.hh.

Typedef Documentation

typedef mia::TIOPlugin<CRGB2DImage> C2DRGBImageIOPlugin

Base type for 2D RGB image IO plugins.

Definition at line 86 of file rgbimageio.hh.

The shared pointer type of the image.

Definition at line 83 of file rgbimageio.hh.

Function Documentation

bool EXPORT_2D save_image ( const std::string &  filename,
const CRGB2DImage image 
)

Save an RGB image to the file with the given file name. The type of the image file is determined by the filename extension.

Parameters
filename
imageimage to be saved
Returns
true if the image was saved successfully. If the saving failes, the function may also throw some exception providing an error message.