ObservedShell

from mcot.dippi.scan import ObservedShell

class mcot.dippi.scan.ObservedShell(gradients: numpy.ndarray, scanner: mcot.dippi.scan.Scanner = <factory>, bval: float = 3.0, dual_echo: bool = True, t_phase: float = 30, b0_dir: numpy.ndarray = array([0., 0., 1.]), b0_group: int = 0, TE1: float = 80, TE2: float = 120)

Represents an shell of actual observed data

__init__(gradients: numpy.ndarray, scanner: mcot.dippi.scan.Scanner = <factory>, bval: float = 3.0, dual_echo: bool = True, t_phase: float = 30, b0_dir: numpy.ndarray = array([0., 0., 1.]), b0_group: int = 0, TE1: float = 80, TE2: float = 120) → None

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

Inheritance diagram

Methods

from_dict(kvs, *[, infer_missing])
from_json(s, *[, parse_float, parse_int, …])
schema(*[, infer_missing, only, exclude, …])
spherical_harmonics(lmax[, odd])
to_dict([encode_json])
to_json(*[, skipkeys, ensure_ascii, …])

Attributes

TE1	Time of second spin echo in ms
TE2
b0_dir	Give each shell that should be considered a different orientation a different b0_group
b0_group	Time of first spin echo in ms
bval	Whether to add a second refocus pulse
dataclass_json_config
dual_echo	time of phase accumulation
ngradients
readout1	Time of first readout in ms
readout2	Time of second readout in ms
t_phase	direction of the B0 field

from_dict

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

from_json

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

schema

classmethod ObservedShell.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]

spherical_harmonics

ObservedShell.spherical_harmonics(lmax, odd=True)

to_dict

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

to_json

ObservedShell.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