Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
KM3io.jl
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
common
KM3io.jl
Commits
33c58497
Verified
Commit
33c58497
authored
1 year ago
by
Tamas Gal
Browse files
Options
Downloads
Patches
Plain Diff
Update docs
parent
c9fccbca
Branches
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/src/manual/tools.md
+29
-4
29 additions, 4 deletions
docs/src/manual/tools.md
with
29 additions
and
4 deletions
docs/src/manual/tools.md
+
29
−
4
View file @
33c58497
...
...
@@ -29,11 +29,18 @@ identifiers, which are stored in these two fields.
The helper functions in
`KM3io.jl`
to pick the best track/shower always start
with the prefix
`best`
, followed by the common name of the reconstruction
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
f
ound,
`missing`
is re
tu
r
ne
d instead
.
routine, like
`jppmuon`
, or
`aashower`
.
For example
[
`bestjppmuon()`
](
@ref
)
,
[
`bestjppshower()`
](
@ref
)
or
[
`besttrack()`
](
@ref
)
, latter being a more general
f
unction which gives the possibility to fine
tune
the selection criteria
.
Here are some examples of how to use these functions:
The API documentation of all related functions can be found in the
[
Reconstruction
](
@ref
)
section.
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.
Below are some examples of how to use these functions.
```
@example 1
using KM3io, KM3NeTTestData
...
...
@@ -115,3 +122,21 @@ Let's close our file `;)`
```
@example 1
close(f)
```
## Trigger masks/flags
KM3NeT uses a 64bit integer type to store information about which triggers have
fired for a given event or hit. The index of the bit which indicates if a
specific trigger has fired is defined in the
[
KM3NeT
Dataformat
](
https://git.km3net.de/common/km3net-dataformat
)
specification which
is used in
`KM3io.jl`
.
Functions to check if a trigger has fired are for example
-
[
`is3dmuon()`
](
@ref
)
-
[
`is3dshower()`
](
@ref
)
-
[
`ismxshower()`
](
@ref
)
-
[
`isnb()`
](
@ref
)
which all accept either an event is input or something which has a
`.trigger_mask`
field, like a triggered hit.
This diff is collapsed.
Click to expand it.
Tamas Gal
@tgal
mentioned in commit
ce85da90
·
1 year ago
mentioned in commit
ce85da90
mentioned in commit ce85da90a757d4cdde1f87ae297d6b4aa96c66fe
Toggle commit list
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment