Simulation Templates#

Summary#

cmrsim.simulation_templates.FlowSimulation(...)

Performs simulation of a refilling flow over multiple TRs.

cmrsim.simulation_templates.FlowSimulationMultiVenc(...)

Performs simulation of a refilling flow over multiple TRs while using multiple waveforms in parallel.

FlowSimulation#

class FlowSimulation(flow_dataset, prep_modules, readout_module, contrast_modules=(), trajectory_module=None)[source]#

Performs simulation of a refilling flow over multiple TRs.

Parameters:

  • flow_dataset –

  • prep_modules –

  • readout_module –

  • contrast_modules –

  • trajectory_module –

Methods:

__call__([particle_density, ...])

type particle_density:

float
__call__(particle_density=0.1, dropping_distance=0.05, averages=1, reseed_threshold=0.25, use_inital_filling=True, initial_filling_dict=None, return_final_magnetization=False)[source]#
Parameters:

  • particle_density (float) –

  • dropping_distance (float) –

  • averages (int) –

  • reseed_threshold (float) –

  • use_inital_filling (bool) –

  • initial_filling_dict (dict) –

  • return_final_magnetization (bool) –

Returns:

FlowSimulationMultiVenc#

class FlowSimulationMultiVenc(flow_dataset, prep_modules, readout_modules, trajectory_module=None)[source]#

Performs simulation of a refilling flow over multiple TRs while using multiple waveforms in parallel.

Parameters:

  • flow_dataset –

  • prep_modules –

  • readout_modules –

  • trajectory_module –

Methods:

__call__([particle_density, ...])

Evals
__call__(particle_density=0.1, dropping_distance=0.05, averages=1, reseed_threshold=0.25, use_inital_filling=True, initial_filling_dict=None, return_final_magnetization=False)[source]#

Evals

Parameters:

  • particle_density (float) –

  • dropping_distance (float) –

  • averages (int) –

  • reseed_threshold (float) –

  • use_inital_filling (bool) –

  • initial_filling_dict (dict) –

  • return_final_magnetization (bool) –

Returns: