inviwo::IvfVolumeSequenceWriter Class Reference

Writer for *.ivfs volume sequence files. More...

#include <ivfvolumewriter.h>

Inheritance diagram for inviwo::IvfVolumeSequenceWriter:

Public Member Functions
	IvfVolumeSequenceWriter (const IvfVolumeSequenceWriter &rhs)
	IvfVolumeSequenceWriter (IvfVolumeSequenceWriter &&rhs) noexcept
IvfVolumeSequenceWriter &	operator= (const IvfVolumeSequenceWriter &that)
IvfVolumeSequenceWriter &	operator= (IvfVolumeSequenceWriter &&that) noexcept
virtual IvfVolumeSequenceWriter *	clone () const
virtual void	writeData (const VolumeSequence *data, const std::filesystem::path &filePath) const
	Write data to filePath.
Public Member Functions inherited from inviwo::DataWriterType< VolumeSequence >
	DataWriterType (const DataWriterType &rhs)=default
	DataWriterType (DataWriterType &&rhs) noexcept=default
DataWriterType &	operator= (const DataWriterType &that)=default
DataWriterType &	operator= (DataWriterType &&that) noexcept=default
virtual std::unique_ptr< std::vector< unsigned char > >	writeDataToBuffer (const VolumeSequence *, std::string_view) const
Public Member Functions inherited from inviwo::DataWriter
	DataWriter (const DataWriter &rhs)
DataWriter &	operator= (const DataWriter &that)
	DataWriter (DataWriter &&rhs) noexcept=default
DataWriter &	operator= (DataWriter &&that) noexcept=default
const std::vector< FileExtension > &	getExtensions () const
void	addExtension (FileExtension ext)
Overwrite	getOverwrite () const
void	setOverwrite (Overwrite val)
void	checkOverwrite (const std::filesystem::path &path) const
virtual bool	setOption (std::string_view key, std::any value)
	Set writer specific options See the documentation of the specific writer for the available options.
virtual std::any	getOption (std::string_view key) const
	Query the value of a writer specific option.
template<typename T>
bool	writesType () const

Additional Inherited Members
Static Public Member Functions inherited from inviwo::DataWriter
static void	checkOverwrite (const std::filesystem::path &path, Overwrite overwrite)
Protected Member Functions inherited from inviwo::DataWriterType< VolumeSequence >
virtual bool	canWrite (const std::type_index &index) const override
Protected Member Functions inherited from inviwo::DataWriter
std::ofstream	open (const std::filesystem::path &path, std::ios_base::openmode mode=std::ios_base::out) const
Protected Attributes inherited from inviwo::DataWriter
Overwrite	overwrite_
std::vector< FileExtension >	extensions_

Detailed Description

Writer for *.ivfs volume sequence files.

Supports writing a volume sequence to disk. Creates one main file ([name].ivfs) and a series of raw files ([name]xx.raw or [name]xx.raw.gz if zlib compression is available), one for each volume.

The output structure of the ivfs sequence files is:

<?xml version="1.0" ?>
<InviwoVolume version="2">
    <RawFiles>
        <RawFile content="../data/CLOUDf01.bin.gz">
            <MetaDataMap>
                <MetaDataItem type="org.inviwo.DoubleMetaData" key="timestamp">
                    <MetaData content="1" />
                </MetaDataItem>
            </MetaDataMap>
        </RawFile>
        <RawFile content="../data/CLOUDf02.bin.gz">
            <MetaDataMap>
                <MetaDataItem type="org.inviwo.DoubleMetaData" key="timestamp">
                    <MetaData content="2" />
                </MetaDataItem>
            </MetaDataMap>
        </RawFile>
        ...
    </RawFiles>
    <ByteOrder content="0" />
    <Compression content="1" />
    <Format content="FLOAT32" />
    ...
</InviwoVolume>
 * 

See also

inviwo::IvfVolumeSequenceReader inviwo::util::writeIvfVolumeSequence

Member Function Documentation

clone()

virtual IvfVolumeSequenceWriter * inviwo::IvfVolumeSequenceWriter::clone ( ) const

virtual

Implements inviwo::DataWriterType< VolumeSequence >.

writeData()

virtual void inviwo::IvfVolumeSequenceWriter::writeData ( const VolumeSequence * data, const std::filesystem::path & filePath ) const

virtual

Write data to filePath.

Exceptions

DataWriterException

if anything goes wrong

Implements inviwo::DataWriterType< VolumeSequence >.

---

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

• ivfvolumewriter.h