DGtal::GenericWriter< TContainer, Tdim, TValue, TFunctor > Struct Template Reference

Aim: Provide a mechanism to save image (2D or 3D) into file with the best saver loader according to an filename (by parsing the extension). More...

#include <DGtal/io/writers/GenericWriter.h>

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CConstImage< TContainer >))

Static Public Member Functions
static bool	exportFile (const std::string &filename, const TContainer &anImage, const TFunctor &aFunctor=TFunctor())

Detailed Description

template<typename TContainer, int Tdim = TContainer::Point::dimension, typename TValue = typename TContainer::Value, typename TFunctor = functors::Identity>
struct DGtal::GenericWriter< TContainer, Tdim, TValue, TFunctor >

Aim: Provide a mechanism to save image (2D or 3D) into file with the best saver loader according to an filename (by parsing the extension).

Description of template class 'GenericWriter'

The typical use is very simple:

• First include the header of the generic reader (and StdDefs) and define image type:

  #include "DGTal/io/readers/GenericWriter.h"
  #include "DGtal/helpers/StdDefs.h"
  typedef DGtal::ImageContainerBySTLMap<DGtal::Z3i::Domain, unsigned char> Image3D;
  typedef DGtal::ImageContainerBySTLMap<DGtal::Z2i::Domain, unsigned char> Image2D;

• After contructing and filling an image (anImage2D or anImage3D), just save it with:

  anImage3D >> "aFilename.pgm3d";
  anImage3D >> "aFilename.vol";
  anImage2D >> "aFilename.pgm";

  Note

  the stream operator hide a default functor (c++ cast to a given type) and if the user want to control the cast he can used the exportFile function (see below).

  Template Parameters

  TContainer	the container (mainly an ImageContainer like ImageContainerBySTLVector or ImageContainerBySTLMap).
  Tdim	the dimension of the container (by default given by the container).
  TValue	the value type of data contained in the image (by default given by the container)
  TFunctor	a functor type to apply image transformation before saving the image (by default set to functors::Identity).

Definition at line 94 of file GenericWriter.h.

Member Function Documentation

BOOST_CONCEPT_ASSERT()

template<typename TContainer , int Tdim = TContainer::Point::dimension, typename TValue = typename TContainer::Value, typename TFunctor = functors::Identity>

DGtal::GenericWriter< TContainer, Tdim, TValue, TFunctor >::BOOST_CONCEPT_ASSERT

(

(concepts::CConstImage< TContainer >)

)

exportFile()

template<typename TContainer , int Tdim = TContainer::Point::dimension, typename TValue = typename TContainer::Value, typename TFunctor = functors::Identity>

static bool DGtal::GenericWriter< TContainer, Tdim, TValue, TFunctor >::exportFile ( const std::string &  filename, const TContainer &  anImage, const TFunctor &  aFunctor = TFunctor()  )

static

Export an image.

Parameters

filename	the filename of the saved image (with a extension name).
anImage	the image to be saved.
aFunctor	to apply image transformation before saving.

Referenced by DGtal::Shortcuts< TKSpace >::saveGrayScaleImage(), and testGenericWriter().

---

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

• GenericWriter.h