Inviwo  0.9.10.1
Inviwo documentation
inviwo::IvfSequenceVolumeWriter Class Reference

Writter for *.ivfs sequnce files. More...

#include <ivfsequencevolumewriter.h>

Public Member Functions

 IvfSequenceVolumeWriter (const IvfSequenceVolumeWriter &rhs)=default
 
IvfSequenceVolumeWriteroperator= (const IvfSequenceVolumeWriter &that)=default
 
virtual IvfSequenceVolumeWriterclone () const
 
virtual void writeData (const VolumeSequence *volumes, const std::string filePath) const
 Writes a volume sequence to disk. More...
 
void writeData (const VolumeSequence *volumes, std::string name, std::string path, std::string reltivePathToTimesteps="") const
 Writes a volume sequence to disk. More...
 
void setOverwrite (bool overwrite)
 
bool getOverwrite () const
 

Detailed Description

Writter for *.ivfs sequnce files.

Supports writing a volume sequence to disk. Will create one main file ([name].ivfs) and a series of ivf volumes ([name]xx.ivf), one for each element in the sequence.

The output 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::IvfSequenceVolumeReader

Member Function Documentation

◆ writeData() [1/2]

void inviwo::IvfSequenceVolumeWriter::writeData ( const VolumeSequence *  volumes,
const std::string  filePath 
) const
virtual

Writes a volume sequence to disk.

Writes a volume sequence to disk. Will create one main file ([name].ivfs) and a series of ivf volumes ([name]xx.ivf), one for each element in the sequence.

Parameters
volumesThe volume sequence to export
filePathpath to where the files will be written

◆ writeData() [2/2]

void inviwo::IvfSequenceVolumeWriter::writeData ( const VolumeSequence *  volumes,
std::string  name,
std::string  path,
std::string  reltivePathToTimesteps = "" 
) const

Writes a volume sequence to disk.

Writes a volume sequence to disk. Will create one main file ([name].ivfs) and a series of ivf volumes ([name]xx.ivf), one for each element in the sequence.

Parameters
volumesThe volume sequence to export
namethe name of the dataset, will be used for to name the output files [name].ivfs and [name]xx.ivf
pathpath to the folder to put the main file
reltivePathToTimestepsrelative path (from the path to the main file) to where the sequence elements will be written.

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