FreeCompartment: Free compartment class
In midi: Microstructure Information from Diffusion Imaging
FreeCompartment R Documentation
Free compartment class
Description
A class to model free unconstrained diffusion.
Super class
BaseCompartment -> FreeCompartment
Methods
Public methods
Inherited methods
FreeCompartment$new()
Instantiates a new free compartment.
Usage
FreeCompartment$new(diffusivity = NULL)
Arguments
diffusivityA numeric value specifying the diffusivity within the
sphere in \mum^2.ms^{-1}. Defaults to NULL, in
which case the default free diffusivity of 3
\mum^2.ms^{-1} is used.
Returns
An instance of the FreeCompartment class.
FreeCompartment$clone()
The objects of this class are cloneable with this method.
Usage
FreeCompartment$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
midi documentation built on July 6, 2026, 1:08 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| FreeCompartment | R Documentation |
Free compartment class
Description
A class to model free unconstrained diffusion.
Super class
BaseCompartment -> FreeCompartment
Methods
Public methods
Inherited methods
FreeCompartment$new()
Instantiates a new free compartment.
Usage
FreeCompartment$new(diffusivity = NULL)
Arguments
diffusivityA numeric value specifying the diffusivity within the sphere in
\mum^2.ms^{-1}. Defaults toNULL, in which case the default free diffusivity of 3\mum^2.ms^{-1}is used.
Returns
An instance of the FreeCompartment class.
FreeCompartment$clone()
The objects of this class are cloneable with this method.
Usage
FreeCompartment$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.