Expose dither_storage as kwarg

Project.toml

@@ -1,7 +1,7 @@
 name = "OndaEDF"
 uuid = "e3ed2cd1-99bf-415e-bb8f-38f4b42a544e"
 authors = ["Beacon Biosignals, Inc."]
-version = "0.11.4"
+version = "0.11.5"
 
 [deps]
 Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"

src/import_edf.jl

@@ -485,7 +485,7 @@ grouper(var::Symbol) = grouper((var, ))
 
 # return Samples for each :onda_signal_index
 """
-    edf_to_onda_samples(edf::EDF.File, plan_table; validate=true)
+    edf_to_onda_samples(edf::EDF.File, plan_table; validate=true, dither_storage=missing)
 
 Convert Signals found in an EDF File to `Onda.Samples` according to the plan
 specified in `plan_table` (e.g., as generated by [`plan_edf_to_onda_samples`](@ref)), returning an
@@ -507,8 +507,11 @@ not be matched or otherwise caused an error during execution are not returned.
 
 If `validate=true` (the default), the plan is validated against the
 [`FilePlanV2`](@ref) schema, and the signal headers in the `EDF.File`.
+
+If `dither_storage=missing` (the default), dither storage is allocated automatically
+as specified in the docstring for `Onda.encode`. `dither_storage=nothing` disables dithering.
 """
-function edf_to_onda_samples(edf::EDF.File, plan_table; validate=true)
+function edf_to_onda_samples(edf::EDF.File, plan_table; validate=true, dither_storage=missing)
 
     true_signals = filter(x -> isa(x, EDF.Signal), edf.signals)
 
@@ -539,7 +542,7 @@ function edf_to_onda_samples(edf::EDF.File, plan_table; validate=true)
             else
                 signals = [true_signals[row.edf_signal_index] for row in rows]
                 samples = onda_samples_from_edf_signals(SamplesInfoV2(info), signals,
-                                                        edf.header.seconds_per_record)
+                                                        edf.header.seconds_per_record; dither_storage)
             end
             return (; idx, samples, plan_rows=rows)
         catch e
@@ -605,13 +608,16 @@ end
 
 """
     OndaEDF.onda_samples_from_edf_signals(target::Onda.SamplesInfo, edf_signals,
-                                          edf_seconds_per_record)
+                                          edf_seconds_per_record; dither_storage)
 
 Generate an `Onda.Samples` struct from an iterable of `EDF.Signal`s, based on
 the `Onda.SamplesInfo` in `target`.  This checks for matching sample rates in
 the source signals.  If the encoding of `target` is the same as the encoding in
 a signal, its encoded (usually `Int16`) data is copied directly into the
 `Samples` data matrix; otherwise it is re-encoded.
+
+`dither_storage` keyword argument is used for `Onda.encode`. See `Onda.encode`'s
+docstring for more details.                                                        
 
 !!! note
 
@@ -620,7 +626,7 @@ a signal, its encoded (usually `Int16`) data is copied directly into the
 
 """
 function onda_samples_from_edf_signals(target::SamplesInfoV2, edf_signals,
-                                       edf_seconds_per_record)
+                                       edf_seconds_per_record; dither_storage)
     sample_count = length(first(edf_signals).samples)
     if !all(length(s.samples) == sample_count for s in edf_signals)
         error("mismatched sample counts between `EDF.Signal`s: ", [length(s.samples) for s in edf_signals])
@@ -639,7 +645,7 @@ function onda_samples_from_edf_signals(target::SamplesInfoV2, edf_signals,
                                           edf_signal.samples)
             encoded_samples = Onda.encode(sample_type(target), target.sample_resolution_in_unit,
                                           target.sample_offset_in_unit, decoded_samples,
-                                          missing)
+                                          dither_storage)
         else
             encoded_samples = edf_signal.samples
         end