MR.VoxelsLoad Class Reference

Classes
class	_ByValue_DicomStatus
	This is used as a function parameter when the underlying function receives DicomStatus by value. Usage:
class	_ByValue_DicomVolume
	This is used as a function parameter when the underlying function receives DicomVolume by value. Usage:
class	_ByValue_DicomVolumeAsVdb
	This is used as a function parameter when the underlying function receives DicomVolumeAsVdb by value. Usage:
class	_ByValue_LoadingTiffSettings
	This is used as a function parameter when the underlying function receives LoadingTiffSettings by value. Usage:
class	_InOptConst_DicomStatus
	This is used for optional parameters of class DicomStatus with default arguments. This is only used const parameters. For non-const ones we have _InOptMut_DicomStatus. Usage:
class	_InOptConst_DicomVolume
	This is used for optional parameters of class DicomVolume with default arguments. This is only used const parameters. For non-const ones we have _InOptMut_DicomVolume. Usage:
class	_InOptConst_DicomVolumeAsVdb
	This is used for optional parameters of class DicomVolumeAsVdb with default arguments. This is only used const parameters. For non-const ones we have _InOptMut_DicomVolumeAsVdb. Usage:
class	_InOptConst_LoadingTiffSettings
	This is used for optional parameters of class LoadingTiffSettings with default arguments. This is only used const parameters. For non-const ones we have _InOptMut_LoadingTiffSettings. Usage:
class	_InOptConst_RawParameters
	This is used for optional parameters of class RawParameters with default arguments. This is only used const parameters. For non-const ones we have _InOptMut_RawParameters. Usage:
class	_InOptMut_DicomStatus
	This is used for optional parameters of class DicomStatus with default arguments. This is only used mutable parameters. For const ones we have _InOptConst_DicomStatus. Usage:
class	_InOptMut_DicomVolume
	This is used for optional parameters of class DicomVolume with default arguments. This is only used mutable parameters. For const ones we have _InOptConst_DicomVolume. Usage:
class	_InOptMut_DicomVolumeAsVdb
	This is used for optional parameters of class DicomVolumeAsVdb with default arguments. This is only used mutable parameters. For const ones we have _InOptConst_DicomVolumeAsVdb. Usage:
class	_InOptMut_LoadingTiffSettings
	This is used for optional parameters of class LoadingTiffSettings with default arguments. This is only used mutable parameters. For const ones we have _InOptConst_LoadingTiffSettings. Usage:
class	_InOptMut_RawParameters
	This is used for optional parameters of class RawParameters with default arguments. This is only used mutable parameters. For const ones we have _InOptConst_RawParameters. Usage:
class	Const_DicomStatus
	Generated from class MR.VoxelsLoad.DicomStatus. This is the const half of the class.
class	Const_DicomVolume
	Generated from class MR.VoxelsLoad.DicomVolume. This is the const half of the class.
class	Const_DicomVolumeAsVdb
	Generated from class MR.VoxelsLoad.DicomVolumeAsVdb. This is the const half of the class.
class	Const_LoadingTiffSettings
	Generated from class MR.VoxelsLoad.LoadingTiffSettings. This is the const half of the class.
class	Const_RawParameters
	Generated from class MR.VoxelsLoad.RawParameters. This is the const half of the class.
class	DicomStatus
	Generated from class MR.VoxelsLoad.DicomStatus. This is the non-const half of the class. More...
class	DicomVolume
	Generated from class MR.VoxelsLoad.DicomVolume. This is the non-const half of the class. More...
class	DicomVolumeAsVdb
	Generated from class MR.VoxelsLoad.DicomVolumeAsVdb. This is the non-const half of the class. More...
class	LoadingTiffSettings
	Generated from class MR.VoxelsLoad.LoadingTiffSettings. This is the non-const half of the class. More...
class	RawParameters
	Generated from class MR.VoxelsLoad.RawParameters. This is the non-const half of the class. More...

Public Types
enum	DicomStatusEnum : int { Ok = 0 , Invalid = 1 , Unsupported = 2 }
enum	GridType : int { DenseGrid = 0 , LevelSet = 1 }

