cartodata  5.0.5
soma::VolumeFormatWriter< T > Class Template Reference

FormatWriter specialized for 4D Volume. More...

#include <cartodata/io/volumeformatwriter.h>

Inheritance diagram for soma::VolumeFormatWriter< T >:
Collaboration diagram for soma::VolumeFormatWriter< T >:

Public Member Functions

virtual ~VolumeFormatWriter ()
 
virtual bool filterProperties (carto::Object header, carto::Object options=carto::none())
 FormatWriter derived function It removes properties that must not be written. More...
 
virtual bool write (const carto::Volume< T > &obj, carto::rc_ptr< DataSourceInfo > dsi, carto::Object options)
 FormatWriter derived function This method understands a volume and calls appropriate ImageWriter methods. More...
 
void attach (carto::rc_ptr< ImageWriter< T > > imw)
 Linking to a ImageWriter Allows us to declare only once the ImageWriter. More...
 
- Public Member Functions inherited from soma::FormatWriter< carto::Volume< T > >
virtual ~FormatWriter ()
 

Protected Attributes

carto::rc_ptr< ImageWriter< T > > _imw
 

Detailed Description

template<typename T>
class soma::VolumeFormatWriter< T >

FormatWriter specialized for 4D Volume.

A such VolumeFormatWriter needs to be linked to a specialized ImageWriter before being registered into a FormatDictionary.
It understands the Volume and detects specific cases (borders, partial reading, ...) before performing the writing through its linked ImageWriter.
Options may be given through the filename, at creation of the Reader.

See also
Reader FileUtil
Note
Options currently available are :
  • (bool) partial_writing : if view should be partially written into an existing full volume.
  • (bool) byte_swapping : if data should be byte swapped (GIS).
  • (bool) ascii : if data should be written in ASCII (GIS).
  • (int) ox, oy, oz, ot : top left position of partial frame in the output file.

Definition at line 78 of file volumeformatwriter.h.

Constructor & Destructor Documentation

◆ ~VolumeFormatWriter()

template<typename T >
soma::VolumeFormatWriter< T >::~VolumeFormatWriter ( )
virtual

Definition at line 69 of file volumeformatwriter_d.h.

Member Function Documentation

◆ attach()

template<typename T >
void soma::VolumeFormatWriter< T >::attach ( carto::rc_ptr< ImageWriter< T > >  imw)

Linking to a ImageWriter Allows us to declare only once the ImageWriter.

Definition at line 348 of file volumeformatwriter_d.h.

Referenced by soma::VolumeRefFormatWriter< T >::write().

◆ filterProperties()

template<typename T >
bool soma::VolumeFormatWriter< T >::filterProperties ( carto::Object  header,
carto::Object  options = carto::none() 
)
virtual

FormatWriter derived function It removes properties that must not be written.

Implements soma::FormatWriter< carto::Volume< T > >.

Definition at line 77 of file volumeformatwriter_d.h.

References soma::MinfUtil::filter().

◆ write()

Member Data Documentation

◆ _imw

template<typename T>
carto::rc_ptr<ImageWriter<T> > soma::VolumeFormatWriter< T >::_imw
protected

Definition at line 100 of file volumeformatwriter.h.


The documentation for this class was generated from the following files: