edf2csv 0.9.17 → 0.9.19

package/dist/convert/run.d.ts

@@ -219,6 +219,15 @@ export declare function stdoutRefusal(file: EdfFile, plan: ConversionPlan): Conv
  * on is in the file and the plan, both of which `--info` already has.
  */
 export declare function noSignalFile(file: EdfFile, plan: ConversionPlan): Diagnostic | null;
+/**
+ * The channels whose samples this run actually writes.
+ *
+ * `plan.columnNames` names every channel of the recording, because the names are derived from
+ * the whole file rather than from the selection — so it is not the answer. The groups are:
+ * `--channels` builds them out of what was selected, and a channel with no samples per record
+ * has none to put in one either.
+ */
+export declare function convertedChannels(plan: ConversionPlan): Set<number>;
 /**
  * The signal table an `--annotations-only` run does not write, taken out of the hints about it.
  *
@@ -241,7 +250,7 @@ export declare function noSignalFile(file: EdfFile, plan: ConversionPlan): Diagn
  *
  * `writesSignals` rather than the option, because the plan is what settles it.
  */
-export declare function withSignalTableUnwritten(diagnostics: readonly Diagnostic[], writesSignals: boolean, gzip: boolean): Diagnostic[];
+export declare function withSignalTableUnwritten(diagnostics: readonly Diagnostic[], writesSignals: boolean, gzip: boolean, converted?: ReadonlySet<number>): 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), { toStdout: true, gzip: plan.gzip }),
+                ], plan.writeSignals, plan.gzip, convertedChannels(plan)), { 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), { toStdout: false, gzip: plan.gzip }),
+            ], plan.writeSignals, plan.gzip, convertedChannels(plan)), { toStdout: false, gzip: plan.gzip }),
             plan,
             file,
             elapsedMs: Date.now() - startedAt,
@@ -1606,6 +1606,17 @@ export function noSignalFile(file, plan) {
                     `table --info prints, and in the ${outputCsvName('channels', plan.gzip)} a conversion writes.`,
     };
 }
+/**
+ * The channels whose samples this run actually writes.
+ *
+ * `plan.columnNames` names every channel of the recording, because the names are derived from
+ * the whole file rather than from the selection — so it is not the answer. The groups are:
+ * `--channels` builds them out of what was selected, and a channel with no samples per record
+ * has none to put in one either.
+ */
+export function convertedChannels(plan) {
+    return new Set(plan.groups.flatMap((group) => group.channels.map((c) => c.signal.index)));
+}
 /**
  * The signal table an `--annotations-only` run does not write, taken out of the hints about it.
  *
@@ -1628,8 +1639,34 @@ export function noSignalFile(file, plan) {
  *
  * `writesSignals` rather than the option, because the plan is what settles it.
  */
