Skip to content

Commit

Permalink
Including details about prints of simulate
Browse files Browse the repository at this point in the history
  • Loading branch information
gsahonero authored Jul 9, 2024
1 parent eb05128 commit d7684c3
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion KomaMRICore/src/simulation/SimulatorCore.jl
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`.
# Arguments
- `obj`: (`::Phantom`) Phantom struct
Expand Down

0 comments on commit d7684c3

Please sign in to comment.