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
13259275
Verified
Commit
13259275
authored
9 months ago
by
Tamas Gal
Browse files
Options
Downloads
Patches
Plain Diff
Update docs on calibration/orientation
parent
9147972b
No related branches found
No related tags found
1 merge request
!32
Orientations readout and interpolation
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/src/api.md
+2
-0
2 additions, 0 deletions
docs/src/api.md
docs/src/manual/calibration.md
+36
-2
36 additions, 2 deletions
docs/src/manual/calibration.md
with
38 additions
and
2 deletions
docs/src/api.md
+
2
−
0
View file @
13259275
...
...
@@ -93,8 +93,10 @@ read(filename::AbstractString, T::Type{AcousticsTriggerParameter})
calibrate
calibratetime
combine
Orientations
floordist
slew
slerp
```
## Physics
...
...
This diff is collapsed.
Click to expand it.
docs/src/manual/calibration.md
+
36
−
2
View file @
13259275
# Calibration
It's implemented but not documented here yet. Check out the docs
`calibrate`
function's docstring!
In general, data related to detector calibration are either stored in the
database or in the
[
Calibration
Archive
](
https://git.km3net.de/auxiliary_data/calibration
)
.
## Hits
Hit calibration is implemented but not documented here yet. Check out the docs for
[
`calibrate()`
](
@ref
)
.
## Module Orientations
Module orientation data is stored in ROOT files which are generated by the Jpp
framework. The corresponding ROOT files, which are the output of the
[
dynamic
calibration
procedure
](
https://common.pages.km3net.de/jpp/Position_calibration.PDF
)
, are
stored in the
[
Calibration
Archive
](
https://git.km3net.de/auxiliary_data/calibration
)
under
`orientations/`
.
`KM3io.jl`
extends the
`Base.read`
function with a method which reads the whole
orientations file at once in an object of type
[
`Orientations`
](
@ref
)
. This
object can be called to calculate the orientation of a module (as a quaternion)
for a given time, as long as the time is within the time range of the
orientation data. The quaternions from the orientation data are interpolated for
the given time using
[
`slerp()`
](
@ref
)
.
The following example shows how to read the orientation data and obtain the
orientation quaternion for a module at a given time.
```
@example 1
using KM3io, KM3NeTTestData
o = read(datapath("calib", "KM3NeT_00000133_D_1.0.0_00017397_00017496_1.orientations.root"), Orientations)
module_id = 817589211
q = o(module_id, 1693408347)
```
This diff is collapsed.
Click to expand it.
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