Skip to content

Commit 803f870

Browse files
Update documentation for BaselinePlot
1 parent 3e0e82a commit 803f870

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

ext/ComradeMakieExt.jl

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,15 @@ If `bl` is a `Colon` or bl is not specified all baselines are plotted.
2222
- `data` : The data to plot
2323
2424
- `field1` and `field2` : The fields to plot. field1 - x axis, field2 - y axis
25-
If `field1` or `field2` is a function it will apply to `datatable(obsdata)` to get the value.
25+
If `field1` or `field2` is a function, baselineplot will broadcast them over `datatable(obsdata)`
26+
to get the x and y values as the outputs from `field1.(datatable(obsdata))` and `field2.(datatable(obsdata))`.
2627
If field1 or field2 is a symbol, it will look for a predefined function:
2728
- :U - baseline u coordinate
2829
- :V - baseline v coordinate
2930
- :Ti - time
3031
- :Fr - frequency
31-
- :measure - measurement
32+
- :measurement - measurement
33+
- :measwnoise - measurement and noise
3234
- :noise - noise
3335
- :amp - visibility amplitude
3436
- :phase - visibility phase
@@ -43,6 +45,11 @@ If `bl` is a `Colon` or bl is not specified all baselines are plotted.
4345
- `marker` : The marker type
4446
- `markersize` : The size of the markers
4547
- `alpha` : The transparency of the markers
48+
49+
# Examples
50+
```jldoctest
51+
julia> baselineplot(log_closure_amplitudes, Comrade.uvdist, Comrade.measwnoise, error=true)
52+
```
4653
"""
4754
Makie.@recipe(BaselinePlot, data, bl, fieldx, fieldy) do scene
4855
Makie.Attributes(;

0 commit comments

Comments
 (0)