CircularlyShapedCompartment: Circularly-shaped compartment class
In midi: Microstructure Information from Diffusion Imaging
CircularlyShapedCompartment R Documentation
Circularly-shaped compartment class
Description
A class to model restricted diffusion in a bounded medium
described by a circular shape with a given radius.
Super class
BaseCompartment -> CircularlyShapedCompartment
Methods
Public methods
Inherited methods
CircularlyShapedCompartment$new()
Instantiates a new circular compartment.
Usage
CircularlyShapedCompartment$new(radius = NULL, diffusivity = NULL)
Arguments
radiusA numeric value specifying the radius of the sphere in
\mum.
diffusivityA numeric value specifying the diffusivity within the
sphere in \mum^2.ms^{-1}.
Returns
An instance of the CircularlyShapedCompartment class.
CircularlyShapedCompartment$clone()
The objects of this class are cloneable with this method.
Usage
CircularlyShapedCompartment$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.
| CircularlyShapedCompartment | R Documentation |
Circularly-shaped compartment class
Description
A class to model restricted diffusion in a bounded medium described by a circular shape with a given radius.
Super class
BaseCompartment -> CircularlyShapedCompartment
Methods
Public methods
Inherited methods
CircularlyShapedCompartment$new()
Instantiates a new circular compartment.
Usage
CircularlyShapedCompartment$new(radius = NULL, diffusivity = NULL)
Arguments
radiusA numeric value specifying the radius of the sphere in
\mum.diffusivityA numeric value specifying the diffusivity within the sphere in
\mum^2.ms^{-1}.
Returns
An instance of the CircularlyShapedCompartment class.
CircularlyShapedCompartment$clone()
The objects of this class are cloneable with this method.
Usage
CircularlyShapedCompartment$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.