Skip to content

Commit d1f052d

Browse files
PluzePluze
committed
docs: clear private helper contract debt
1 parent a734e89 commit d1f052d

65 files changed

Lines changed: 257 additions & 71 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎+labkit/+biosignal/private/detectEcgPeaksImpl.m‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
% Private biosignal helper. Expected caller: labkit.biosignal facade and
2+
% internal import/recording pipeline. Inputs and outputs use internal signal,
3+
% recording, time, or option values. Side effects: file reads only in importer
4+
% helpers; assumes public callers own workflow validation and user-facing errors.
15
function events = detectEcgPeaksImpl(signal, opts)
26
%DETECTECGPEAKSIMPL Dispatch the ECG peak detector behind detectEcgPeaks.
37
%

‎+labkit/+biosignal/private/fillVectorMissing.m‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
% Private biosignal helper. Expected caller: labkit.biosignal facade and
2+
% internal import/recording pipeline. Inputs and outputs use internal signal,
3+
% recording, time, or option values. Side effects: file reads only in importer
4+
% helpers; assumes public callers own workflow validation and user-facing errors.
15
function x = fillVectorMissing(x)
26
%FILLVECTORMISSING Fill missing numeric samples for private readers/filters.
37
%

‎+labkit/+biosignal/private/inferSampleRate.m‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
% Private biosignal helper. Expected caller: labkit.biosignal facade and
2+
% internal import/recording pipeline. Inputs and outputs use internal signal,
3+
% recording, time, or option values. Side effects: file reads only in importer
4+
% helpers; assumes public callers own workflow validation and user-facing errors.
15
function fs = inferSampleRate(timeSec)
26
%INFERSAMPLERATE Estimate sampling frequency from a seconds time vector.
37
%

‎+labkit/+biosignal/private/inferTableTime.m‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
% Private biosignal helper. Expected caller: labkit.biosignal facade and
2+
% internal import/recording pipeline. Inputs and outputs use internal signal,
3+
% recording, time, or option values. Side effects: file reads only in importer
4+
% helpers; assumes public callers own workflow validation and user-facing errors.
15
function [timeSec, timeColumn, info] = inferTableTime(T, opts, importInfo)
26
%INFERTABLETIME Infer and repair the time axis for a biosignal table.
37
%

‎+labkit/+biosignal/private/isTimeLikeName.m‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
% Private biosignal helper. Expected caller: labkit.biosignal facade and
2+
% internal import/recording pipeline. Inputs and outputs use internal signal,
3+
% recording, time, or option values. Side effects: file reads only in importer
4+
% helpers; assumes public callers own workflow validation and user-facing errors.
15
function tf = isTimeLikeName(name)
26
%ISTIMELIKENAME Identify table column names that should drive time inference.
37
%

‎+labkit/+biosignal/private/makeRecording.m‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
% Private biosignal helper. Expected caller: labkit.biosignal facade and
2+
% internal import/recording pipeline. Inputs and outputs use internal signal,
3+
% recording, time, or option values. Side effects: file reads only in importer
4+
% helpers; assumes public callers own workflow validation and user-facing errors.
15
function recording = makeRecording(filepath, sourceKind, signals)
26
%MAKERECORDING Build the private standard biosignal recording struct.
37
%

‎+labkit/+biosignal/private/makeSignalStruct.m‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
% Private biosignal helper. Expected caller: labkit.biosignal facade and
2+
% internal import/recording pipeline. Inputs and outputs use internal signal,
3+
% recording, time, or option values. Side effects: file reads only in importer
4+
% helpers; assumes public callers own workflow validation and user-facing errors.
15
function signal = makeSignalStruct(name, sourceName, timeSec, values, metadata, opts)
26
%MAKESIGNALSTRUCT Build a normalized private biosignal signal struct.
37
%

‎+labkit/+biosignal/private/numericColumn.m‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
% Private biosignal helper. Expected caller: labkit.biosignal facade and
2+
% internal import/recording pipeline. Inputs and outputs use internal signal,
3+
% recording, time, or option values. Side effects: file reads only in importer
4+
% helpers; assumes public callers own workflow validation and user-facing errors.
15
function [values, ok] = numericColumn(raw)
26
%NUMERICCOLUMN Convert a parsed table column to numeric values when possible.
37
%

‎+labkit/+biosignal/private/optionValue.m‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
% Private biosignal helper. Expected caller: labkit.biosignal facade and
2+
% internal import/recording pipeline. Inputs and outputs use internal signal,
3+
% recording, time, or option values. Side effects: file reads only in importer
4+
% helpers; assumes public callers own workflow validation and user-facing errors.
15
function value = optionValue(opts, name, defaultValue)
26
%OPTIONVALUE Return an option field or a default value without validation.
37
%

‎+labkit/+biosignal/private/readCsvRecording.m‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
% Private biosignal helper. Expected caller: labkit.biosignal facade and
2+
% internal import/recording pipeline. Inputs and outputs use internal signal,
3+
% recording, time, or option values. Side effects: file reads only in importer
4+
% helpers; assumes public callers own workflow validation and user-facing errors.
15
function recording = readCsvRecording(filepath, opts)
26
%READCSVRECORDING Read a CSV/TSV-style table into a biosignal recording.
37
%

0 commit comments

Comments
 (0)