MR::VoxelsLoad Namespace Reference

Classes
struct	DicomStatus
struct	DicomVolumeT
struct	LoadingTiffSettings
struct	RawParameters

Typedefs
using	VoxelsLoader = Expected<std::vector<VdbVolume>>( * )( const std::filesystem::path&, const ProgressCallback& )

Enumerations
enum class	DicomStatusEnum : int { Ok = 0 , Invalid , Unsupported }
enum class	GridType { DenseGrid = 0 , LevelSet = 1 }

Functions
MRVOXELS_API DicomStatus	isDicomFile (const std::filesystem::path &path, std::string *seriesUid=nullptr)
MRVOXELS_API bool	isDicomFolder (const std::filesystem::path &dirPath)
	check if given folder contains at least one DICOM file
MRVOXELS_API std::vector< std::filesystem::path >	findDicomFoldersRecursively (const std::filesystem::path &path)
	returns all the dicom folders in path, searching recursively
MRVOXELS_API Expected< DicomVolume >	loadDicomFile (const std::filesystem::path &file, const ProgressCallback &cb={})
	Loads full volume from single DICOM file (not a slice file) as SimpleVolumeMinMax.
MRVOXELS_API Expected< DicomVolumeAsVdb >	loadDicomFileAsVdb (const std::filesystem::path &file, const ProgressCallback &cb={})
	Loads full volume from single DICOM file (not a slice file) as VdbVolume.
MRVOXELS_API Expected< DicomVolume >	loadDicomFolder (const std::filesystem::path &path, unsigned maxNumThreads, const ProgressCallback &cb={})
	Loads one volume from DICOM files located in given folder as SimpleVolumeMinMax.
MRVOXELS_API Expected< DicomVolumeAsVdb >	loadDicomFolderAsVdb (const std::filesystem::path &path, unsigned maxNumThreads, const ProgressCallback &cb={})
	Loads one volume from DICOM files located in given folder as VdbVolume.
MRVOXELS_API std::vector< Expected< DicomVolume > >	loadDicomsFolder (const std::filesystem::path &path, unsigned maxNumThreads, const ProgressCallback &cb={})
	Loads all volumes from DICOM files located in given folder as a number of SimpleVolumeMinMax.
MRVOXELS_API std::vector< Expected< DicomVolumeAsVdb > >	loadDicomsFolderAsVdb (const std::filesystem::path &path, unsigned maxNumThreads, const ProgressCallback &cb={})
	Loads all volumes from DICOM files located in given folder as a number of VdbVolume.
MRVOXELS_API std::vector< Expected< DicomVolumeAsVdb > >	loadDicomsFolderTreeAsVdb (const std::filesystem::path &path, unsigned maxNumThreads=4, const ProgressCallback &cb={})
	Loads every subfolder with DICOM volume as new object.
MRVOXELS_API Expected< std::shared_ptr< ObjectVoxels > >	createObjectVoxels (const DicomVolumeAsVdb &dcm, const ProgressCallback &cb={})
	converts DicomVolumeAsVdb in ObjectVoxels
MRVOXELS_API Expected< LoadedObjects >	makeObjectVoxelsFromDicomFolder (const std::filesystem::path &folder, const ProgressCallback &callback={})
	Loads 3D volumetric data from dicom-files in given folder, and converts them into an ObjectVoxels.
MRVOXELS_API Expected< VdbVolume >	fromRaw (const std::filesystem::path &file, const RawParameters &params, const ProgressCallback &cb={})
	Load raw voxels from file with provided parameters.
MRVOXELS_API Expected< VdbVolume >	fromRaw (std::istream &in, const RawParameters &params, const ProgressCallback &cb={})
MRVOXELS_API Expected< FloatGrid >	gridFromRaw (const std::filesystem::path &file, const RawParameters &params, const ProgressCallback &cb={})
	Load raw voxels from file with provided parameters.
MRVOXELS_API Expected< FloatGrid >	gridFromRaw (std::istream &in, const RawParameters &params, const ProgressCallback &cb={})
MRVOXELS_API Expected< RawParameters >	findRawParameters (std::filesystem::path &file)
MRVOXELS_API Expected< VdbVolume >	fromRaw (const std::filesystem::path &file, const ProgressCallback &cb={})
	Load raw voxels file, parsing parameters from name.
MRVOXELS_API Expected< FloatGrid >	gridFromRaw (const std::filesystem::path &file, const ProgressCallback &cb={})
	Load raw voxels file, parsing parameters from name.
MRVOXELS_API Expected< std::vector< VdbVolume > >	fromVdb (const std::filesystem::path &file, const ProgressCallback &cb={})
	Load all voxel volumes from OpenVDB file.
MRVOXELS_API Expected< std::vector< FloatGrid > >	gridsFromVdb (const std::filesystem::path &file, const ProgressCallback &cb={})
MRVOXELS_API Expected< std::vector< FloatGrid > >	gridsFromVdb (std::istream &in, const ProgressCallback &cb={})
MRVOXELS_API Expected< VdbVolume >	fromGav (const std::filesystem::path &file, const ProgressCallback &cb={})
	Load voxel from Gav-file with micro CT reconstruction.
MRVOXELS_API Expected< VdbVolume >	fromGav (std::istream &in, const ProgressCallback &cb={})
	Load voxel from Gav-stream with micro CT reconstruction.
