DGtal::HDF5Writer< TImage, TFunctor > Struct Template Reference

Aim: Export an Image with the HDF5 format. More...

#include <DGtal/io/writers/HDF5Writer.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	exportHDF5_3D (const std::string &filename, const Image &aImage, const std::string &aDataset, const Functor &aFunctor=Functor())

Detailed Description

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

Aim: Export an Image with the HDF5 format.

Description of template struct 'HDF5Writer'

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

Template Parameters

TImage	the Image type.
TFunctor	the type of functor used in the export.

Definition at line 68 of file HDF5Writer.h.

Member Typedef Documentation

Functor

template<typename TImage , typename TFunctor = functors::Identity>

typedef TFunctor DGtal::HDF5Writer< TImage, TFunctor >::Functor

Definition at line 73 of file HDF5Writer.h.

Image

template<typename TImage , typename TFunctor = functors::Identity>

typedef TImage DGtal::HDF5Writer< TImage, TFunctor >::Image

Definition at line 71 of file HDF5Writer.h.

Value

template<typename TImage , typename TFunctor = functors::Identity>

typedef TImage::Value DGtal::HDF5Writer< TImage, TFunctor >::Value

Definition at line 72 of file HDF5Writer.h.

Member Function Documentation

BOOST_CONCEPT_ASSERT()

template<typename TImage , typename TFunctor = functors::Identity>

DGtal::HDF5Writer< TImage, TFunctor >::BOOST_CONCEPT_ASSERT

(

(concepts::CUnaryFunctor< TFunctor, Value, unsigned char >)

)

BOOST_STATIC_ASSERT()

template<typename TImage , typename TFunctor = functors::Identity>

DGtal::HDF5Writer< TImage, TFunctor >::BOOST_STATIC_ASSERT

(

TImage::Domain::dimension

= =3

)

exportHDF5_3D()

template<typename TImage , typename TFunctor = functors::Identity>

static bool DGtal::HDF5Writer< TImage, TFunctor >::exportHDF5_3D ( const std::string &  filename, const Image &  aImage, const std::string &  aDataset, const Functor &  aFunctor = Functor()  )

static

Export a 3D UInt8 HDF5 output file with ZLIB compression activated.

Parameters

filename	name of the output file
aImage	the image to export
aDataset	the dataset name to export.
aFunctor	functor used to cast image values

Returns

true if no errors occur.

---

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

• HDF5Writer.h