Static Public Member Functions
static unsafe MR.VoxelsLoad.DicomStatus	isDicomFile (string path, MR.Std.String? seriesUid=null, MR.Misc.InOut< MR.Vector3i >? dims=null)
	check if file is a valid DICOM dataset file
static unsafe bool	isDicomFolder (string dirPath)
	check if given folder contains at least one DICOM file Generated from function MR.VoxelsLoad.isDicomFolder.
static unsafe MR.Std.Vector_StdFilesystemPath	findDicomFoldersRecursively (string path)
	returns all the dicom folders in path, searching recursively Generated from function MR.VoxelsLoad.findDicomFoldersRecursively.
static unsafe MR.VoxelsLoad.DicomVolume	loadDicomFile (string file, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Loads full volume from single DICOM file (not a slice file) as SimpleVolumeMinMax Generated from function MR.VoxelsLoad.loadDicomFile. Parameter cb defaults to {}.
static unsafe MR.VoxelsLoad.DicomVolumeAsVdb	loadDicomFileAsVdb (string file, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Loads full volume from single DICOM file (not a slice file) as VdbVolume Generated from function MR.VoxelsLoad.loadDicomFileAsVdb. Parameter cb defaults to {}.
static unsafe MR.VoxelsLoad.DicomVolume	loadDicomFolder (string path, uint maxNumThreads, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Loads one volume from DICOM files located in given folder as SimpleVolumeMinMax Generated from function MR.VoxelsLoad.loadDicomFolder. Parameter cb defaults to {}.
static unsafe MR.VoxelsLoad.DicomVolumeAsVdb	loadDicomFolderAsVdb (string path, uint maxNumThreads, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Loads one volume from DICOM files located in given folder as VdbVolume Generated from function MR.VoxelsLoad.loadDicomFolderAsVdb. Parameter cb defaults to {}.
static unsafe MR.Std.Vector_ExpectedMRVoxelsLoadDicomVolumeStdString	loadDicomsFolder (string path, uint maxNumThreads, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Loads all volumes from DICOM files located in given folder as a number of SimpleVolumeMinMax Generated from function MR.VoxelsLoad.loadDicomsFolder. Parameter cb defaults to {}.
static unsafe MR.Std.Vector_ExpectedMRVoxelsLoadDicomVolumeAsVdbStdString	loadDicomsFolderAsVdb (string path, uint maxNumThreads, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Loads all volumes from DICOM files located in given folder as a number of VdbVolume Generated from function MR.VoxelsLoad.loadDicomsFolderAsVdb. Parameter cb defaults to {}.
static unsafe MR.Std.Vector_ExpectedMRVoxelsLoadDicomVolumeAsVdbStdString	loadDicomsFolderTreeAsVdb (string path, uint? maxNumThreads=null, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Loads every subfolder with DICOM volume as new object Generated from function MR.VoxelsLoad.loadDicomsFolderTreeAsVdb. Parameter maxNumThreads defaults to 4. Parameter cb defaults to {}.
static unsafe MR.ObjectVoxels	createObjectVoxels (MR.VoxelsLoad.Const_DicomVolumeAsVdb dcm, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	converts DicomVolumeAsVdb in ObjectVoxels Generated from function MR.VoxelsLoad.createObjectVoxels. Parameter cb defaults to {}.
static unsafe MR.LoadedObjects	makeObjectVoxelsFromDicomFolder (string folder, MR.Std.Const_Function_BoolFuncFromFloat? callback=null)
	Loads 3D volumetric data from dicom-files in given folder, and converts them into an ObjectVoxels Generated from function MR.VoxelsLoad.makeObjectVoxelsFromDicomFolder. Parameter callback defaults to {}.
static unsafe MR.VdbVolume	fromRaw (string file, MR.VoxelsLoad.Const_RawParameters params_, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Load raw voxels from file with provided parameters Generated from function MR.VoxelsLoad.fromRaw. Parameter cb defaults to {}.
static unsafe MR.VdbVolume	fromRaw (MR.Std.Istream in_, MR.VoxelsLoad.Const_RawParameters params_, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Load raw voxels from stream with provided parameters; important on Windows: in stream must be open in binary mode Generated from function MR.VoxelsLoad.fromRaw. Parameter cb defaults to {}.
static unsafe MR.FloatGrid	gridFromRaw (string file, MR.VoxelsLoad.Const_RawParameters params_, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Load raw voxels from file with provided parameters Generated from function MR.VoxelsLoad.gridFromRaw. Parameter cb defaults to {}.
static unsafe MR.FloatGrid	gridFromRaw (MR.Std.Istream in_, MR.VoxelsLoad.Const_RawParameters params_, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Load raw voxels from stream with provided parameters; important on Windows: in stream must be open in binary mode Generated from function MR.VoxelsLoad.gridFromRaw. Parameter cb defaults to {}.
static unsafe MR.VoxelsLoad.RawParameters	findRawParameters (MR.Std.Filesystem.Path file)
	finds raw voxels file and its encoding parameters
static unsafe MR.VdbVolume	fromRaw (string file, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Load raw voxels file, parsing parameters from name Generated from function MR.VoxelsLoad.fromRaw. Parameter cb defaults to {}.
static unsafe MR.FloatGrid	gridFromRaw (string file, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Load raw voxels file, parsing parameters from name Generated from function MR.VoxelsLoad.gridFromRaw. Parameter cb defaults to {}.
static unsafe MR.Std.Vector_MRVdbVolume	fromVdb (string file, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Load all voxel volumes from OpenVDB file Generated from function MR.VoxelsLoad.fromVdb. Parameter cb defaults to {}.
static unsafe MR.Std.Vector_MRFloatGrid	gridsFromVdb (string file, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Generated from function MR.VoxelsLoad.gridsFromVdb. Parameter cb defaults to {}.
static unsafe MR.Std.Vector_MRFloatGrid	gridsFromVdb (MR.Std.Istream in_, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Generated from function MR.VoxelsLoad.gridsFromVdb. Parameter cb defaults to {}.
static unsafe MR.VdbVolume	fromGav (string file, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Load voxel from Gav-file with micro CT reconstruction Generated from function MR.VoxelsLoad.fromGav. Parameter cb defaults to {}.
static unsafe MR.VdbVolume	fromGav (MR.Std.Istream in_, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Load voxel from Gav-stream with micro CT reconstruction Generated from function MR.VoxelsLoad.fromGav. Parameter cb defaults to {}.
static unsafe MR.Std.Vector_MRFloatGrid	gridsFromAnySupportedFormat (string file, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Detects the format from file extension and loads voxels from it Generated from function MR.VoxelsLoad.gridsFromAnySupportedFormat. Parameter cb defaults to {}.
static unsafe MR.Std.Vector_MRVdbVolume	fromAnySupportedFormat (string file, MR.Std.Const_Function_BoolFuncFromFloat? cb=null)
	Detects the format from file extension and loads voxels from it Generated from function MR.VoxelsLoad.fromAnySupportedFormat. Parameter cb defaults to {}.
static unsafe MR.VdbVolume	loadTiffDir (MR.VoxelsLoad.Const_LoadingTiffSettings settings)
	Load voxels from a set of TIFF files Generated from function MR.VoxelsLoad.loadTiffDir.

Member Enumeration Documentation

DicomStatusEnum

enum MR.VoxelsLoad.DicomStatusEnum : int

Enumerator
Ok
Invalid
Unsupported

GridType

enum MR.VoxelsLoad.GridType : int

Enumerator
DenseGrid
LevelSet

Member Function Documentation

createObjectVoxels()

static unsafe MR.ObjectVoxels MR.VoxelsLoad.createObjectVoxels ( MR.VoxelsLoad.Const_DicomVolumeAsVdb dcm, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

converts DicomVolumeAsVdb in ObjectVoxels Generated from function MR.VoxelsLoad.createObjectVoxels. Parameter cb defaults to {}.

findDicomFoldersRecursively()

static unsafe MR.Std.Vector_StdFilesystemPath MR.VoxelsLoad.findDicomFoldersRecursively ( string path )

inlinestatic

returns all the dicom folders in path, searching recursively Generated from function MR.VoxelsLoad.findDicomFoldersRecursively.

findRawParameters()

static unsafe MR.VoxelsLoad.RawParameters MR.VoxelsLoad.findRawParameters ( MR.Std.Filesystem.Path file )

inlinestatic

finds raw voxels file and its encoding parameters

Parameters

file	on input: file name probably without suffix with parameters on output: if success existing file name Generated from function MR.VoxelsLoad.findRawParameters.

fromAnySupportedFormat()

static unsafe MR.Std.Vector_MRVdbVolume MR.VoxelsLoad.fromAnySupportedFormat ( string file, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Detects the format from file extension and loads voxels from it Generated from function MR.VoxelsLoad.fromAnySupportedFormat. Parameter cb defaults to {}.

fromGav() [1/2]

static unsafe MR.VdbVolume MR.VoxelsLoad.fromGav ( MR.Std.Istream in_, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Load voxel from Gav-stream with micro CT reconstruction Generated from function MR.VoxelsLoad.fromGav. Parameter cb defaults to {}.

fromGav() [2/2]

static unsafe MR.VdbVolume MR.VoxelsLoad.fromGav ( string file, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Load voxel from Gav-file with micro CT reconstruction Generated from function MR.VoxelsLoad.fromGav. Parameter cb defaults to {}.

fromRaw() [1/3]

static unsafe MR.VdbVolume MR.VoxelsLoad.fromRaw ( MR.Std.Istream in_, MR.VoxelsLoad.Const_RawParameters params_, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Load raw voxels from stream with provided parameters; important on Windows: in stream must be open in binary mode Generated from function MR.VoxelsLoad.fromRaw. Parameter cb defaults to {}.

fromRaw() [2/3]

static unsafe MR.VdbVolume MR.VoxelsLoad.fromRaw ( string file, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Load raw voxels file, parsing parameters from name Generated from function MR.VoxelsLoad.fromRaw. Parameter cb defaults to {}.

fromRaw() [3/3]

static unsafe MR.VdbVolume MR.VoxelsLoad.fromRaw ( string file, MR.VoxelsLoad.Const_RawParameters params_, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Load raw voxels from file with provided parameters Generated from function MR.VoxelsLoad.fromRaw. Parameter cb defaults to {}.

fromVdb()

static unsafe MR.Std.Vector_MRVdbVolume MR.VoxelsLoad.fromVdb ( string file, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Load all voxel volumes from OpenVDB file Generated from function MR.VoxelsLoad.fromVdb. Parameter cb defaults to {}.

gridFromRaw() [1/3]

static unsafe MR.FloatGrid MR.VoxelsLoad.gridFromRaw ( MR.Std.Istream in_, MR.VoxelsLoad.Const_RawParameters params_, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Load raw voxels from stream with provided parameters; important on Windows: in stream must be open in binary mode Generated from function MR.VoxelsLoad.gridFromRaw. Parameter cb defaults to {}.

gridFromRaw() [2/3]

static unsafe MR.FloatGrid MR.VoxelsLoad.gridFromRaw ( string file, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Load raw voxels file, parsing parameters from name Generated from function MR.VoxelsLoad.gridFromRaw. Parameter cb defaults to {}.

gridFromRaw() [3/3]

static unsafe MR.FloatGrid MR.VoxelsLoad.gridFromRaw ( string file, MR.VoxelsLoad.Const_RawParameters params_, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Load raw voxels from file with provided parameters Generated from function MR.VoxelsLoad.gridFromRaw. Parameter cb defaults to {}.

gridsFromAnySupportedFormat()

static unsafe MR.Std.Vector_MRFloatGrid MR.VoxelsLoad.gridsFromAnySupportedFormat ( string file, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Detects the format from file extension and loads voxels from it Generated from function MR.VoxelsLoad.gridsFromAnySupportedFormat. Parameter cb defaults to {}.

gridsFromVdb() [1/2]

static unsafe MR.Std.Vector_MRFloatGrid MR.VoxelsLoad.gridsFromVdb ( MR.Std.Istream in_, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Generated from function MR.VoxelsLoad.gridsFromVdb. Parameter cb defaults to {}.

gridsFromVdb() [2/2]

static unsafe MR.Std.Vector_MRFloatGrid MR.VoxelsLoad.gridsFromVdb ( string file, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Generated from function MR.VoxelsLoad.gridsFromVdb. Parameter cb defaults to {}.

isDicomFile()

static unsafe MR.VoxelsLoad.DicomStatus MR.VoxelsLoad.isDicomFile ( string path, MR.Std.String? seriesUid = null, MR.Misc.InOut< MR.Vector3i >? dims = null )

inlinestatic

check if file is a valid DICOM dataset file

Parameters

seriesUid	- if set, the extracted series instance UID is copied to the variable
dims	- optional output of the file volume's dimensions Generated from function MR.VoxelsLoad.isDicomFile.

isDicomFolder()

static unsafe bool MR.VoxelsLoad.isDicomFolder ( string dirPath )

inlinestatic

check if given folder contains at least one DICOM file Generated from function MR.VoxelsLoad.isDicomFolder.

loadDicomFile()

static unsafe MR.VoxelsLoad.DicomVolume MR.VoxelsLoad.loadDicomFile ( string file, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Loads full volume from single DICOM file (not a slice file) as SimpleVolumeMinMax Generated from function MR.VoxelsLoad.loadDicomFile. Parameter cb defaults to {}.

loadDicomFileAsVdb()

static unsafe MR.VoxelsLoad.DicomVolumeAsVdb MR.VoxelsLoad.loadDicomFileAsVdb ( string file, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Loads full volume from single DICOM file (not a slice file) as VdbVolume Generated from function MR.VoxelsLoad.loadDicomFileAsVdb. Parameter cb defaults to {}.

loadDicomFolder()

static unsafe MR.VoxelsLoad.DicomVolume MR.VoxelsLoad.loadDicomFolder ( string path, uint maxNumThreads, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Loads one volume from DICOM files located in given folder as SimpleVolumeMinMax Generated from function MR.VoxelsLoad.loadDicomFolder. Parameter cb defaults to {}.

loadDicomFolderAsVdb()

static unsafe MR.VoxelsLoad.DicomVolumeAsVdb MR.VoxelsLoad.loadDicomFolderAsVdb ( string path, uint maxNumThreads, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Loads one volume from DICOM files located in given folder as VdbVolume Generated from function MR.VoxelsLoad.loadDicomFolderAsVdb. Parameter cb defaults to {}.

loadDicomsFolder()

static unsafe MR.Std.Vector_ExpectedMRVoxelsLoadDicomVolumeStdString MR.VoxelsLoad.loadDicomsFolder ( string path, uint maxNumThreads, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Loads all volumes from DICOM files located in given folder as a number of SimpleVolumeMinMax Generated from function MR.VoxelsLoad.loadDicomsFolder. Parameter cb defaults to {}.

loadDicomsFolderAsVdb()

static unsafe MR.Std.Vector_ExpectedMRVoxelsLoadDicomVolumeAsVdbStdString MR.VoxelsLoad.loadDicomsFolderAsVdb ( string path, uint maxNumThreads, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Loads all volumes from DICOM files located in given folder as a number of VdbVolume Generated from function MR.VoxelsLoad.loadDicomsFolderAsVdb. Parameter cb defaults to {}.

loadDicomsFolderTreeAsVdb()

static unsafe MR.Std.Vector_ExpectedMRVoxelsLoadDicomVolumeAsVdbStdString MR.VoxelsLoad.loadDicomsFolderTreeAsVdb ( string path, uint? maxNumThreads = null, MR.Std.Const_Function_BoolFuncFromFloat? cb = null )

inlinestatic

Loads every subfolder with DICOM volume as new object Generated from function MR.VoxelsLoad.loadDicomsFolderTreeAsVdb. Parameter maxNumThreads defaults to 4. Parameter cb defaults to {}.

loadTiffDir()

static unsafe MR.VdbVolume MR.VoxelsLoad.loadTiffDir ( MR.VoxelsLoad.Const_LoadingTiffSettings settings )

inlinestatic

Load voxels from a set of TIFF files Generated from function MR.VoxelsLoad.loadTiffDir.

makeObjectVoxelsFromDicomFolder()

static unsafe MR.LoadedObjects MR.VoxelsLoad.makeObjectVoxelsFromDicomFolder ( string folder, MR.Std.Const_Function_BoolFuncFromFloat? callback = null )

inlinestatic

Loads 3D volumetric data from dicom-files in given folder, and converts them into an ObjectVoxels Generated from function MR.VoxelsLoad.makeObjectVoxelsFromDicomFolder. Parameter callback defaults to {}.

---

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

• MRDicom.cs
• MRVoxelsLoad.cs