Skip to content

Commit

Permalink
Update TimeCurve.jl to fix docstrings again
Browse files Browse the repository at this point in the history
  • Loading branch information
pvillacorta authored Jan 6, 2025
1 parent e230486 commit 6dc38db
Showing 1 changed file with 23 additions and 28 deletions.
51 changes: 23 additions & 28 deletions KomaMRIBase/src/motion/TimeCurve.jl
Original file line number Diff line number Diff line change
Expand Up @@ -25,34 +25,29 @@ Each element specifies the scaling factor for that repetition.
- `timecurve`: (`::TimeCurve`) TimeCurve struct
# Examples
1. Non-periodic motion with a single repetition:
```julia-repl
julia> timecurve = TimeCurve(t=[0.0, 0.2, 0.4, 0.6], t_unit=[0.0, 0.2, 0.5, 1.0])
```
![Time Curve 1](../assets/time-curve-1.svg)
2. Periodic motion with a single repetition:
```julia-repl
julia> timecurve = TimeCurve(t=[0.0, 0.2, 0.4, 0.6], t_unit=[0.0, 1.0, 1.0, 0.0], periodic=true)
```
![Time Curve 2](../assets/time-curve-2.svg)
3. Non-periodic motion with multiple repetitions:
```julia-repl
julia> timecurve = TimeCurve(t=[0.0, 0.2, 0.4, 0.6], t_unit=[0.0, 1.0, 1.0, 0.0], periods=[1.0, 0.5, 1.5])
```
![Time Curve 3](../assets/time-curve-3.svg)
4. Periodic motion with multiple repetitions:
```julia-repl
julia> timecurve = TimeCurve(t=[0.0, 0.2, 0.4, 0.6], t_unit=[0.0, 1.0, 1.0, 0.0], periods=[1.0, 0.5, 1.5], periodic=true)
```
![Time Curve 4](../assets/time-curve-4.svg)
1\. Non-periodic motion with a single repetition:
```julia-repl
julia> timecurve = TimeCurve(t=[0.0, 0.2, 0.4, 0.6], t_unit=[0.0, 0.2, 0.5, 1.0])
```
![Time Curve 1](../assets/time-curve-1.svg)
2\. Periodic motion with a single repetition:
```julia-repl
julia> timecurve = TimeCurve(t=[0.0, 0.2, 0.4, 0.6], t_unit=[0.0, 1.0, 1.0, 0.0], periodic=true)
```
![Time Curve 2](../assets/time-curve-2.svg)
3\. Non-periodic motion with multiple repetitions:
```julia-repl
julia> timecurve = TimeCurve(t=[0.0, 0.2, 0.4, 0.6], t_unit=[0.0, 1.0, 1.0, 0.0], periods=[1.0, 0.5, 1.5])
```
![Time Curve 3](../assets/time-curve-3.svg)
4\. Periodic motion with multiple repetitions:
```julia-repl
julia> timecurve = TimeCurve(t=[0.0, 0.2, 0.4, 0.6], t_unit=[0.0, 1.0, 1.0, 0.0], periods=[1.0, 0.5, 1.5], periodic=true)
```
![Time Curve 4](../assets/time-curve-4.svg)
"""
@with_kw struct TimeCurve{T<:Real}
t::AbstractVector{T}
Expand Down

0 comments on commit 6dc38db

Please sign in to comment.