snake.core.simulation

SImulation base objects.

Module Contents

Classes

GreConfig	Gradient Recall Echo Sequence parameters.
HardwareConfig	Scanner Hardware parameters.
SimConfig	All base configuration of a simulation.

Functions

_repr_html_

Recursive HTML representation for dataclasses.

Data

default_hardware
default_gre

API

snake.core.simulation._repr_html_(obj: Any, vertical: bool = True) → str

Recursive HTML representation for dataclasses.

This function generates an HTML table representation of a dataclass, including nested dataclasses.

Parameters:

obj (The dataclass instance.)

Returns:

str

Return type:

An HTML table string representing the dataclass.

class snake.core.simulation.GreConfig

Gradient Recall Echo Sequence parameters.

TR: float = None

TE: float = None

FA: float = None

_repr_html_ = None

class snake.core.simulation.HardwareConfig

Scanner Hardware parameters.

gmax: float = 40

smax: float = 200

n_coils: int = 8

dwell_time_ms: float = 0.001

raster_time_ms: float = 0.005

field: float = 3.0

_repr_html_ = None

snake.core.simulation.default_hardware = 'HardwareConfig(...)'

snake.core.simulation.default_gre = 'GreConfig(...)'

class snake.core.simulation.SimConfig

All base configuration of a simulation.

max_sim_time: float = 300

seq: snake.core.simulation.GreConfig = 'field(...)'

hardware: snake.core.simulation.HardwareConfig = 'field(...)'

fov_mm: tuple[float, float, float] = (192.0, 192.0, 128.0)

shape: tuple[int, int, int] = (192, 192, 128)

rng_seed: int = 19290506

_repr_html_ = None

__post_init__() → None

property max_n_shots: int

Maximum number of frames.

property res_mm: tuple[float, ...]

Voxel resolution in mm.

property sim_tr_ms: float

Simulation resolution in ms.