snake.core.handlers.base

Base handler module.

Module Contents

Classes

MetaHandler	MetaClass for Handlers.
AbstractHandler	Handler Interface.
HandlerList	Represent a Chain of Handler, that needs to be apply to a simulation.

Functions

list_handlers	List all available handlers.
get_handler	Get a handler from its name.

Data

T
H
handler

API

snake.core.handlers.base.T = 'TypeVar(...)'

class snake.core.handlers.base.MetaHandler

Bases: snake._meta.MetaDCRegister

MetaClass for Handlers.

dunder_name: ClassVar[str] = 'handler'

class snake.core.handlers.base.AbstractHandler

Handler Interface.

__registry__: ClassVar[dict[str, type[snake.core.handlers.base.AbstractHandler]]] = None

__handler_name__: ClassVar[str] = None

get_static(phantom: snake.core.phantom.Phantom, sim_conf: snake.core.simulation.SimConfig) → snake.core.phantom.Phantom

Get the static information of the handler.

get_dynamic(phantom: snake.core.phantom.Phantom, sim_conf: snake.core.simulation.SimConfig) → snake.core.phantom.DynamicData | None

Get the dynamic information of the handler.

get_dynamic_kspace(sim_conf: snake.core.simulation.SimConfig) → snake.core.phantom.KspaceDynamicData | None

Get the dynamic kspace information of the handler.

to_yaml() → str

Show the yaml config associated with the handler.

class snake.core.handlers.base.HandlerList(*args: snake.core.handlers.base.AbstractHandler)

Bases: collections.UserList

Represent a Chain of Handler, that needs to be apply to a simulation.

Initialization

classmethod from_cfg(cfg: dict[str, Any]) → snake.core.handlers.base.HandlerList

Create a HandlerList from a configuration.

to_yaml(filename: str | None = None) → str

Serialize the handlerList as a yaml string.

serialize() → list[dict[str, Any]]

Serialize the handlerList as a list of dictionary.

snake.core.handlers.base.H = None

snake.core.handlers.base.handler = None

snake.core.handlers.base.list_handlers() → list[str]

List all available handlers.

snake.core.handlers.base.get_handler(name: str) → type[snake.core.handlers.base.AbstractHandler]

Get a handler from its name.