CylinderCompartment: Cylinder compartment class

In midi: Microstructure Information from Diffusion Imaging

Cylinder compartment class

Description

A class to model restricted diffusion in a cylinder.

Super classes

BaseCompartment -> CircularlyShapedCompartment -> CylinderCompartment

Methods

Public methods

• CylinderCompartment$new()

• CylinderCompartment$clone()

Inherited methods

• BaseCompartment$get_parameter_names()
• BaseCompartment$get_parameters()
• BaseCompartment$get_signal()

---

CylinderCompartment$new()

Instantiates a new cylinder compartment.

Usage

CylinderCompartment$new(
  axis = c(0, 0, 1),
  restricted_compartment = VanGelderenCompartment$new()
)

Arguments

axis

A length-3 numeric vector specifying the axis of the cylinder.

restricted_compartment

An instance of the CircularlyShapedCompartment class specifying the restricted compartment within the sphere. Defaults to a Van Gelderen compartment.

Returns

An instance of the CylinderCompartment class.

---

CylinderCompartment$clone()

The objects of this class are cloneable with this method.

Usage

CylinderCompartment$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

cylComp <- CylinderCompartment$new()
cylComp$get_signal(small_delta = 30, big_delta = 30, G = 0.040)
cylComp$get_parameter_names()
cylComp$get_parameters()

midi documentation built on July 6, 2026, 1:08 a.m.