react-cheminfo 0.28.0 → 0.29.0

package/lib/ir/core/assignBands.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Matching picked bands against the correlation table.
+ *
+ * Every assignment whose range contains the band is kept, and that is the whole
+ * design: infrared assignment is not a lookup with one answer, and a viewer that
+ * showed only the best-fitting vibration would be asserting a structure the
+ * spectrum does not determine. A band at 1715 cm⁻¹ comes back as four
+ * candidates, ordered so the most specific claim reads first, and choosing
+ * between them is the chemist's job — which is what the `note` on each is for.
+ */
+import type { BandAssignment } from './bandAssignments.ts';
+import type { IrBand } from './irBand.ts';
+/** One band, with everything it might be. */
+export interface AssignedBand {
+    /** The band that was picked. */
+    band: IrBand;
+    /**
+     * Every vibration whose range contains it, narrowest range first.
+     *
+     * Narrowest first because a narrow range is a more specific claim: at
+     * 1745 cm⁻¹ the ester's fifteen-wavenumber window says more than the
+     * anhydride's ninety, so it is the one worth reading first. Empty for a band
+     * in a region the table says nothing about, which is most of the fingerprint.
+     */
+    candidates: BandAssignment[];
+}
+/** How bands are assigned. */
+export interface AssignBandsOptions {
+    /**
+     * The table to match against.
+     * @default BAND_ASSIGNMENTS
+     */
+    assignments?: readonly BandAssignment[];
+    /**
+     * How far outside a range a band may still fall, in cm⁻¹.
+     *
+     * The ranges are conventional values rounded to tens, and a real band sits a
+     * few wavenumbers either side of where a table puts it — a ketone at 1703 is
+     * a ketone. Widening every range by a little is honest about that, where
+     * matching exactly would leave the strongest band in the spectrum unassigned
+     * for being two wavenumbers low.
+     * @default 5
+     */
+    tolerance?: number;
+    /**
+     * Whether a band whose strength disagrees with the table is still offered.
+     *
+     * It is, by default. A weak band where the table expects a strong one is
+     * evidence about concentration or about the assignment being wrong, and either
+     * way it is evidence the reader should see rather than have filtered away.
+     * @default true
+     */
+    keepStrengthMismatch?: boolean;
+}
+/**
+ * Assign every band, keeping every candidate.
+ * @param bands - The bands that were picked.
+ * @param options - The table, and how tightly to match it.
+ * @returns One entry per band, in the order the bands were given.
+ */
+export declare function assignBands(bands: readonly IrBand[], options?: AssignBandsOptions): AssignedBand[];
+/**
+ * How many of the bands the table had something to say about.
+ *
+ * Reported as a count rather than a fraction, because the denominator is the
+ * number of bands picked and that follows the picking threshold — a coverage
+ * percentage would move when somebody adjusted a slider, and read as the
+ * assignment having improved.
+ * @param assigned - The assigned bands.
+ * @returns How many carry at least one candidate.
+ */
+export declare function countAssigned(assigned: readonly AssignedBand[]): number;
+/**
+ * The name to write on a band, when there is room for one line.
+ *
+ * The narrowest candidate's group and vibration, which is the first of the
+ * ranked list — the same order the panel shows, so the chart and the table never
+ * disagree about which claim leads.
+ * @param entry - One assigned band.
+ * @returns The label, or `null` when nothing was assigned.
+ */
+export declare function bandLabel(entry: AssignedBand): string | null;
+//# sourceMappingURL=assignBands.d.ts.map

package/lib/ir/core/assignBands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assignBands.d.ts","sourceRoot":"","sources":["../../../src/ir/core/assignBands.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,6CAA6C;AAC7C,MAAM,WAAW,YAAY;IAC3B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;OAOG;IACH,UAAU,EAAE,cAAc,EAAE,CAAC;CAC9B;AAED,8BAA8B;AAC9B,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;IACxC;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,OAAO,GAAE,kBAAuB,GAC/B,YAAY,EAAE,CA6BhB;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,SAAS,YAAY,EAAE,GAAG,MAAM,CAMvE;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,GAAG,IAAI,CAI5D"}

package/lib/ir/core/assignBands.js

@@ -0,0 +1,83 @@
+/**
+ * Matching picked bands against the correlation table.
+ *
+ * Every assignment whose range contains the band is kept, and that is the whole
+ * design: infrared assignment is not a lookup with one answer, and a viewer that
+ * showed only the best-fitting vibration would be asserting a structure the
+ * spectrum does not determine. A band at 1715 cm⁻¹ comes back as four
+ * candidates, ordered so the most specific claim reads first, and choosing
+ * between them is the chemist's job — which is what the `note` on each is for.
+ */
+import { BAND_ASSIGNMENTS } from "./bandAssignments.js";
+/**
+ * Assign every band, keeping every candidate.
+ * @param bands - The bands that were picked.
+ * @param options - The table, and how tightly to match it.
+ * @returns One entry per band, in the order the bands were given.
+ */
+export function assignBands(bands, options = {}) {
+    const { assignments = BAND_ASSIGNMENTS, tolerance = 5, keepStrengthMismatch = true, } = options;
+    const assigned = new Array(bands.length);
+    for (let index = 0; index < bands.length; index++) {
+        const band = bands[index];
+        const candidates = [];
+        for (const assignment of assignments) {
+            if (band.wavenumber < assignment.from - tolerance ||
+                band.wavenumber > assignment.to + tolerance) {
+                continue;
+            }
+            if (!keepStrengthMismatch && assignment.strength !== band.strength) {
+                continue;
+            }
+            candidates.push(assignment);
+        }
+        assigned[index] = {
+            band,
+            candidates: candidates.toSorted(byNarrowestRange),
+        };
+    }
+    return assigned;
+}
+/**
+ * How many of the bands the table had something to say about.
+ *
+ * Reported as a count rather than a fraction, because the denominator is the
+ * number of bands picked and that follows the picking threshold — a coverage
+ * percentage would move when somebody adjusted a slider, and read as the
+ * assignment having improved.
+ * @param assigned - The assigned bands.
+ * @returns How many carry at least one candidate.
+ */
+export function countAssigned(assigned) {
+    let count = 0;
+    for (const entry of assigned) {
+        if (entry.candidates.length > 0)
+            count++;
+    }
+    return count;
+}
+/**
+ * The name to write on a band, when there is room for one line.
+ *
+ * The narrowest candidate's group and vibration, which is the first of the
+ * ranked list — the same order the panel shows, so the chart and the table never
+ * disagree about which claim leads.
+ * @param entry - One assigned band.
+ * @returns The label, or `null` when nothing was assigned.
+ */
+export function bandLabel(entry) {
+    const best = entry.candidates[0];
+    if (best === undefined)
+        return null;
+    return `${best.group} ${best.vibration}`;
+}
+/**
+ * Order two assignments by how specific they are, narrowest range first.
+ * @param first - One assignment.
+ * @param second - The other.
+ * @returns The comparison; equal widths keep the table's own order.
+ */
+function byNarrowestRange(first, second) {
+    return first.to - first.from - (second.to - second.from);
+}
+//# sourceMappingURL=assignBands.js.map

package/lib/ir/core/assignBands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assignBands.js","sourceRoot":"","sources":["../../../src/ir/core/assignBands.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AA+CxD;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CACzB,KAAwB,EACxB,UAA8B,EAAE;IAEhC,MAAM,EACJ,WAAW,GAAG,gBAAgB,EAC9B,SAAS,GAAG,CAAC,EACb,oBAAoB,GAAG,IAAI,GAC5B,GAAG,OAAO,CAAC;IAEZ,MAAM,QAAQ,GAAmB,IAAI,KAAK,CAAe,KAAK,CAAC,MAAM,CAAC,CAAC;IACvE,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QAClD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAW,CAAC;QACpC,MAAM,UAAU,GAAqB,EAAE,CAAC;QACxC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,IACE,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,IAAI,GAAG,SAAS;gBAC7C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,EAAE,GAAG,SAAS,EAC3C,CAAC;gBACD,SAAS;YACX,CAAC;YACD,IAAI,CAAC,oBAAoB,IAAI,UAAU,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACnE,SAAS;YACX,CAAC;YACD,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9B,CAAC;QACD,QAAQ,CAAC,KAAK,CAAC,GAAG;YAChB,IAAI;YACJ,UAAU,EAAE,UAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC;SAClD,CAAC;IACJ,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,QAAiC;IAC7D,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC7B,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;YAAE,KAAK,EAAE,CAAC;IAC3C,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CAAC,KAAmB;IAC3C,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACjC,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACpC,OAAO,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;AAC3C,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,KAAqB,EACrB,MAAsB;IAEtB,OAAO,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;AAC3D,CAAC"}

