edf2csv 0.9.38 → 0.9.40

package/dist/convert/run.d.ts

@@ -250,7 +250,7 @@ export declare function convertedChannels(plan: ConversionPlan): Set<number>;
  *
  * `writesSignals` rather than the option, because the plan is what settles it.
  */
-export declare function withSignalTableUnwritten(diagnostics: readonly Diagnostic[], writesSignals: boolean, gzip: boolean, converted?: ReadonlySet<number>, toStdout?: boolean): Diagnostic[];
+export declare function withSignalTableUnwritten(diagnostics: readonly Diagnostic[], writesSignals: boolean, gzip: boolean, converted?: ReadonlySet<number>, toStdout?: boolean, longLayout?: boolean): Diagnostic[];
 /**
  * The sidecar files a `--stdout` run does not write, taken out of the sentences about them.
  *

package/dist/convert/run.js

@@ -107,7 +107,7 @@ export async function convert(inputPath, options = {}) {
                 diagnostics: withSidecarsNamed(withSignalTableUnwritten([
                     ...withTimingPromiseKept(withoutFileRateWarning(file.diagnostics), timing.starts !== null),
                     ...plan.diagnostics,
-                ], plan.writeSignals, plan.gzip, convertedChannels(plan), true), { toStdout: true, gzip: plan.gzip }),
+                ], plan.writeSignals, plan.gzip, convertedChannels(plan), true, plan.layout === 'long'), { toStdout: true, gzip: plan.gzip }),
                 plan,
                 file,
                 elapsedMs: Date.now() - startedAt,
@@ -209,7 +209,7 @@ export async function convert(inputPath, options = {}) {
                 ...withTimingPromiseKept(withoutFileRateWarning(file.diagnostics), timing.starts !== null),
                 ...plan.diagnostics,
                 ...stale,
-            ], plan.writeSignals, plan.gzip, convertedChannels(plan)), { toStdout: false, gzip: plan.gzip }),
+            ], plan.writeSignals, plan.gzip, convertedChannels(plan), false, plan.layout === 'long'), { toStdout: false, gzip: plan.gzip }),
             plan,
             file,
             elapsedMs: Date.now() - startedAt,
@@ -1679,10 +1679,62 @@ converted = new Set(),
   thing `withSidecarsNamed` says one pass later about the sentences it knows. These are the
   ones it has never been shown: they do not exist until this pass writes them.
 */
