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

Including details about prints of simulate #431

Merged
merged 3 commits into from
Jul 17, 2024
Merged

Including details about prints of simulate #431

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a537cb0
Including details about prints of simulate
gsahonero Jul 9, 2024
9b87842
Update KomaMRICore/src/simulation/SimulatorCore.jl
cncastillo Jul 17, 2024
437e68f
Merge branch 'master' into simulate_docs_change
cncastillo Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion KomaMRICore/src/simulation/SimulatorCore.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,13 @@ end
out = simulate(obj::Phantom, seq::Sequence, sys::Scanner; sim_params, w)

Returns the raw signal or the last state of the magnetization according to the value
of the `"return_type"` key of the `sim_params` dictionary.
of the `"return_type"` key of the `sim_params` dictionary. By default, it prints the `@time`
information of `run_sim_time_iter` and simulation details such as the number of spins,
the simulation method, the time points to consider, and the ADC points to be acquired.

Note: The information obtained through `@time out = simulate(obj, seq, sys)` will differ from
the report of `out = simulate(obj, seq, sys)` as the latter one does not consider complementary
processes to `run_sim_time_iter`.
cncastillo marked this conversation as resolved.
Show resolved Hide resolved

# Arguments
- `obj`: (`::Phantom`) Phantom struct
Expand Down