package/lib/ir/core/bandAssignments.d.ts

@@ -0,0 +1,47 @@
+/**
+ * The correlation table: which vibration a band at a given wavenumber may be.
+ *
+ * This is the infrared analogue of a fragment set — what a producer *claims*
+ * about a spectrum — with one difference that shapes the whole design: a mass
+ * fragment claims one m/z, while a vibration claims a **range**, and the ranges
+ * overlap heavily on purpose. A band at 1715 cm⁻¹ is an ester, an aldehyde, a
+ * ketone and a carboxylic acid until something else decides between them, and a
+ * table that returned one answer there would be inventing chemistry.
+ *
+ * The ranges are the conventional teaching values, rounded to the tens that a
+ * printed table uses. They are deliberately not narrowed to look precise: a
+ * conjugated ketone really does absorb below an unconjugated one, and a table
+ * that excluded it would read as ruling the ketone out.
+ */
+import type { IrBandStrength } from './irBand.ts';
+/** One vibration a band may be, as a correlation table states it. */
+export interface BandAssignment {
+    /** Identity, stable so a selection survives a re-pick. */
+    id: string;
+    /** The functional group it belongs to, as a chemist names it. */
+    group: string;
+    /** The motion itself: which bond, and how it moves. */
+    vibration: string;
+    /** Lowest wavenumber of the range, in cm⁻¹. */
+    from: number;
+    /** Highest wavenumber of the range, in cm⁻¹. */
+    to: number;
+    /** How strong the band usually is, in the table's own letters. */
+    strength: IrBandStrength;
+    /**
+     * What tells this assignment apart from the others it overlaps — the shape of
+     * the band, a partner band elsewhere, a region it must be absent from.
+     * @default undefined
+     */
+    note?: string;
+}
+/**
+ * The table, in ascending order of the low end of each range.
+ *
+ * Ordered so that a reader scanning it moves along the axis, and so that the
+ * fingerprint region below 1500 cm⁻¹ — where assignments are least decisive —
+ * sits together at the top rather than being interleaved with the diagnostic
+ * stretches above it.
+ */
+export declare const BAND_ASSIGNMENTS: readonly BandAssignment[];
+//# sourceMappingURL=bandAssignments.d.ts.map

package/lib/ir/core/bandAssignments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bandAssignments.d.ts","sourceRoot":"","sources":["../../../src/ir/core/bandAssignments.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,qEAAqE;AACrE,MAAM,WAAW,cAAc;IAC7B,0DAA0D;IAC1D,EAAE,EAAE,MAAM,CAAC;IACX,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,EAAE,EAAE,MAAM,CAAC;IACX,kEAAkE;IAClE,QAAQ,EAAE,cAAc,CAAC;IACzB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAAS,cAAc,EAwRrD,CAAC"}

package/lib/ir/core/bandAssignments.js

@@ -0,0 +1,305 @@
+/**
+ * The correlation table: which vibration a band at a given wavenumber may be.
+ *
+ * This is the infrared analogue of a fragment set — what a producer *claims*
+ * about a spectrum — with one difference that shapes the whole design: a mass
+ * fragment claims one m/z, while a vibration claims a **range**, and the ranges
+ * overlap heavily on purpose. A band at 1715 cm⁻¹ is an ester, an aldehyde, a
+ * ketone and a carboxylic acid until something else decides between them, and a
+ * table that returned one answer there would be inventing chemistry.
+ *
+ * The ranges are the conventional teaching values, rounded to the tens that a
+ * printed table uses. They are deliberately not narrowed to look precise: a
+ * conjugated ketone really does absorb below an unconjugated one, and a table
+ * that excluded it would read as ruling the ketone out.
+ */
+/**
+ * The table, in ascending order of the low end of each range.
+ *
+ * Ordered so that a reader scanning it moves along the axis, and so that the
+ * fingerprint region below 1500 cm⁻¹ — where assignments are least decisive —
+ * sits together at the top rather than being interleaved with the diagnostic
+ * stretches above it.
+ */
+export const BAND_ASSIGNMENTS = [
+    {
+        id: 'c-br-stretch',
+        group: 'alkyl bromide',
+        vibration: 'C–Br stretch',
+        from: 500,
+        to: 600,
+        strength: 'S',
+    },
+    {
+        id: 'c-cl-stretch',
+        group: 'alkyl chloride',
+        vibration: 'C–Cl stretch',
+        from: 600,
+        to: 800,
+        strength: 'S',
+    },
+    {
+        id: 'aromatic-ch-oop',
+        group: 'arene',
+        vibration: 'C–H out-of-plane bend',
+        from: 690,
+        to: 900,
+        strength: 'S',
+        note: 'How many bands, and where, is what tells a substitution pattern apart',
+    },
+    {
+        id: 'alkene-ch-oop',
+        group: 'alkene',
+        vibration: '=C–H out-of-plane bend',
+        from: 890,
+        to: 990,
+        strength: 'S',
+        note: 'A terminal vinyl gives two, near 910 and 990',
+    },
+    {
+        id: 'c-o-stretch',
+        group: 'alcohol, ether, ester',
+        vibration: 'C–O stretch',
+        from: 1000,
+        to: 1300,
+        strength: 'S',
+        note: 'Strong and broad; an ester shows two, the higher one near 1200',
+    },
+    {
+        id: 'c-f-stretch',
+        group: 'alkyl fluoride',
+        vibration: 'C–F stretch',
+        from: 1000,
+        to: 1400,
+        strength: 'S',
+    },
+    {
+        id: 'c-n-stretch',
+        group: 'amine, amide',
+        vibration: 'C–N stretch',
+        from: 1080,
+        to: 1360,
+        strength: 'm',
+    },
+    {
+        id: 'nitro-symmetric',
+        group: 'nitro',
+        vibration: 'N–O symmetric stretch',
+        from: 1300,
+        to: 1390,
+        strength: 'S',
+        note: 'Never alone: the asymmetric partner sits near 1500–1560',
+    },
+    {
+        id: 'oh-bend',
+        group: 'alcohol',
+        vibration: 'O–H bend',
+        from: 1330,
+        to: 1430,
+        strength: 'm',
+    },
+    {
+        id: 'alkane-ch-bend',
+        group: 'alkane',
+        vibration: 'C–H bend',
+        from: 1370,
+        to: 1470,
+        strength: 'm',
+        note: 'A gem-dimethyl splits the 1380 band in two',
+    },
+    {
+        id: 'aromatic-cc-stretch',
+        group: 'arene',
+        vibration: 'C=C aromatic stretch',
+        from: 1450,
+        to: 1600,
+        strength: 'm',
+        note: 'Usually a pair, near 1500 and 1600',
+    },
+    {
+        id: 'nitro-asymmetric',
+        group: 'nitro',
+        vibration: 'N–O asymmetric stretch',
+        from: 1500,
+        to: 1560,
+        strength: 'S',
+    },
+    {
+        id: 'nh-bend',
+        group: 'amine, amide',
+        vibration: 'N–H bend',
+        from: 1550,
+        to: 1640,
+        strength: 'm',
+    },
+    {
+        id: 'alkene-cc-stretch',
+        group: 'alkene',
+        vibration: 'C=C stretch',
+        from: 1620,
+        to: 1680,
+        strength: 'w',
+        note: 'Weak, and absent altogether on a symmetric alkene',
+    },
+    {
+        id: 'amide-co-stretch',
+        group: 'amide',
+        vibration: 'C=O stretch',
+        from: 1630,
+        to: 1690,
+        strength: 'S',
+        note: 'The lowest carbonyl there is; look for N–H above 3300 to confirm',
+    },
+    {
+        id: 'acid-co-stretch',
+        group: 'carboxylic acid',
+        vibration: 'C=O stretch',
+        from: 1700,
+        to: 1725,
+        strength: 'S',
+        note: 'Confirmed by the very broad O–H between 2500 and 3300',
+    },
+    {
+        id: 'ketone-co-stretch',
+        group: 'ketone',
+        vibration: 'C=O stretch',
+        from: 1705,
+        to: 1725,
+        strength: 'S',
+        note: 'Conjugation drops it by about 30; a strained ring raises it',
+    },
+    {
+        id: 'aldehyde-co-stretch',
+        group: 'aldehyde',
+        vibration: 'C=O stretch',
+        from: 1720,
+        to: 1740,
+        strength: 'S',
+        note: 'Confirmed by the C–H pair near 2720 and 2820',
+    },
+    {
+        id: 'ester-co-stretch',
+        group: 'ester',
+        vibration: 'C=O stretch',
+        from: 1735,
+        to: 1750,
+        strength: 'S',
+        note: 'Confirmed by the strong C–O between 1000 and 1300',
+    },
+    {
+        id: 'acid-chloride-co-stretch',
+        group: 'acid chloride',
+        vibration: 'C=O stretch',
+        from: 1770,
+        to: 1815,
+        strength: 'S',
+    },
+    {
+        id: 'anhydride-co-stretch',
+        group: 'anhydride',
+        vibration: 'C=O stretch',
+        from: 1740,
+        to: 1830,
+        strength: 'S',
+        note: 'Two bands, about 60 apart, which is what names it',
+    },
+    {
+        id: 'nitrile-stretch',
+        group: 'nitrile',
+        vibration: 'C≡N stretch',
+        from: 2210,
+        to: 2260,
+        strength: 'm',
+        note: 'Sharp, and in a region almost nothing else occupies',
+    },
+    {
+        id: 'alkyne-cc-stretch',
+        group: 'alkyne',
+        vibration: 'C≡C stretch',
+        from: 2100,
+        to: 2260,
+        strength: 'w',
+        note: 'Weak, and absent on a symmetric internal alkyne',
+    },
+    {
+        id: 'aldehyde-ch-stretch',
+        group: 'aldehyde',
+        vibration: 'C–H stretch',
+        from: 2695,
+        to: 2830,
+        strength: 'm',
+        note: 'The diagnostic pair near 2720 and 2820',
+    },
+    {
+        id: 'acid-oh-stretch',
+        group: 'carboxylic acid',
+        vibration: 'O–H stretch',
+        from: 2500,
+        to: 3300,
+        strength: 'S',
+        note: 'Very broad — it runs under the C–H bands rather than beside them',
+    },
+    {
+        id: 'alkane-ch-stretch',
+        group: 'alkane',
+        vibration: 'C–H stretch',
+        from: 2850,
+        to: 3000,
+        strength: 'S',
+        note: 'Below 3000, which is what separates it from an alkene C–H',
+    },
+    {
+        id: 'alkene-ch-stretch',
+        group: 'alkene',
+        vibration: '=C–H stretch',
+        from: 3000,
+        to: 3100,
+        strength: 'm',
+        note: 'Above 3000, and never alone: the C=C sits near 1650',
+    },
+    {
+        id: 'aromatic-ch-stretch',
+        group: 'arene',
+        vibration: 'C–H stretch',
+        from: 3000,
+        to: 3100,
+        strength: 'm',
+    },
+    {
+        id: 'alkyne-ch-stretch',
+        group: 'alkyne',
+        vibration: '≡C–H stretch',
+        from: 3260,
+        to: 3330,
+        strength: 'S',
+        note: 'Sharp, where an O–H in the same place is broad',
+    },
+    {
+        id: 'alcohol-oh-stretch',
+        group: 'alcohol',
+        vibration: 'O–H stretch',
+        from: 3200,
+        to: 3600,
+        strength: 'S',
+        note: 'Broad when hydrogen bonded, which is nearly always',
+    },
+    {
+        id: 'nh-stretch',
+        group: 'amine, amide',
+        vibration: 'N–H stretch',
+        from: 3300,
+        to: 3500,
+        strength: 'm',
+        note: 'A primary amine gives two bands, a secondary one',
+    },
+    {
+        id: 'free-oh-stretch',
+        group: 'alcohol',
+        vibration: 'O–H stretch, not hydrogen bonded',
+        from: 3580,
+        to: 3650,
+        strength: 'm',
+        note: 'Sharp, and only in a dilute or gas-phase spectrum',
+    },
+];
+//# sourceMappingURL=bandAssignments.js.map

