DGtal  0.9.4beta
Public Types | Public Member Functions | Static Public Member Functions
DGtal::VolWriter< TImage, TFunctor > Struct Template Reference

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

Public Types

typedef TImage Image
 
typedef TImage::Value Value
 
typedef TFunctor Functor
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CUnaryFunctor< TFunctor, Value, unsigned char >))
 
 BOOST_STATIC_ASSERT (TImage::Domain::dimension==3)
 

Static Public Member Functions

static bool exportVol (const std::string &filename, const Image &aImage, const bool compressed=true, const Functor &aFunctor=Functor()) throw (DGtal::IOException)
 

Detailed Description

template<typename TImage, typename TFunctor = functors::Identity>
struct DGtal::VolWriter< TImage, TFunctor >

Aim: Export a 3D Image using the Vol formats.

Description of template struct 'VolWriter'

A functor can be specified to convert image values to Vol values (unsigned char).

Template Parameters
TImagethe Image type.
TFunctorthe type of functor used in the export.
Examples:
images/raw2HDF5.cpp, tutorial-examples/FMMErosion.cpp, and tutorial-examples/volDTGranulo.cpp.

Definition at line 68 of file VolWriter.h.

Member Typedef Documentation

template<typename TImage, typename TFunctor = functors::Identity>
typedef TFunctor DGtal::VolWriter< TImage, TFunctor >::Functor

Definition at line 73 of file VolWriter.h.

template<typename TImage, typename TFunctor = functors::Identity>
typedef TImage DGtal::VolWriter< TImage, TFunctor >::Image

Definition at line 71 of file VolWriter.h.

template<typename TImage, typename TFunctor = functors::Identity>
typedef TImage::Value DGtal::VolWriter< TImage, TFunctor >::Value

Definition at line 72 of file VolWriter.h.

Member Function Documentation

template<typename TImage, typename TFunctor = functors::Identity>
DGtal::VolWriter< TImage, TFunctor >::BOOST_CONCEPT_ASSERT ( (concepts::CUnaryFunctor< TFunctor, Value, unsigned char >)  )
template<typename TImage, typename TFunctor = functors::Identity>
DGtal::VolWriter< TImage, TFunctor >::BOOST_STATIC_ASSERT ( TImage::Domain::dimension  = =3)
template<typename TImage, typename TFunctor = functors::Identity>
static bool DGtal::VolWriter< TImage, TFunctor >::exportVol ( const std::string &  filename,
const Image aImage,
const bool  compressed = true,
const Functor aFunctor = Functor() 
)
throw (DGtal::IOException
)
static

Export an Image with the Vol format.

Parameters
filenamename of the output file
aImagethe image to export
compressedboolean to decide wether the vol must be compressed or not
aFunctorfunctor used to cast image values
Returns
true if no errors occur.

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