Skip to content
Snippets Groups Projects
Verified Commit c9fccbca authored by Tamas Gal's avatar Tamas Gal :speech_balloon:
Browse files

More docs updates

parent c97dedf9
No related branches found
No related tags found
No related merge requests found
......@@ -3,6 +3,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
FHist = "68837c9b-b678-4cd5-9925-8a54edc8f695"
HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
KM3NeTTestData = "3249b543-581e-4f22-b7da-6c2cdf549b24"
KM3io = "2cab5852-6f21-4982-99b0-6a4792870cfb"
LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
PGFPlotsX = "8314cec4-20b6-5062-9cdb-752b83310925"
......
......@@ -11,6 +11,7 @@ makedocs(;
warn_outdated = true,
),
warnonly = [:missing_docs],
checkdocs = :exports,
pages = [
"Home" => "index.md",
"Manual" => Any[
......
......@@ -33,17 +33,36 @@ routine, like `jppmuon`, or `aashower`. The input can be an event (`Evt`) or a
vector of reconstructed tracks (`Vector{Trk}`). If no track/shower could be
found, `missing` is returned instead.
Here are some examples of how to use these functions:
```@example 1
using KM3io, KM3NeTTestData
f = ROOTFile(datapath("offline", "km3net_offline.root"))
e = f.offline[1]
```
```@example 1
event = f.offline[1]
```
```@example 1
bestjppmuon(event)
```
```@example 1
bestjppshower(event)
```
```@example 1
bestaashower(event)
```
```@example 1
bestjppshower(event.trks)
```
@show bestjppmuon(e)
@show bestjppshower(e)
@show bestaashower(e)
@show bestjppshower(e.trks)
@show bestaashower(e.trks)
```@example 1
bestaashower(event.trks)
```
Additonally, there are helper functions which can be used to check if a specific
......@@ -51,17 +70,33 @@ reconstruction stage or result is present in an event or a given set of
tracks/showers.
```@example 1
t = e.trks |> first
track = event.trks |> first
```
@show hasjppmuonprefit(t)
@show hasjppmuonsimplex(t)
@show hasjppmuongandalf(t)
@show hasjppmuonfit(t)
@show hasaashowerfit(t)
```@example 1
hasjppmuonprefit(track)
```
```@example 1
hasjppmuonsimplex(track)
```
```@example 1
hasjppmuongandalf(track)
```
```@example 1
hasjppmuonfit(track)
```
```@example 1
hasaashowerfit(track)
```
@show hasreconstructedjppmuon(e)
@show hasreconstructedjppshower(e)
@show hasreconstructedaashower(e)
```@example 1
hasreconstructedjppmuon(event)
```
```@example 1
hasreconstructedjppshower(event)
```
```@example 1
hasreconstructedaashower(event)
```
!!! note
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment