MRVoxelsSave.h

Go to the documentation of this file.

#pragma once
#include "MRMeshFwd.h"
#include "MRIOFilters.h"
#include "MRExpected.h"
#include "MRProgressCallback.h"
#include "MRVoxelPath.h"
#include "MRVoxelsVolume.h"
#include <filesystem>
 
namespace MR::VoxelsSave
{
 
 
MRMESH_API extern const IOFilters Filters;
 
#ifndef MRMESH_NO_OPENVDB
 
MRMESH_API VoidOrErrStr toRawAutoname( const VdbVolume& vdbVolume, const std::filesystem::path& file,
                                       ProgressCallback callback = {} );
 
MRMESH_API VoidOrErrStr toRawFloat( const VdbVolume& vdbVolume, std::ostream & out, ProgressCallback callback = {} );
 
MRMESH_API VoidOrErrStr toGav( const VdbVolume& vdbVolume, const std::filesystem::path& file, ProgressCallback callback = {} );
MRMESH_API VoidOrErrStr toGav( const VdbVolume& vdbVolume, std::ostream & out, ProgressCallback callback = {} );
 
MRMESH_API VoidOrErrStr toVdb( const VdbVolume& vdbVolume, const std::filesystem::path& file,
                               ProgressCallback callback = {} );
 
MRMESH_API VoidOrErrStr toAnySupportedFormat( const VdbVolume& vdbVolume, const std::filesystem::path& file,
                                              ProgressCallback callback = {} );
 
MRMESH_API VoidOrErrStr saveSliceToImage( const std::filesystem::path& path, const VdbVolume& vdbVolume, const SlicePlane& slicePlain, int sliceNumber, ProgressCallback callback = {} );
 
// stores together all data for save voxel object as a group of images
struct SavingSettings
{
    // path to directory where you want to save images
    std::filesystem::path path;
    // format for file names, you should specify a placeholder for number and extension, eg "slice_{0:0{1}}.tif"
    std::string format = "slice_{0:0{1}}.tif";
    // Plane which the object is sliced by. XY, XZ, or YZ
    SlicePlane slicePlane;
    // Callback reporting progress
    ProgressCallback cb = {};
};
 
MRMESH_API VoidOrErrStr saveAllSlicesToImage( const VdbVolume& vdbVolume, const SavingSettings& settings );
 
#endif
 
 
}