-export function withSignalTableUnwritten(diagnostics, writesSignals, gzip) {
-    if (writesSignals)
+export function withSignalTableUnwritten(diagnostics, writesSignals, gzip, 
+/*
+  And the channels this run leaves out, which is the same question one channel at a time.
+
+  `--annotations-only` writes no cells for any channel; `--channels` writes none for the
+  ones it excludes, and the five sentences below are as untrue of those as they are of the
+  whole run. `--info` prints `(not selected)` in the OUTPUT column for them and channels.csv
+  records them with `converted: no`, and the warning three lines under the table said:
+
+      0  flat      flat  uV  4 Hz  0 to 0     (not selected)
+      ...
+      warning: Signal 0 ("flat") 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.
+
+  There are no cells. Under `--strict` that is a failed run over a channel this one does not
+  touch. The rewrites are the same rewrites, so the set of them is the argument rather than
+  a second copy: empty means no signal table at all, which is what `writesSignals` said.
+*/
+converted = new Set()) {
+    const skipped = (diagnostic) => {
+        if (!writesSignals)
+            return true;
+        const named = /^Signal (\d+)\b/u.exec(diagnostic.message);
+        return named !== null && !converted.has(Number(named[1]));
+    };
+    if (writesSignals && diagnostics.every((d) => !skipped(d)))
         return [...diagnostics];
     /*
       The sidecars named here are named as the run writes them.
@@ -1643,6 +1680,13 @@ export function withSignalTableUnwritten(diagnostics, writesSignals, gzip) {
     const channelsFile = outputCsvName('channels', gzip);
     const annotationsFile = outputCsvName('annotations', gzip);
     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';
         /*
           And the three calibration warnings, whose hints are about cells.
     
@@ -1689,19 +1733,37 @@ export function withSignalTableUnwritten(diagnostics, writesSignals, gzip) {
                     .replace(' in any conversion that writes one', ''),
             };
         }
+        /*
+          And the channel that lost its own name, whose sentence ends in a column.
+    
+          plan.ts writes "so its column is `X`" for a run that writes a signal table and "so it is
+          named `X` in channels.csv's column cell" for one that does not — decided by the run,
+          because that is all it knows there. A selection decides it per channel: the rename still
+          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)) {
+            return {
+                ...diagnostic,
+                message: diagnostic.message.replace(/ so its column is ("[^"]*")\.$/u, ` so it is named $1 in ${channelsFile}'s column cell.`),
+            };
+        }
         if (diagnostic.code === 'DUPLICATE_LABEL' &&
             diagnostic.hint?.startsWith('Their names are suffixed')) {
             return {
                 ...diagnostic,
                 hint: 'Their names are suffixed with the signal number so they stay distinguishable. ' +
-                    '--annotations-only writes no signal table, so the suffixed names appear only in ' +
-                    `${channelsFile}'s column cells.`,
+                    (writesSignals
+                        ? `--channels left this channel out, so its suffixed name appears in ` +
+                            `${channelsFile}'s column cell and nowhere else.`
+                        : '--annotations-only writes no signal table, so the suffixed names appear only ' +
+                            `in ${channelsFile}'s column cells.`),
             };
         }
         if (diagnostic.code === 'DEGENERATE_DIGITAL_RANGE') {
             return {
                 ...diagnostic,
-                hint: 'No samples are converted with --annotations-only, so there are no cells to leave ' +
+                hint: `No samples are converted ${because}, so there are no cells to leave ` +
                     `empty. ${channelsFile} still records the digital range the header gives.`,
             };
         }
@@ -1709,14 +1771,14 @@ export function withSignalTableUnwritten(diagnostics, writesSignals, gzip) {
             return {
                 ...diagnostic,
                 message: diagnostic.message.replace('so every sample converts to the same value.', 'so every sample would convert to the same value.'),
-                hint: `No samples are converted with --annotations-only. ${channelsFile} still records ` +
+                hint: `No samples are converted ${because}. ${channelsFile} still records ` +
                     'the calibration, one point wide.',
             };
         }
         if (diagnostic.code === 'INVERTED_PHYSICAL_RANGE') {
             return {
                 ...diagnostic,
-                hint: `No samples are converted with --annotations-only. ${channelsFile} records the ` +
+                hint: `No samples are converted ${because}. ${channelsFile} records the ` +
                     'physical minimum and maximum in the order the header gives them, inversion included.',
             };
         }
@@ -1731,7 +1793,7 @@ export function withSignalTableUnwritten(diagnostics, writesSignals, gzip) {
             const one = diagnostic.hint.startsWith('That record');
             return {
                 ...diagnostic,
-                hint: `--annotations-only writes no signal rows, so nothing is timed from ${one ? 'that record' : 'those records'}. ` +
+                hint: `${writes}, so nothing is timed from ${one ? 'that record' : 'those records'}. ` +
                     `The events in ${one ? 'it' : 'them'} carry their own onsets, and ` +
                     `${annotationsFile}'s record_index still names ${one ? 'it' : 'them'}.`,
             };
@@ -1741,7 +1803,7 @@ export function withSignalTableUnwritten(diagnostics, writesSignals, gzip) {
         if (diagnostic.hint.startsWith('Each row carries its true recording time')) {
             return {
                 ...diagnostic,
-                hint: '--annotations-only writes no signal rows, so nothing here is timed from the ' +
+                hint: `${writes}, so nothing here is timed from the ` +
                     `records. ${annotationsFile} carries each event's own onset, and the record it ` +
                     'came from in record_index.',
             };
@@ -1749,14 +1811,14 @@ export function withSignalTableUnwritten(diagnostics, writesSignals, gzip) {
         if (diagnostic.hint.startsWith('Rows are written in file order')) {
             return {
                 ...diagnostic,
-                hint: '--annotations-only writes no signal rows, so no time column is affected. ' +
+                hint: `${writes}, so no time column is affected. ` +
                     `${annotationsFile}'s record_index still names the record each event came from.`,
             };
         }
         if (diagnostic.hint.startsWith('Sample times are written from zero')) {
             return {
                 ...diagnostic,
-                hint: '--annotations-only writes no signal rows, so no sample times are written at all.',
+                hint: `${writes}, so no sample times are written at all.`,
             };
         }
         /*
@@ -1787,7 +1849,7 @@ export function withSignalTableUnwritten(diagnostics, writesSignals, gzip) {
         if (diagnostic.hint.startsWith('Times are written as if the records were contiguous')) {
             return {
                 ...diagnostic,
-                hint: '--annotations-only writes no signal rows, so no times are written from the ' +
+                hint: `${writes}, so no times are written from the ` +
                     `records at all. ${annotationsFile} carries each event's own onset, which the ` +
                     'records do not decide.',
             };
@@ -1799,7 +1861,7 @@ export function withSignalTableUnwritten(diagnostics, writesSignals, gzip) {
             return {
                 ...diagnostic,
                 hint: 'Where its records sit in time is not recorded in this file, and ' +
-                    '--annotations-only writes no signal rows to time from them anyway — see the ' +
+                    `${writes} to time from them anyway — see the ` +
                     'warning below.',
             };
         }
@@ -2122,7 +2184,7 @@ bom) {
         notes: withSidecarsNamed(withSignalTableUnwritten([
             ...withTimingPromiseKept(withoutFileRateWarning(file.diagnostics), timedFromRecords),
             ...plan.diagnostics,
-        ], plan.writeSignals, plan.gzip), 
+        ], plan.writeSignals, plan.gzip, convertedChannels(plan)), 
         // 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,