Methods

The following are the list of methods currently supported by mrsimulator as a part of the mrsimulator.method.lib module. To import a method, for example the BlochDecaySpectrum, used

>>> from mrsimulator.method.lib import BlochDecaySpectrum

Summary

Specialized 1D methods

BlochDecaySpectrum(*[, name, description, ...])	Simulate a Bloch decay spectrum.
BlochDecayCTSpectrum(*[, name, description, ...])	Simulate a Bloch decay central transition selective spectrum.

Specialized 2D methods

ThreeQ_VAS(*[, name, description, label, ...])	Simulate a sheared and scaled 3Q 2D variable-angle spinning spectrum.
FiveQ_VAS(*[, name, description, label, ...])	Simulate a sheared and scaled 5Q variable-angle spinning spectrum.
SevenQ_VAS(*[, name, description, label, ...])	Simulate a sheared and scaled 7Q variable-angle spinning spectrum.
ST1_VAS(*[, name, description, label, ...])	Simulate a sheared and scaled inner satellite and central transition correlation spectrum.
ST2_VAS(*[, name, description, label, ...])	Simulate a sheared and scaled second to inner satellite and central transition correlation spectrum.
SSB2D(*[, name, description, label, ...])	Simulating a sheared 2D finite to infinite speed MAS correlation spectrum.

Table of contents

• Bloch Decay Spectrum method
  • BlochDecaySpectrum
    • BlochDecaySpectrum.check_event_objects_for_compatibility()
    • BlochDecaySpectrum.check_method_compatibility()
    • BlochDecaySpectrum.dict()
    • BlochDecaySpectrum.get_symmetry_pathways()
    • BlochDecaySpectrum.get_transition_pathways()
    • BlochDecaySpectrum.json()
    • BlochDecaySpectrum.parse_dict_with_units()
    • BlochDecaySpectrum.plot()
    • BlochDecaySpectrum.reduced_dict()
    • BlochDecaySpectrum.shape()
    • BlochDecaySpectrum.summary()
• Bloch Decay Central Transition Spectrum method
  • BlochDecayCTSpectrum
    • BlochDecayCTSpectrum.check_event_objects_for_compatibility()
    • BlochDecayCTSpectrum.check_method_compatibility()
    • BlochDecayCTSpectrum.dict()
    • BlochDecayCTSpectrum.get_symmetry_pathways()
    • BlochDecayCTSpectrum.get_transition_pathways()
    • BlochDecayCTSpectrum.json()
    • BlochDecayCTSpectrum.parse_dict_with_units()
    • BlochDecayCTSpectrum.plot()
    • BlochDecayCTSpectrum.reduced_dict()
    • BlochDecayCTSpectrum.shape()
    • BlochDecayCTSpectrum.summary()
• Multi-quantum variable-angle spinning
  • Triple-quantum variable-angle spinning method
    • ThreeQ_VAS
      • ThreeQ_VAS.check_event_objects_for_compatibility()
      • ThreeQ_VAS.check_method_compatibility()
      • ThreeQ_VAS.dict()
      • ThreeQ_VAS.get_symmetry_pathways()
      • ThreeQ_VAS.get_transition_pathways()
      • ThreeQ_VAS.json()
      • ThreeQ_VAS.parse_dict_with_units()
      • ThreeQ_VAS.plot()
      • ThreeQ_VAS.reduced_dict()
      • ThreeQ_VAS.shape()
      • ThreeQ_VAS.summary()
  • Five-quantum variable-angle spinning method
    • FiveQ_VAS
      • FiveQ_VAS.check_event_objects_for_compatibility()
      • FiveQ_VAS.check_method_compatibility()
      • FiveQ_VAS.dict()
      • FiveQ_VAS.get_symmetry_pathways()
      • FiveQ_VAS.get_transition_pathways()
      • FiveQ_VAS.json()
      • FiveQ_VAS.parse_dict_with_units()
      • FiveQ_VAS.plot()
      • FiveQ_VAS.reduced_dict()
      • FiveQ_VAS.shape()
      • FiveQ_VAS.summary()
  • Seven-quantum variable-angle spinning method
    • SevenQ_VAS
      • SevenQ_VAS.check_event_objects_for_compatibility()
      • SevenQ_VAS.check_method_compatibility()
      • SevenQ_VAS.dict()
      • SevenQ_VAS.get_symmetry_pathways()
      • SevenQ_VAS.get_transition_pathways()
      • SevenQ_VAS.json()
      • SevenQ_VAS.parse_dict_with_units()
      • SevenQ_VAS.plot()
      • SevenQ_VAS.reduced_dict()
      • SevenQ_VAS.shape()
      • SevenQ_VAS.summary()
• Satellite-transition variable-angle spinning (ST-VAS)
  • Inner satellite variable-angle spinning method
    • ST1_VAS
      • ST1_VAS.check_event_objects_for_compatibility()
      • ST1_VAS.check_method_compatibility()
      • ST1_VAS.dict()
      • ST1_VAS.get_symmetry_pathways()
      • ST1_VAS.get_transition_pathways()
      • ST1_VAS.json()
      • ST1_VAS.parse_dict_with_units()
      • ST1_VAS.plot()
      • ST1_VAS.reduced_dict()
      • ST1_VAS.shape()
      • ST1_VAS.summary()
  • Second to inner satellite variable-angle spinning method
    • ST2_VAS
      • ST2_VAS.check_event_objects_for_compatibility()
      • ST2_VAS.check_method_compatibility()
      • ST2_VAS.dict()
      • ST2_VAS.get_symmetry_pathways()
      • ST2_VAS.get_transition_pathways()
      • ST2_VAS.json()
      • ST2_VAS.parse_dict_with_units()
      • ST2_VAS.plot()
      • ST2_VAS.reduced_dict()
      • ST2_VAS.shape()
      • ST2_VAS.summary()
• Spinning sideband correlation method
  • SSB2D
    • SSB2D.check_event_objects_for_compatibility()
    • SSB2D.check_method_compatibility()
    • SSB2D.dict()
    • SSB2D.get_symmetry_pathways()
    • SSB2D.get_transition_pathways()
    • SSB2D.json()
    • SSB2D.parse_dict_with_units()
    • SSB2D.plot()
    • SSB2D.reduced_dict()
    • SSB2D.shape()
    • SSB2D.summary()