FormatReader specialized for 4D Volume. More...
#include <cartodata/io/volumeformatreader.h>
Public Member Functions | |
| virtual | ~VolumeFormatReader () |
| virtual void | read (carto::Volume< T > &obj, carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext &context, carto::Object options=carto::none()) |
| FormatReader derived function This method understands a volume and calls read( buffer ) with appropriate arguments. More... | |
| void | attach (carto::rc_ptr< ImageReader< T > > imr) |
| Linking to a ImageReader Allows us to declare only once the ImageReader. More... | |
| virtual Volume< T > * | createAndRead (carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext &context, carto::Object options) |
| Factory mode: creates an object and reads it. More... | |
| virtual void | setupAndRead (Volume< T > &obj, carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext &context, carto::Object options) |
| Full reading procedure, for an already existing object. More... | |
| virtual FormatReader< carto::Volume< T > > * | clone () const |
| virtual std::string | formatID () const |
 Public Member Functions inherited from soma::FormatReader< carto::Volume< T > > | |
| virtual | ~FormatReader () |
| virtual void | setupAndRead (carto::Volume< T > &obj, carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext &context, carto::Object options) |
| virtual carto::rc_ptr< DataSourceInfo > | checkDataSourceInfo (carto::rc_ptr< DataSourceInfo > dsi, carto::Object options) |
| virtual carto::Volume< T > * | create (carto::Object header, const AllocatorContext &context, carto::Object options) |
| virtual void | setup (carto::Volume< T > &obj, carto::Object header, const AllocatorContext &context, carto::Object options) |
Protected Attributes | |
| carto::rc_ptr< ImageReader< T > > | _imr |
Detailed Description
template<typename T>
class soma::VolumeFormatReader< T >
FormatReader specialized for 4D Volume.
A such VolumeFormatReader needs to be linked to a specialized ImageReader before being registered into a FormatDictionary.
It understands the Volume and detects specific cases (borders, partial reading, ...) before performing the reading through its linked ImageReader.
The parameters for partial reading or borders may be given through the filename, at creation of the Reader.
- See also
- Reader FileUtil
- Note
- Parameters currently availables (GIS or OpenSlide) are :
- (int) ox, oy, oz, ot : top left position of partial frame.
- (int) sx, sy, sz, st : size of partial frame.
- (int) bx, by, bz : size of borders.
-
Is also possible to give any classical option as :
- (int) resolution_level : level to read (OpenSlide).
- (bool) unallocated : if volume shouldn't be allocated.
- (bool) partial_reading : if view is an allocated partial view to an unallocated volume (GIS or OpenSlide).
Definition at line 81 of file volumeformatreader.h.
Constructor & Destructor Documentation
◆ ~VolumeFormatReader()
|
virtual |
Definition at line 75 of file volumeformatreader_d.h.
Member Function Documentation
◆ attach()
| void soma::VolumeFormatReader< T >::attach | ( | carto::rc_ptr< ImageReader< T > > | imr | ) |
Linking to a ImageReader Allows us to declare only once the ImageReader.
Definition at line 512 of file volumeformatreader_d.h.
Referenced by soma::VolumeFormatReader< T >::clone(), soma::VolumeRefFormatReader< T >::createAndRead(), soma::VolumeRefFormatReader< T >::read(), and soma::VolumeRefFormatReader< T >::setupAndRead().
◆ clone()
|
virtual |
Implements soma::FormatReader< carto::Volume< T > >.
Definition at line 501 of file volumeformatreader_d.h.
References soma::VolumeFormatReader< T >::attach().
◆ createAndRead()
|
virtual |
Factory mode: creates an object and reads it.
The returned object belongs to the calling layer and may be deleted by the standard delete
Reimplemented from soma::FormatReader< carto::Volume< T > >.
Definition at line 141 of file volumeformatreader_d.h.
References soma::DataSourceList::dataSource(), rc_ptr< GenericObject >::get(), soma::DataSourceInfo::list(), soma::VolumeUtilIO< T >::listReadProperties(), localMsg, soma::VolumeUtilIO< T >::read(), carto::Object::reference(), carto::Carto2AimsHeaderTranslator::translate(), soma::DataSourceInfo::url(), and carto::Object::value().
Referenced by soma::VolumeRefFormatReader< T >::createAndRead().
◆ formatID()
|
virtual |
Implements soma::FormatReader< carto::Volume< T > >.
Definition at line 519 of file volumeformatreader_d.h.
◆ read()
|
virtual |
FormatReader derived function This method understands a volume and calls read( buffer ) with appropriate arguments.
Reimplemented from soma::FormatReader< carto::Volume< T > >.
Definition at line 211 of file volumeformatreader_d.h.
References carto::Volume< T >::allocatorContext(), soma::AllocatorContext::allocatorType(), soma::DataSourceCapabilities::canHandleStrides(), soma::DataSourceInfo::capabilities(), carto::rc_ptr< T >::get(), carto::VolumeProxy< T >::getSize(), soma::DataSourceInfo::header(), soma::AllocatorContext::isAllocated(), localMsg, carto::max(), carto::Volume< T >::posInRefVolume(), soma::AllocatorStrategy::ReadOnlyMap, carto::Volume< T >::refVolume(), carto::toString(), and soma::DataSourceInfo::url().
Referenced by soma::VolumeRefFormatReader< T >::read().
◆ setupAndRead()
|
virtual |
Full reading procedure, for an already existing object.
Definition at line 91 of file volumeformatreader_d.h.
References soma::DataSourceList::dataSource(), rc_ptr< GenericObject >::get(), soma::DataSourceInfo::list(), soma::VolumeUtilIO< T >::listReadProperties(), soma::VolumeUtilIO< T >::read(), carto::Object::reference(), carto::Carto2AimsHeaderTranslator::translate(), and carto::Object::value().
Referenced by soma::VolumeRefFormatReader< T >::setupAndRead().
Member Data Documentation
◆ _imr
|
protected |
Definition at line 119 of file volumeformatreader.h.
The documentation for this class was generated from the following files:
- cartodata/io/volumeformatreader.h
- cartodata/io/volumeformatreader_d.h
