snake.toolkit.cli.config

Configuration of SNAKE using Hydra.

Module Contents

Classes

EngineConfig	Engine configuration for SNAKE.
PhantomConfig	PhantomConfig.
StatConfig	Statistical configuration for SNAKE.
ConfigSNAKE	Configuration for SNAKE.

Functions

conf_validator	Validate the simulation configuration.
snake_handler_resolver	Get Custom resolver for OmegaConf to get handler name.
snake_sampler_resolver	Get Custom resolver for OmegaConf to get handler name.
cleanup_cuda	Cleanup CUDA.
make_hydra_cli	Create a Hydra CLI for the function.

Data

cs

API

class snake.toolkit.cli.config.EngineConfig

Engine configuration for SNAKE.

n_jobs: int = 1

chunk_size: int = 1

model: str = 'simple'

snr: float = 0

nufft_backend: str = 'finufft'

slice_2d: bool = False

class snake.toolkit.cli.config.PhantomConfig

PhantomConfig.

name: str = 'brainweb'

sub_id: int = 4

tissue_select: list[str] = 'field(...)'

tissue_ignore: list[str] = 'field(...)'

tissue_file: str | snake.core.phantom.static.TissueFile = None

class snake.toolkit.cli.config.StatConfig

Statistical configuration for SNAKE.

roi_tissue_name: str = 'ROI'

roi_threshold: float = 0.5

event_name: str = 'block_on'

class snake.toolkit.cli.config.ConfigSNAKE

Configuration for SNAKE.

handlers: Any = None

sampler: Any = None

reconstructors: Any = None

sim_conf: snake.core.simulation.SimConfig = 'SimConfig(...)'

engine: snake.toolkit.cli.config.EngineConfig = 'EngineConfig(...)'

phantom: snake.toolkit.cli.config.PhantomConfig = 'PhantomConfig(...)'

stats: snake.toolkit.cli.config.StatConfig = 'StatConfig(...)'

cache_dir: pathlib.Path = '${oc.env:PWD}/cache'

result_dir: pathlib.Path = '${oc.env:PWD}/results'

filename: pathlib.Path = 'test.mrd'

snake.toolkit.cli.config.conf_validator(cfg: omegaconf.DictConfig) → snake.toolkit.cli.config.ConfigSNAKE

Validate the simulation configuration.

snake.toolkit.cli.config.snake_handler_resolver(name: str) → str

Get Custom resolver for OmegaConf to get handler name.

snake.toolkit.cli.config.snake_sampler_resolver(name: str) → str

Get Custom resolver for OmegaConf to get handler name.

snake.toolkit.cli.config.cs = 'instance(...)'

snake.toolkit.cli.config.cleanup_cuda() → None

Cleanup CUDA.

snake.toolkit.cli.config.make_hydra_cli(fun: callable) → callable

Create a Hydra CLI for the function.