package/lib/ir/core/bandAssignments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bandAssignments.js","sourceRoot":"","sources":["../../../src/ir/core/bandAssignments.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AA0BH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA8B;IACzD;QACE,EAAE,EAAE,cAAc;QAClB,KAAK,EAAE,eAAe;QACtB,SAAS,EAAE,cAAc;QACzB,IAAI,EAAE,GAAG;QACT,EAAE,EAAE,GAAG;QACP,QAAQ,EAAE,GAAG;KACd;IACD;QACE,EAAE,EAAE,cAAc;QAClB,KAAK,EAAE,gBAAgB;QACvB,SAAS,EAAE,cAAc;QACzB,IAAI,EAAE,GAAG;QACT,EAAE,EAAE,GAAG;QACP,QAAQ,EAAE,GAAG;KACd;IACD;QACE,EAAE,EAAE,iBAAiB;QACrB,KAAK,EAAE,OAAO;QACd,SAAS,EAAE,uBAAuB;QAClC,IAAI,EAAE,GAAG;QACT,EAAE,EAAE,GAAG;QACP,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,uEAAuE;KAC9E;IACD;QACE,EAAE,EAAE,eAAe;QACnB,KAAK,EAAE,QAAQ;QACf,SAAS,EAAE,wBAAwB;QACnC,IAAI,EAAE,GAAG;QACT,EAAE,EAAE,GAAG;QACP,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,8CAA8C;KACrD;IACD;QACE,EAAE,EAAE,aAAa;QACjB,KAAK,EAAE,uBAAuB;QAC9B,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,gEAAgE;KACvE;IACD;QACE,EAAE,EAAE,aAAa;QACjB,KAAK,EAAE,gBAAgB;QACvB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;KACd;IACD;QACE,EAAE,EAAE,aAAa;QACjB,KAAK,EAAE,cAAc;QACrB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;KACd;IACD;QACE,EAAE,EAAE,iBAAiB;QACrB,KAAK,EAAE,OAAO;QACd,SAAS,EAAE,uBAAuB;QAClC,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,yDAAyD;KAChE;IACD;QACE,EAAE,EAAE,SAAS;QACb,KAAK,EAAE,SAAS;QAChB,SAAS,EAAE,UAAU;QACrB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;KACd;IACD;QACE,EAAE,EAAE,gBAAgB;QACpB,KAAK,EAAE,QAAQ;QACf,SAAS,EAAE,UAAU;QACrB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,4CAA4C;KACnD;IACD;QACE,EAAE,EAAE,qBAAqB;QACzB,KAAK,EAAE,OAAO;QACd,SAAS,EAAE,sBAAsB;QACjC,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,oCAAoC;KAC3C;IACD;QACE,EAAE,EAAE,kBAAkB;QACtB,KAAK,EAAE,OAAO;QACd,SAAS,EAAE,wBAAwB;QACnC,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;KACd;IACD;QACE,EAAE,EAAE,SAAS;QACb,KAAK,EAAE,cAAc;QACrB,SAAS,EAAE,UAAU;QACrB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;KACd;IACD;QACE,EAAE,EAAE,mBAAmB;QACvB,KAAK,EAAE,QAAQ;QACf,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,mDAAmD;KAC1D;IACD;QACE,EAAE,EAAE,kBAAkB;QACtB,KAAK,EAAE,OAAO;QACd,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,kEAAkE;KACzE;IACD;QACE,EAAE,EAAE,iBAAiB;QACrB,KAAK,EAAE,iBAAiB;QACxB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,uDAAuD;KAC9D;IACD;QACE,EAAE,EAAE,mBAAmB;QACvB,KAAK,EAAE,QAAQ;QACf,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,6DAA6D;KACpE;IACD;QACE,EAAE,EAAE,qBAAqB;QACzB,KAAK,EAAE,UAAU;QACjB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,8CAA8C;KACrD;IACD;QACE,EAAE,EAAE,kBAAkB;QACtB,KAAK,EAAE,OAAO;QACd,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,mDAAmD;KAC1D;IACD;QACE,EAAE,EAAE,0BAA0B;QAC9B,KAAK,EAAE,eAAe;QACtB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;KACd;IACD;QACE,EAAE,EAAE,sBAAsB;QAC1B,KAAK,EAAE,WAAW;QAClB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,mDAAmD;KAC1D;IACD;QACE,EAAE,EAAE,iBAAiB;QACrB,KAAK,EAAE,SAAS;QAChB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,qDAAqD;KAC5D;IACD;QACE,EAAE,EAAE,mBAAmB;QACvB,KAAK,EAAE,QAAQ;QACf,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,iDAAiD;KACxD;IACD;QACE,EAAE,EAAE,qBAAqB;QACzB,KAAK,EAAE,UAAU;QACjB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,wCAAwC;KAC/C;IACD;QACE,EAAE,EAAE,iBAAiB;QACrB,KAAK,EAAE,iBAAiB;QACxB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,kEAAkE;KACzE;IACD;QACE,EAAE,EAAE,mBAAmB;QACvB,KAAK,EAAE,QAAQ;QACf,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,2DAA2D;KAClE;IACD;QACE,EAAE,EAAE,mBAAmB;QACvB,KAAK,EAAE,QAAQ;QACf,SAAS,EAAE,cAAc;QACzB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,qDAAqD;KAC5D;IACD;QACE,EAAE,EAAE,qBAAqB;QACzB,KAAK,EAAE,OAAO;QACd,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;KACd;IACD;QACE,EAAE,EAAE,mBAAmB;QACvB,KAAK,EAAE,QAAQ;QACf,SAAS,EAAE,cAAc;QACzB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,gDAAgD;KACvD;IACD;QACE,EAAE,EAAE,oBAAoB;QACxB,KAAK,EAAE,SAAS;QAChB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,oDAAoD;KAC3D;IACD;QACE,EAAE,EAAE,YAAY;QAChB,KAAK,EAAE,cAAc;QACrB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,kDAAkD;KACzD;IACD;QACE,EAAE,EAAE,iBAAiB;QACrB,KAAK,EAAE,SAAS;QAChB,SAAS,EAAE,kCAAkC;QAC7C,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,mDAAmD;KAC1D;CACF,CAAC"}

