Free compartment class

A class to model free unconstrained diffusion.

Super class

midi::BaseCompartment -> FreeCompartment

Methods

Public methods

• FreeCompartment$new()

• FreeCompartment$clone()

Inherited methods

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

---

Method new()

Instantiates a new free compartment.

Usage

FreeCompartment$new(diffusivity = NULL)

Arguments

diffusivity

A numeric value specifying the diffusivity within the sphere in \(\mu\)m\(^2\).ms\(^{-1}\). Defaults to NULL, in which case the default free diffusivity of 3 \(\mu\)m\(^2\).ms\(^{-1}\) is used.

Returns

An instance of the FreeCompartment class.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FreeCompartment$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.