-toStdout = false) {
+toStdout = false, 
+/*
+  And whether the run puts the channel names in rows rather than in a header.
+
+  The three rewrites this pass makes about a channel's *name* were deliberately left out of
+  the empty-window case at 0.9.39, on the grounds that a window holding no samples still
+  writes the signal file's header row, so every column is there and named exactly as those
+  sentences say. True of the wide layout, and of only the wide layout. A long signals.csv
+  is `time_s,channel,value`: a channel appears in it as a *value* in the channel column, so
+  a run with no rows names no channel anywhere, and all three went on saying it did:
+
+      $ edf2csv gappy.edf --layout long --start 2 --duration 1 --out ./converted
+      warning: Signal 0 has no label. It will appear as "signal_0".
+      warning: 2 signals share the label "dup" (positions #1, #2).
+               ... a column name each in the wide layout, and a distinct value in the
+               channel column under --layout long.
+      warning: No samples fall inside the requested window (2.000s to 3.000s), so the
+               signal file holds its header and no data.
+
+  `channels.csv` still carries the name, which is what the `--annotations-only` rewrites
+  have always offered in its place.
+*/
+longLayout = false) {
+    /*
+      And the third way to arrive with no cells and no rows, which is a window holding none.
+  
+      `--annotations-only` writes no signal table and `--channels` writes none for the channels
+      it leaves out; a window that falls in a gap, or past the last sample, writes the table and
+      nothing in it — "so the signal file holds its header and no data", which is the warning
+      sitting in this very list. The sentences above it went on describing the rows and cells of
+      a conversion that writes none of either:
+  
+          warning: Signal 1 ("dup") has digital minimum equal to digital maximum (0), so its
+                   values cannot be scaled.
+                   Its cells are left empty rather than filled with a value the header cannot
+                   justify.
+          warning: 2 data records start earlier than the record before them.
+                   Rows are written in file order, so the time column will not increase
+                   monotonically.
+          warning: No samples fall inside the requested window (2.000s to 3.000s), so the
+                   signal files hold their headers and no data.
+  
+      Taken from `EMPTY_WINDOW` rather than from a new argument, because that diagnostic is
+      already here and is the plan's own answer to the question — raised by `--info` and by a
+      conversion alike, so all four callers get it without being asked.
+  
+      The rewrites about a channel's *name* are not taken: an empty window still writes the
+      header row, so every column is there and named exactly as those three sentences say.
+    */
+    const NAMES_A_COLUMN = new Set(['EMPTY_LABEL', 'DUPLICATE_LABEL', 'NONPRINTABLE_LABEL']);
+    const noRows = writesSignals && diagnostics.some((d) => d.code === 'EMPTY_WINDOW');
     const skipped = (diagnostic) => {
         if (!writesSignals)
             return true;
+        if (noRows)
+            return longLayout || !NAMES_A_COLUMN.has(diagnostic.code);
         const named = /^Signal (\d+)\b/u.exec(diagnostic.message);
         return named !== null && !converted.has(Number(named[1]));
     };
@@ -1718,11 +1770,18 @@ toStdout = false) {
     return diagnostics.map((diagnostic) => {
         if (!skipped(diagnostic))
             return diagnostic;
-        // The reason the cells are missing, which is the only part that differs between the two.
-        const because = writesSignals ? 'for a channel --channels left out' : 'with --annotations-only';
-        // The run-level sentences below are only reached when no signal table is written at all:
-        // a selection leaves the rows alone, so nothing it excludes changes what the column says.
-        const writes = '--annotations-only writes no signal rows';
+        // The reason the cells are missing, which is the only part that differs between the three.
+        const because = !writesSignals
+            ? 'with --annotations-only'
+            : noRows
+                ? 'for a window that selects none'
+                : 'for a channel --channels left out';
+        // The run-level sentences below are reached when the run writes no signal rows at all,
+        // which a selection does not cause: it leaves the rows alone, so nothing it excludes
+        // changes what the time column says.
+        const writes = noRows
+            ? 'The requested window holds no samples'
+            : '--annotations-only writes no signal rows';
         /*
           And the three calibration warnings, whose hints are about cells.
     
@@ -1785,10 +1844,16 @@ toStdout = false) {
           happens, since the names are derived from the whole file so that they agree with
           channels.csv and across runs, and the column it is named for is one this run has not got.
         */
-        if (diagnostic.code === 'DUPLICATE_LABEL' && / so its column is "/u.test(diagnostic.message)) {
+        // Either noun the plan may have written: a column of the wide table, or the channel
+        // column a long one names it in. Both are places this run has no rows in.
+        if (diagnostic.code === 'DUPLICATE_LABEL' &&
+            / so (?:its column is "|it is named "[^"]*" in the channel column)/u.test(diagnostic.message)) {
             return {
                 ...diagnostic,
-                message: diagnostic.message.replace(/ so its column is ("[^"]*")\.$/u, ` so it is named $1 in ${channelsFile}'s column cell` +
+                message: diagnostic.message.replace(/ so (?:its column is ("[^"]*")|it is named ("[^"]*") in the channel column)\.$/u, 
+                // Whichever of the two groups matched carries the name; the other is undefined,
+                // and `$1` would have written an empty pair of quotes for the long-layout form.
+                (_all, wide, long) => ` so it is named ${wide ?? long} in ${channelsFile}'s column cell` +
                     `${toStdout ? ' in any conversion that writes one' : ''}.`),
             };
         }
@@ -1823,11 +1888,18 @@ toStdout = false) {
                 ...diagnostic,
                 hint: 'Their names are suffixed with the signal number so they stay distinguishable. ' +
                     (writesSignals
-                        ? toStdout
-                            ? `--channels left this channel out, and --stdout writes no ${channelsFile} for ` +
-                                `its suffixed name to appear in — convert to a directory for that.`
-                            : `--channels left this channel out, so its suffixed name appears in ` +
-                                `${channelsFile}'s column cell and nowhere else.`
+                        ? noRows
+                            ? toStdout
+                                ? `The requested window holds no samples, and --stdout writes no ` +
+                                    `${channelsFile} for the suffixed names to appear in — convert to a ` +
+                                    `directory for that.`
+                                : `The requested window holds no samples, so the suffixed names appear only ` +
+                                    `in ${channelsFile}'s column cells.`
+                            : toStdout
+                                ? `--channels left this channel out, and --stdout writes no ${channelsFile} for ` +
+                                    `its suffixed name to appear in — convert to a directory for that.`
+                                : `--channels left this channel out, so its suffixed name appears in ` +
+                                    `${channelsFile}'s column cell and nowhere else.`
                         : toStdout
                             ? // The one of the three this pass was extended without at 0.9.29. `--stdout`
                                 // writes no channels.csv either, and the report saying this goes on to say
@@ -2343,7 +2415,7 @@ bom) {
         notes: withSidecarsNamed(withSignalTableUnwritten([
             ...withTimingPromiseKept(withoutFileRateWarning(file.diagnostics), timedFromRecords),
             ...plan.diagnostics,
-        ], plan.writeSignals, plan.gzip, convertedChannels(plan)), 
+        ], plan.writeSignals, plan.gzip, convertedChannels(plan), false, plan.layout === 'long'), 
         // metadata.json is only written into a directory, so this is never the stdout case.
         { toStdout: false, gzip: plan.gzip }).map((d) => ({
             code: d.code,