MRVOXELS_API Expected< std::vector< FloatGrid > >	gridsFromAnySupportedFormat (const std::filesystem::path &file, const ProgressCallback &cb={})
	Detects the format from file extension and loads voxels from it.
MRVOXELS_API Expected< std::vector< VdbVolume > >	fromAnySupportedFormat (const std::filesystem::path &file, const ProgressCallback &cb={})
	Detects the format from file extension and loads voxels from it.
MRVOXELS_API Expected< VdbVolume >	loadTiffDir (const LoadingTiffSettings &settings)
	Load voxels from a set of TIFF files.

Typedef Documentation

VoxelsLoader

using MR::VoxelsLoad::VoxelsLoader = Expected<std::vector<VdbVolume>>( * )( const std::filesystem::path&, const ProgressCallback& )

Enumeration Type Documentation

DicomStatusEnum

enum class MR::VoxelsLoad::DicomStatusEnum : int

strong

Enumerator
Ok
Invalid
Unsupported

GridType

enum class MR::VoxelsLoad::GridType

strong

Enumerator
DenseGrid
LevelSet

Function Documentation

createObjectVoxels()

MRVOXELS_API Expected< std::shared_ptr< ObjectVoxels > > MR::VoxelsLoad::createObjectVoxels	(	const DicomVolumeAsVdb &	dcm,
		const ProgressCallback &	cb = {} )

converts DicomVolumeAsVdb in ObjectVoxels

findDicomFoldersRecursively()

MRVOXELS_API std::vector< std::filesystem::path > MR::VoxelsLoad::findDicomFoldersRecursively

(

const std::filesystem::path &

path

)

returns all the dicom folders in path, searching recursively

isDicomFile()

MRVOXELS_API DicomStatus MR::VoxelsLoad::isDicomFile	(	const std::filesystem::path &	path,
		std::string *	seriesUid = nullptr )

check if file is a valid DICOM dataset file

Parameters

seriesUid

- if set, the extracted series instance UID is copied to the variable

isDicomFolder()

MRVOXELS_API bool MR::VoxelsLoad::isDicomFolder

(

const std::filesystem::path &

dirPath

)

check if given folder contains at least one DICOM file

loadDicomFile()

MRVOXELS_API Expected< DicomVolume > MR::VoxelsLoad::loadDicomFile	(	const std::filesystem::path &	file,
		const ProgressCallback &	cb = {} )

Loads full volume from single DICOM file (not a slice file) as SimpleVolumeMinMax.

loadDicomFileAsVdb()

MRVOXELS_API Expected< DicomVolumeAsVdb > MR::VoxelsLoad::loadDicomFileAsVdb	(	const std::filesystem::path &	file,
		const ProgressCallback &	cb = {} )

Loads full volume from single DICOM file (not a slice file) as VdbVolume.

loadDicomFolder()

MRVOXELS_API Expected< DicomVolume > MR::VoxelsLoad::loadDicomFolder	(	const std::filesystem::path &	path,
		unsigned	maxNumThreads,
		const ProgressCallback &	cb = {} )

Loads one volume from DICOM files located in given folder as SimpleVolumeMinMax.

loadDicomFolderAsVdb()

MRVOXELS_API Expected< DicomVolumeAsVdb > MR::VoxelsLoad::loadDicomFolderAsVdb	(	const std::filesystem::path &	path,
		unsigned	maxNumThreads,
		const ProgressCallback &	cb = {} )

Loads one volume from DICOM files located in given folder as VdbVolume.

loadDicomsFolder()

MRVOXELS_API std::vector< Expected< DicomVolume > > MR::VoxelsLoad::loadDicomsFolder	(	const std::filesystem::path &	path,
		unsigned	maxNumThreads,
		const ProgressCallback &	cb = {} )

Loads all volumes from DICOM files located in given folder as a number of SimpleVolumeMinMax.

loadDicomsFolderAsVdb()

MRVOXELS_API std::vector< Expected< DicomVolumeAsVdb > > MR::VoxelsLoad::loadDicomsFolderAsVdb	(	const std::filesystem::path &	path,
		unsigned	maxNumThreads,
		const ProgressCallback &	cb = {} )

Loads all volumes from DICOM files located in given folder as a number of VdbVolume.

loadDicomsFolderTreeAsVdb()

MRVOXELS_API std::vector< Expected< DicomVolumeAsVdb > > MR::VoxelsLoad::loadDicomsFolderTreeAsVdb	(	const std::filesystem::path &	path,
		unsigned	maxNumThreads = 4,
		const ProgressCallback &	cb = {} )

Loads every subfolder with DICOM volume as new object.

loadTiffDir()

MRVOXELS_API Expected< VdbVolume > MR::VoxelsLoad::loadTiffDir

(

const LoadingTiffSettings &

settings

)

Load voxels from a set of TIFF files.

makeObjectVoxelsFromDicomFolder()

MRVOXELS_API Expected< LoadedObjects > MR::VoxelsLoad::makeObjectVoxelsFromDicomFolder	(	const std::filesystem::path &	folder,
		const ProgressCallback &	callback = {} )

Loads 3D volumetric data from dicom-files in given folder, and converts them into an ObjectVoxels.