cartodata  5.1.2
Static Public Member Functions | List of all members
soma::VolumeUtilIO< T > Class Template Reference

#include <cartodata/io/volumeutilio.h>

Static Public Member Functions

static std::set< std::string > listReadProperties ()
 list of properties triggering partial reading and/or borders More...
 
static carto::Volume< T > * read (carto::Volume< T > *obj, carto::rc_ptr< DataSourceInfo > dsi, carto::Object options)
 Manages all the volumes necessary and returns the final Volume. More...
 
static carto::Volume< T > * readPartial (carto::Volume< T > *obj, carto::rc_ptr< DataSourceInfo > dsi, std::vector< int > position, std::vector< int > frame, std::vector< int > borders, carto::Object options)
 Worker for partial reading case. More...
 
static carto::Volume< T > * readFull (carto::Volume< T > *obj, carto::rc_ptr< DataSourceInfo > dsi, std::vector< int > borders, carto::Object options)
 Worker for full reading case. More...
 

Detailed Description

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

Definition at line 49 of file volumeutilio.h.

Member Function Documentation

◆ listReadProperties()

template<typename T >
std::set< std::string > soma::VolumeUtilIO< T >::listReadProperties
static

list of properties triggering partial reading and/or borders

Definition at line 61 of file volumeutilio_d.h.

Referenced by soma::VolumeFormatReader< T >::createAndRead(), soma::VolumeFormatReader< T >::setupAndRead(), and soma::VolumeRefFormatReader< T >::setupAndRead().

◆ read()

template<typename T >
carto::Volume< T > * soma::VolumeUtilIO< T >::read ( carto::Volume< T > *  obj,
carto::rc_ptr< DataSourceInfo >  dsi,
carto::Object  options 
)
static

Manages all the volumes necessary and returns the final Volume.

This method is called from VolumeFormatReader::createAndRead() or VolumeFormatReader::setupAndRead(). It reads all the parameters from options and removes them afterwards. It then performs necessary allocation and reading.

In setup case, use obj as a pointer to the Volume to setup. In create case, give a null pointer. The method then allocates and returns a new Volume.

Note
For now, no real setup is done : previous volume is replaced by a new one. It would be interesting to perform a real setup here but several cases have to be managed ( which volume is allocated, etc )

Definition at line 101 of file volumeutilio_d.h.

References localMsg.

Referenced by soma::VolumeFormatReader< T >::createAndRead(), and soma::VolumeFormatReader< T >::setupAndRead().

◆ readFull()

template<typename T >
carto::Volume< T > * soma::VolumeUtilIO< T >::readFull ( carto::Volume< T > *  obj,
carto::rc_ptr< DataSourceInfo >  dsi,
std::vector< int >  borders,
carto::Object  options 
)
static

Worker for full reading case.

Definition at line 206 of file volumeutilio_d.h.

References carto::Volume< T >::allocatorContext(), soma::DataSourceInfoLoader::check(), carto::PropertySet::getProperty(), carto::VolumeRef< T >::header(), carto::Headered::header(), localMsg, soma::Reader< class >::read(), soma::Reader< class >::setAllocatorContext(), soma::Reader< class >::setOptions(), carto::PropertySet::setProperty(), carto::toString(), and carto::Object::value().

◆ readPartial()

template<typename T >
carto::Volume< T > * soma::VolumeUtilIO< T >::readPartial ( carto::Volume< T > *  obj,
carto::rc_ptr< DataSourceInfo >  dsi,
std::vector< int >  position,
std::vector< int >  frame,
std::vector< int >  borders,
carto::Object  options 
)
static

Worker for partial reading case.

Definition at line 334 of file volumeutilio_d.h.

References carto::Volume< T >::at(), carto::Headered::blockSignals(), carto::DictionaryInterface::copyProperties(), soma::Reader< class >::dataSourceInfo(), carto::PropertySet::getProperty(), carto::VolumeRef< T >::getSize(), carto::Volume< T >::getStrides(), carto::VolumeRef< T >::header(), carto::Headered::header(), localMsg, carto::max(), soma::Reader< class >::read(), soma::Reader< class >::setOptions(), carto::PropertySet::setProperty(), carto::toString(), and carto::Object::value().

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