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

#include <ivfsequencevolumewriter.h>

Inheritance diagram for inviwo::IvfSequenceVolumeWriter:

Public Member Functions
	IvfSequenceVolumeWriter (const IvfSequenceVolumeWriter &rhs)=default

IvfSequenceVolumeWriter &	operator= (const IvfSequenceVolumeWriter &that)=default

virtual IvfSequenceVolumeWriter *	clone () const override

virtual void	writeData (const VolumeSequence *volumes, const std::filesystem::path &filePath) const override
	Writes a volume sequence to disk.

void	writeData (const VolumeSequence *volumes, std::string_view name, const std::filesystem::path &path, std::string_view relativePathToTimeSteps="") const
	Writes a volume sequence to disk.

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

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 inviwo::util::writeIvfVolumeSequence

Member Function Documentation

◆ clone()

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

inlineoverridevirtual

Implements inviwo::DataWriterType< VolumeSequence >.

◆ writeData() [1/2]

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

overridevirtual

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

volumes	The volume sequence to export
filePath	path to where the files will be written

Implements inviwo::DataWriterType< VolumeSequence >.

◆ writeData() [2/2]

void inviwo::IvfSequenceVolumeWriter::writeData	(	const VolumeSequence *	volumes,
		std::string_view	name,
		const std::filesystem::path &	path,
		std::string_view	relativePathToTimeSteps = "" ) const