Scanner

from mcot.dippi.scan import Scanner
class mcot.dippi.scan.Scanner(gyro_magnetic_ratio: float = 267.5, anisotropic_susceptibility: float = - 100, B0: float = 7.0, max_gradient: float = 80.0, slew_rate: float = 200.0, t_pulse: float = 5.0, t_ro: float = 50.0)[source]

Properties of a single fibre population

__init__(gyro_magnetic_ratio: float = 267.5, anisotropic_susceptibility: float = - 100, B0: float = 7.0, max_gradient: float = 80.0, slew_rate: float = 200.0, t_pulse: float = 5.0, t_ro: float = 50.0) → None

Initialize self. See help(type(self)) for accurate signature.

Inheritance diagram

Inheritance diagram of mcot.dippi.scan.Scanner

Methods

from_dict(kvs, *[, infer_missing])

from_json(s, *[, parse_float, parse_int, …])

intra_axonal_frequency(g_ratio, angle_b0)

Computes the frequency within an axon in rad/ms

schema(*[, infer_missing, only, exclude, …])

to_dict([encode_json])

to_json(*[, skipkeys, ensure_ascii, …])

Attributes

B0

maximum gradient strength in mT/m

anisotropic_susceptibility

strength of the magnetic field

dataclass_json_config

gyro_magnetic_ratio

anisotropic susceptibility of myelin in ppb

larmor_frequency

Larmor frequency in rad/ms

max_gradient

maximum slew rate in mT/m/ms

slew_rate

Duration of the excitation and refocus pulses in ms

t_pulse

Duration of the readout in ms

t_ro

from_dict

classmethod Scanner.from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → A

from_json

classmethod Scanner.from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

intra_axonal_frequency

Scanner.intra_axonal_frequency(g_ratio, angle_b0)[source]

Computes the frequency within an axon in rad/ms

Parameters
  • g_ratio – g-ratio of the axon

  • angle_b0 – angle between the axon the main magnetic field

schema

classmethod Scanner.schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → dataclasses_json.mm.SchemaF[A]

to_dict

Scanner.to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json

Scanner.to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[str, int]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str