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

Update docs

parent 391cfb5d
No related branches found
No related tags found
1 merge request!16Documenter 1
......@@ -39,6 +39,7 @@ SummaryFrame
H5File
H5CompoundDataset
create_dataset
flush
```
## Hardware
......@@ -47,8 +48,13 @@ create_dataset
PMT
DetectorModule
Detector
write(::AbstractString, ::Detector)
write(::IO, ::Detector)
Hydrophone
read(::AbstractString, ::Type{Hydrophone})
Tripod
read(::AbstractString, ::Type{Tripod})
write(::AbstractString, ::Vector{Tripod})
piezoenabled
hydrophoneenabled
center
......@@ -63,8 +69,10 @@ center
```@docs
Waveform
read(filename::AbstractString, T::Type{Waveform})
AcousticSignal
AcousticsTriggerParameter
read(filename::AbstractString, T::Type{AcousticsTriggerParameter})
```
## Calibration
......
......@@ -411,6 +411,11 @@ function _extract_comments(lines::Vector{T}, prefix::T) where {T<:AbstractString
end
"""
Writes the detector definition to a file, according to the DETX format specification.
The `version` parameter can be a version number or `:same`, which is the default value
and writes the same version as the provided detector has.
"""
function write(filename::AbstractString, d::Detector; version=:same)
isfile(filename) && @warn "File '$(filename)' already exists, overwriting."
open(filename, "w") do fobj
......
......@@ -102,6 +102,6 @@ K40Rates() = K40Rates(5200, [568.0, 49.10, 5.48, 0.48])
"""
Return the absorption length [m] in water at a KM3NeT site for a given wavelength [nm].
"""
function absorptionslength(λ)
function absorptionlength(λ)
error("Not implemented yet.")
end
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