inviwo::IvfVolumeWriter Class Reference

Writer for *.ivf volume files. More...

#include <ivfvolumewriter.h>

Inheritance diagram for inviwo::IvfVolumeWriter:

Public Member Functions
	IvfVolumeWriter (const IvfVolumeWriter &rhs)
	IvfVolumeWriter (IvfVolumeWriter &&rhs) noexcept
IvfVolumeWriter &	operator= (const IvfVolumeWriter &that)
IvfVolumeWriter &	operator= (IvfVolumeWriter &&that) noexcept
virtual IvfVolumeWriter *	clone () const
virtual void	writeData (const Volume *data, const std::filesystem::path &filePath) const
	Write data to filePath.
Public Member Functions inherited from inviwo::DataWriterType< Volume >
DataWriterType &	operator= (const DataWriterType &that)=default
virtual std::unique_ptr< std::vector< unsigned char > >	writeDataToBuffer (const Volume *, 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< Volume >
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 *.ivf volume files.

Supports writing a single volume to disk. Creates one main file ([name].ivf) and one raw file ([name].raw or [name]xx.raw.gz if zlib compression is available).

The output structure of the ivf file 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>
                <MetaDataItem type="org.inviwo.IntMetaData" key="index">
                    <MetaData content="1" />
                </MetaDataItem>
            </MetaDataMap>
        </RawFile>
    </RawFiles>
    <ByteOrder content="1" />
    <Compression content="1" />
    <Format content="FLOAT32" />
    <BasisAndOffset>
        <col0 x="1941.7" y="0" z="0" w="0" />
        <col1 x="0" y="1996.25" z="0" w="0" />
        <col2 x="0" y="0" z="990.0" w="0" />
        <col3 x="-970.85" y="-998.125" z="1.75" w="1" />
    </BasisAndOffset>
    <WorldTransform>
        <col0 x="1" y="0" z="0" w="0" />
        <col1 x="0" y="1" z="0" w="0" />
        <col2 x="0" y="0" z="1" w="0" />
        <col3 x="0" y="0" z="0" w="1" />
    </WorldTransform>
    <Dimension x="500" y="500" z="100" />
    <DataRange x="0" y="0.00332" />
    <ValueRange x="0" y="0.00332" />
    <ValueUnit content="kg/kg" />
</InviwoVolume>
 * 

See also

inviwo::IvfVolumeReader inviwo::util::writeIvfVolume

Member Function Documentation

clone()

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

virtual

Implements inviwo::DataWriterType< Volume >.

writeData()

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

virtual

Write data to filePath.

Exceptions

DataWriterException

if anything goes wrong

Implements inviwo::DataWriterType< Volume >.

---

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

• ivfvolumewriter.h