Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Review API Docstrings #260

Open
92 tasks done
beorostica opened this issue Dec 19, 2023 · 0 comments
Open
92 tasks done

Review API Docstrings #260

beorostica opened this issue Dec 19, 2023 · 0 comments
Assignees
@beorostica
Labels
documentation Improvements to docs., it also triggers doc preview

Comments

@beorostica
Copy link
Contributor

beorostica commented Dec 19, 2023 •
edited
Loading

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
@beorostica beorostica mentioned this issue Dec 19, 2023
Merged
@beorostica beorostica self-assigned this Dec 20, 2023
@beorostica beorostica moved this to Todo in KomaMRI.jl v0.8.0 Jan 4, 2024
@beorostica beorostica moved this from Todo to In Progress in KomaMRI.jl v0.8.0 Jan 10, 2024
@beorostica beorostica added the documentation Improvements to docs., it also triggers doc preview label Jan 18, 2024
@beorostica beorostica mentioned this issue Jan 18, 2024
Open
@cncastillo cncastillo linked a pull request Jan 19, 2024 that will close this issue
Docstrings Review #297
Open
@cncastillo cncastillo removed a link to a pull request Jun 16, 2024
Docstrings Review #297
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@beorostica beorostica

Labels
documentation Improvements to docs., it also triggers doc preview
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@beorostica