Review API Docstrings

[beorostica]

A detailed review of the docstring descriptions is necessary.

Structs

• Scanner
• Phantom
• brain_phantom2D
• brain_phantom3D
• pelvis_phantom2D
• Delay
• ADC
• get_adc_sampling_times
• get_adc_phase_compensation
• RF
• get_flip_angle
• get_RF_center
• Grad
• Sequence
• DiscreteSequence
• discretize

Sequence-related Functions

• dur
• rotx
• roty
• rotz
• is_ADC_on
• is_RF_on
• is_GR_on
• is_Gx_on
• is_Gy_on
• is_Gz_on
• get_block_start_times
• get_samples
• get_grads
• get_rfs
• get_flip_angles
• get_RF_types
• get_kspace
• get_M1
• get_M2
• get_slew_rate
• get_eddy_currents

Prebuild Sequence Building Blocks

• RF_hard
• RF_sinc
• EPI
• radial_base
• spiral_base
• EPI_example

Timing Internals

• get_theo_A
• get_theo_t
• get_theo_Gi
• kfoldperm
• points_from_key_times
• get_variable_times
• trapz
• cumtrapz

Input/Output

• read_seq
• read_phantom_jemris
• read_phantom_MRiLab

Functor Functions

• Explanation of Functor Functions and clarification on which KomaMRI structs can be used as Functors.
• f32
• f64
• cpu
• gpu

Simulation

• run_sim_time_iter!
• run_spin_excitation_parallel!
• run_spin_precession_parallel!
• run_spin_excitation!
• run_spin_precession!
• default_sampling_params
• default_sim_params
• simulate
• simulate_slice_profile
• signal_to_raw_data
• Mag
• Spinnor
• Rz
• Ry
• Rx
• Rg
• Rφ
• Q

Plots

• theme_chooser
• interp_map
• plot_phantom_map
• plot_seq
• plot_kspace
• plot_M0
• plot_M1
• plot_M2
• plot_eddy_currents
• plot_slew_rate
• plot_signal
• plot_image
• plot_dict
• plot_seqd

UI

• KomaUI