edf2csv 0.9.39 → 0.9.41

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,7 +1679,29 @@ 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.
   
@@ -1712,7 +1734,7 @@ toStdout = false) {
         if (!writesSignals)
             return true;
         if (noRows)
-            return !NAMES_A_COLUMN.has(diagnostic.code);
+            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]));
     };
@@ -1822,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' : ''}.`),
             };
         }
@@ -1860,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
@@ -1917,6 +1952,37 @@ toStdout = false) {
                     `${records('the physical range the header gives')}`,
             };
         }
+        /*
+          And the one warning here that is about the printed text of a sample rather than a cell.
+    
+          `VALUE_RESOLUTION` says a channel's step is below any precision `toFixed` can print, so
+          consecutive samples land on the same text — and reassures the reader that nothing is
+          lost from the data: "Every sample is written, in order". A window holding none writes no
+          samples at all, which the warning under it says in as many words:
+    
+              warning: fine steps by less than any number of decimals this can print, so some
+                       consecutive samples round to the same value in signals.csv.
+                       Every sample is written, in order, and the physical values are computed
+                       at full precision either way.
+              warning: No samples fall inside the requested window (2.000s to 3.000s), so the
+                       signal file holds its header and no data.
+    
+          plan.ts already gives this reassurance its own branch where the rate overflows to
+          Infinity, on the stated grounds that "no rows are written at all, so 'Every sample is
+          written, in order' would be the third untrue sentence". This is that same sentence,
+          reached by the other route. `--annotations-only` and `--channels` never see it: the
+          warning is raised per rate group from the channels the plan converts, so a run that
+          converts none raises none.
+        */
+        if (diagnostic.code === 'VALUE_RESOLUTION') {
+            return {
+                ...diagnostic,
+                message: diagnostic.message.replace(' so some consecutive samples round to the same value in', ' so some consecutive samples would round to the same value in'),
+                hint: `No samples are converted ${because}, so none is rounded at all. The physical ` +
+                    'values are computed at full precision either way, and what a printed one loses ' +
+                    'is only in its text.',
+            };
+        }
         if (diagnostic.code === 'DEGENERATE_DIGITAL_RANGE') {
             return {
                 ...diagnostic,
@@ -2380,7 +2446,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,