Public Types | Public Member Functions | Static Public Member Functions

DGtal::VolWriter< TImage, TColormap > Struct Template Reference

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

#include <VolWriter.h>

Public Types

typedef TImage Image
typedef TImage::ValueType ValueType
typedef TColormap Colormap

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CColorMap< TColormap >))
 BOOST_STATIC_ASSERT (TImage::Domain::staticDimension==3)
 BOOST_STATIC_ASSERT ((boost::is_same< typename TColormap::ValueType, typename TImage::ValueType >::value))

Static Public Member Functions

static bool exportVol (const std::string &filename, const Image &aImage, const ValueType &minV, const ValueType &maxV)

Detailed Description

template<typename TImage, typename TColormap>
struct DGtal::VolWriter< TImage, TColormap >

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

Description of template struct 'VolWriter'

Template Parameters:
TImage the Image type.
TColormap the type of the colormap to use in the export.

Member Typedef Documentation

template<typename TImage , typename TColormap >
typedef TColormap DGtal::VolWriter< TImage, TColormap >::Colormap
template<typename TImage , typename TColormap >
typedef TImage DGtal::VolWriter< TImage, TColormap >::Image
template<typename TImage , typename TColormap >
typedef TImage::ValueType DGtal::VolWriter< TImage, TColormap >::ValueType

Member Function Documentation

template<typename TImage , typename TColormap >
DGtal::VolWriter< TImage, TColormap >::BOOST_CONCEPT_ASSERT ( (CColorMap< TColormap >)   ) 
template<typename TImage , typename TColormap >
DGtal::VolWriter< TImage, TColormap >::BOOST_STATIC_ASSERT ( TImage::Domain::staticDimension  = =3  ) 
template<typename TImage , typename TColormap >
DGtal::VolWriter< TImage, TColormap >::BOOST_STATIC_ASSERT ( (boost::is_same< typename TColormap::ValueType, typename TImage::ValueType >::value)   ) 
template<typename TImage , typename TColormap >
static bool DGtal::VolWriter< TImage, TColormap >::exportVol ( const std::string &  filename,
const Image aImage,
const ValueType minV,
const ValueType maxV 
) [static]

Export an Image with the Vol format.

Parameters:
filename name of the output file
aImage the image to export
minV the minimum value of aImage (for colormap)
maxV the maximum value of aImage (for colormap)
Returns:
true if no errors occur.

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