package/lib/ir/core/bandLabelPlan.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Where every band's mark and label go, worked out before anything is drawn.
+ *
+ * Kept apart from the component because it is the part worth testing: which
+ * bands get a label, which way their lines stack, how far a crowded label may
+ * slide from the band it names, and which are dropped rather than drawn
+ * somewhere misleading. All of that is arithmetic over numbers, and none of it
+ * needs a DOM.
+ */
+import type { PlotRect } from '../../chart/core/chartGeometry.ts';
+import type { ChartScale } from '../../chart/core/chartScale.ts';
+import type { AssignedBand } from './assignBands.ts';
+import type { IrBand } from './irBand.ts';
+import type { IrMode } from './irSpectrum.ts';
+/** One band, and where everything about it is drawn. */
+export interface BandLabelPlan {
+    /** The band itself. */
+    band: IrBand;
+    /** Where its tip sits horizontally, in user units of the SVG. */
+    tipX: number;
+    /** Where its tip sits vertically. */
+    tipY: number;
+    /**
+     * Where its label is centred, `NaN` when the label was dropped for having
+     * been slid too far from the band to belong to it.
+     */
+    labelX: number;
+    /** The baseline of each line of the label, in the order the lines are given. */
+    baselines: Float64Array;
+    /** What the label says, farthest line from the band first. */
+    lines: string[];
+}
+/** What the plan is worked out from. */
+export interface BandLabelPlanOptions {
+    /** The bands to name, with whatever the table said about them. */
+    assigned: readonly AssignedBand[];
+    /** Where the plot sits inside the SVG. */
+    plot: PlotRect;
+    /** The wavenumber axis as it is currently zoomed. */
+    xScale: ChartScale;
+    /** The value axis as it is currently zoomed. */
+    yScale: ChartScale;
+    /** Which value axis is being drawn, which decides which way labels stack. */
+    mode: IrMode;
+    /**
+     * Whether each label names the assignment as well as the wavenumber.
+     *
+     * The assignment is the longer line by far — `carboxylic acid C=O stretch`
+     * against `1710` — so a chart showing a dozen bands is legible with the
+     * wavenumbers alone and unreadable with both.
+     * @default false
+     */
+    showAssignments?: boolean;
+    /**
+     * At most how many bands to name.
+     *
+     * Marks are drawn on every band regardless; this only bounds the labels, since
+     * a mark costs three pixels and a two-line label costs sixty.
+     * @default 12
+     */
+    limit?: number;
+}
+/**
+ * Work out where every band's label goes.
+ *
+ * Only the bands inside the window are considered, so a zoom into one region
+ * gives its bands the whole width to be named in rather than sharing it with the
+ * hundred outside the plot.
+ *
+ * The strongest bands win the labels when there are more than `limit`, because a
+ * strong band is the one a reader is looking for; but they come back in ascending
+ * wavenumber — the order `pickBands` returns and the order a band table lists —
+ * rather than in the order they were chosen. Which is right to left on screen,
+ * since the axis is drawn backwards; nothing depends on it, because the declutter
+ * sweep sorts by pixel itself.
+ * @param options - The bands, the axes and how much to say.
+ * @returns One plan per band that is inside the window, in axis order.
+ */
+export declare function planBandLabels(options: BandLabelPlanOptions): BandLabelPlan[];
+/**
+ * How wide a label is taken to be while it is being spaced out.
+ *
+ * A wavenumber is four digits and an assignment is far wider, but the width used
+ * for spacing is the wavenumber's: spacing on the longer line would push every
+ * label so far apart that only three fit, and an assignment is only ever shown
+ * when a handful of bands are named.
+ */
+export declare const LABEL_WIDTH = 34;
+/** The clear space kept between two neighbouring labels. */
+export declare const LABEL_GAP = 6;
+/** How far the mark reaches from the tip of a band, in pixels. */
+export declare const BAND_MARK: 10;
+//# sourceMappingURL=bandLabelPlan.d.ts.map

package/lib/ir/core/bandLabelPlan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bandLabelPlan.d.ts","sourceRoot":"","sources":["../../../src/ir/core/bandLabelPlan.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAKjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,wDAAwD;AACxD,MAAM,WAAW,aAAa;IAC5B,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,gFAAgF;IAChF,SAAS,EAAE,YAAY,CAAC;IACxB,8DAA8D;IAC9D,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,wCAAwC;AACxC,MAAM,WAAW,oBAAoB;IACnC,kEAAkE;IAClE,QAAQ,EAAE,SAAS,YAAY,EAAE,CAAC;IAClC,0CAA0C;IAC1C,IAAI,EAAE,QAAQ,CAAC;IACf,qDAAqD;IACrD,MAAM,EAAE,UAAU,CAAC;IACnB,gDAAgD;IAChD,MAAM,EAAE,UAAU,CAAC;IACnB,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,oBAAoB,GAAG,aAAa,EAAE,CAuE7E;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,KAAK,CAAC;AAE9B,4DAA4D;AAC5D,eAAO,MAAM,SAAS,IAAI,CAAC;AAE3B,kEAAkE;AAClE,eAAO,MAAM,SAAS,IAAqB,CAAC"}