edfcore 0.5.53 → 0.5.55
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/docs/CHANGELOG.md +38 -0
- package/package.json +1 -1
- package/src/constants.ts +1 -1
package/dist/constants.d.ts
CHANGED
|
@@ -109,5 +109,5 @@ export declare const SIGNAL_FIELD_BLOCK_OFFSETS: {
|
|
|
109
109
|
readonly reserved: 224;
|
|
110
110
|
};
|
|
111
111
|
/** Published package version. Kept in sync with package.json by a test. */
|
|
112
|
-
export declare const VERSION = "0.5.
|
|
112
|
+
export declare const VERSION = "0.5.55";
|
|
113
113
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.js
CHANGED
package/docs/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,44 @@ alone does not tell you whether you were affected.
|
|
|
6
6
|
edfcore is pre-1.0. Patch releases have carried behaviour changes where the old behaviour was a
|
|
7
7
|
defect; those are called out below.
|
|
8
8
|
|
|
9
|
+
## 0.5.55
|
|
10
|
+
|
|
11
|
+
- **Added** the window that begins before the recording does. "A window that starts before record 0
|
|
12
|
+
is how a pre-stimulus epoch is spelled" is the sentence `tal/ticks.ts` uses to justify `floorDiv`
|
|
13
|
+
and `ceilDiv` existing at all, and `annotations.md` builds a section on negative onsets around the
|
|
14
|
+
same idea. 0.5.15 tested the two divisions; what a caller actually writes —
|
|
15
|
+
`readWindow(recording, { startSeconds: -2, durationSeconds: 4 })` — was tested for its bounds and
|
|
16
|
+
not for the negative side of them.
|
|
17
|
+
- There are three outcomes and only one is an error, and it is not the one a reader expects. A
|
|
18
|
+
window straddling t = 0 is read, clamped to the samples that exist. A window entirely before the
|
|
19
|
+
recording comes back as `[]` — the same empty array a window past the end gives, which
|
|
20
|
+
`api-reading.md` says in as many words. Nothing throws for either: a negative bound is a
|
|
21
|
+
legitimate question with a possibly empty answer, and only a non-finite one is a mistake.
|
|
22
|
+
- The trimmed result is where it matters, and it is asserted sample for sample.
|
|
23
|
+
`trimToWindow(header, series, -2, 4)` starts at 0 rather than at -2 and holds exactly the samples
|
|
24
|
+
in `[0, 2)` — the arithmetic that needs a floor rather than a truncation, on operands that are
|
|
25
|
+
negative for the whole first half of the window. A bound that is not a whole second is checked
|
|
26
|
+
with it, and `sampleAt` is checked either side of the boundary.
|
|
27
|
+
|
|
28
|
+
## 0.5.54
|
|
29
|
+
|
|
30
|
+
- **Added** the claim the `index` option on `validateRecording` is only worth having if it holds: a
|
|
31
|
+
sweep that was handed an index says what a sweep that read one says. `api-validate.md` prices the
|
|
32
|
+
option — a supplied complete index is the difference between a scan of every record and no
|
|
33
|
+
traversal at all — and `inspect-validate.test.ts` checks that it does skip the traversal and that
|
|
34
|
+
a probed index is not accepted as a substitute. Nothing checked that the report is the same.
|
|
35
|
+
- It is a real risk rather than a formality. The two paths reach `segmentCount` and `gaps` through
|
|
36
|
+
different code — one from `buildSegmentation` over onsets it just read, the other from the
|
|
37
|
+
`segments` and `gaps` already on the supplied index — and everything the report says about
|
|
38
|
+
structure is derived from those two. A supplied index that produced a different segment count
|
|
39
|
+
would be a faster answer to a different question.
|
|
40
|
+
- Both now run over every shape in the matrix and are compared whole, with `scanSamples` on so the
|
|
41
|
+
sample statistics are in it: `ok`, every diagnostic and every entry of `signalStats`. The matrix
|
|
42
|
+
is asserted to reach both verdicts and to produce real statistics, so the comparison is of
|
|
43
|
+
something.
|
|
44
|
+
- `bytesRead` is the one number that legitimately differs, and it is asserted to be lower — on the
|
|
45
|
+
files where there is anything to skip, which is the reason the option exists.
|
|
46
|
+
|
|
9
47
|
## 0.5.53
|
|
10
48
|
|
|
11
49
|
- **Added** the CLI's half of determinism. `diagnostics.md` says of the formatter underneath it that
|
package/package.json
CHANGED
package/src/constants.ts
CHANGED