import { RollCopy } from "../model/RollCopy.js"; import { TrackerBar } from "../systems/TrackerBar.js"; import { Track } from "../model/Quantity.js"; /** * How `readFromStanfordAton` reads an analysis file: how its hole * numbering is shifted onto the tracker bar, which bar the roll was cut * for, and where its scan can be seen. * @category Sources */ export interface StanfordAtonOptions { /** * Added to the scanning software's hole numbering to reach the * tracker bar. Left out, it is inferred by putting the rewind * perforation on the bar's rewind track. */ trackShift?: Track; /** * The bar the scanned roll was cut for. The scan is calibrated on * it and the holes keep its numbering, since a copy is read by the * bar it was cut for and by no other. */ system?: TrackerBar; /** * Where the scan the analysis was made from can be seen. Stanford's * files name their scan by DRUID, so this is only needed for an * analysis of a scan hosted elsewhere. */ scan?: string; } /** * Reads a hole analysis of a scan, in the ATON format of Stanford's * SUPRA collection, as a copy of the roll: its chains of holes in * millimetres of paper on the bar it was cut for, its edge tears, its * dimensions and hole separation as the analysis measured them, and how * the scan relates to the bar. A position the bar does not read is left * out, as the bar would leave it. * @category Sources */ export declare function readFromStanfordAton(atonString: string, { trackShift, system, scan }?: StanfordAtonOptions): RollCopy;