snake.core.sampling.base

Contents

`snake.core.sampling.base`#

Sampling pattern generations.

Module Contents#

Classes#

`MetaSampler`	MetaClass for Samplers.
`BaseSampler`	Sampler Interface.

API#

class snake.core.sampling.base.MetaSampler[source]#

Bases: snake._meta.MetaDCRegister

MetaClass for Samplers.

dunder_name = 'sampler'#

class snake.core.sampling.base.BaseSampler[source]#

Sampler Interface.

A Sampler is designed to generate a sampling pattern.

Examples

>>> S = Sampler()
>>> S.generate()

__sampler_name__: ClassVar[str] = None#

__engine__: ClassVar[str] = None#

__registry__: ClassVar[dict[str, type[snake.core.sampling.base.BaseSampler]]] = None#

constant: bool = True#

property log: logging.Logger#: Get a logger.

abstract _single_frame(sim_conf: snake.core.simulation.SimConfig) → numpy.typing.NDArray[source]#: Generate a single frame.

get_next_frame(sim_conf: snake.core.simulation.SimConfig) → numpy.typing.NDArray[source]#: Generate the next frame.

abstract add_all_acq_mrd(dataset: ismrmrd.Dataset, sim_conf: snake.core.simulation.SimConfig) → ismrmrd.Dataset[source]#: Export the Sampling pattern to file.