Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::IvfSequenceVolumeReader Class Reference

Reader for *.ivfs sequnce files. More...

#include <ivfsequencevolumereader.h>

+ Inheritance diagram for inviwo::IvfSequenceVolumeReader:

Public Member Functions

 IvfSequenceVolumeReader (const IvfSequenceVolumeReader &rhs)=default
 
IvfSequenceVolumeReaderoperator= (const IvfSequenceVolumeReader &that)=default
 
virtual IvfSequenceVolumeReaderclone () const override
 
virtual std::shared_ptr< VolumeSequencereadData (const std::filesystem::path &filePath) override
 
- Public Member Functions inherited from inviwo::DataReaderType< VolumeSequence >
 DataReaderType (const DataReaderType &rhs)=default
 
 DataReaderType (DataReaderType &&rhs) noexcept=default
 
DataReaderTypeoperator= (const DataReaderType &that)=default
 
DataReaderTypeoperator= (DataReaderType &&that) noexcept=default
 
virtual std::shared_ptr< VolumeSequencereadData (const std::filesystem::path &filePath, MetaDataOwner *)
 
- Public Member Functions inherited from inviwo::DataReader
 DataReader (const DataReader &rhs)=default
 
 DataReader (DataReader &&rhs) noexcept=default
 
DataReaderoperator= (const DataReader &that)=default
 
DataReaderoperator= (DataReader &&that) noexcept=default
 
const std::vector< FileExtension > & getExtensions () const
 
void addExtension (FileExtension ext)
 
virtual bool setOption (std::string_view key, std::any value)
 Set reader specific options See the documentation of the specific reader for the available options.
 
virtual std::any getOption (std::string_view key)
 Query the value of an reader specific option.
 
template<typename T >
bool readsType () const
 

Additional Inherited Members

- Protected Member Functions inherited from inviwo::DataReaderType< VolumeSequence >
virtual bool canRead (const std::type_index &index) const override
 
- Protected Member Functions inherited from inviwo::DataReader
void checkExists (const std::filesystem::path &path) const
 
std::ifstream open (const std::filesystem::path &path, std::ios_base::openmode mode=std::ios_base::in) const
 
- Protected Attributes inherited from inviwo::DataReader
std::vector< FileExtensionextensions_
 

Detailed Description

Reader for *.ivfs sequnce files.

Supports reading a volume sequence from disk.

The expected structure of the ivfs sequence files is:

<?xml version="1.0" ?>
<InviwoWorkspace version="2">
    <volumes>
        <volume content="./relative/path/to/volume00.ivf" />
        <volume content="./relative/path/to/volume01.ivf" />
        ...
        <volume content="./relative/path/to/volumeNN.ivf" />
    </volumes>
</InviwoWorkspace>
 * 
See also
inviwo::IvfSequenceVolumeWriter

Member Function Documentation

◆ clone()

virtual IvfSequenceVolumeReader * inviwo::IvfSequenceVolumeReader::clone ( ) const
inlineoverridevirtual

◆ readData()

virtual std::shared_ptr< VolumeSequence > inviwo::IvfSequenceVolumeReader::readData ( const std::filesystem::path & filePath)
overridevirtual

Read a ivfs volume sequence from disk

Parameters
filePathpath the the ivfs file
Returns
The resulting sequence of volumes
See also
inviwo::IvfSequenceVolumeWriter::writeData(const VolumeSequence*, std::string , std::string,std::string)

Implements inviwo::DataReaderType< VolumeSequence >.


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