spc-parser
    Preparing search index...

    Interface TheNewHeader

    New-format file header.

    interface TheNewHeader {
        axes: Axes;
        calibrationLevel: number;
        codes: HeaderCodes;
        concentrationFactor: number;
        customLabels: CustomLabels;
        customLabelsApplied: boolean;
        date?: string;
        dateLayout?: DateLayout;
        directory?: { position: number; size: number; time: number }[];
        directoryOffset?: number;
        drawAsSticks: boolean;
        endingX: number;
        experimentType: string;
        exponentY: number;
        fileVersion: number;
        invertedPeaks: boolean;
        isChromatogram: boolean;
        kind: "new";
        logOffset: number;
        memo: string;
        memoFragments: string[];
        methodFile: string;
        modifications: Modification[];
        modifiedFlag: number;
        numberPoints: number;
        parameters: FlagParameters;
        peakPointNumber: number;
        planeSize?: number;
        postingDisposition: number;
        postingLabel: string;
        processingCode: number;
        processingLabels: string[];
        rawDate: number;
        reserved: string;
        resolutionDescription: string;
        sourceInstrumentDescription: string;
        spare: number[];
        spectra: number;
        startingX: number;
        subMethodSampleInjectionNumber: number;
        wAxisUnits: string;
        wPlaneIncrement: number;
        wPlanes: number;
        xDirection?: XDirection;
        xUnitsType: string;
        xyzLabels: string;
        yUnitsType: string;
        zpdIndex?: number;
        zSpacing?: "even" | "ordered" | "random";
        zSubIncrement: number;
        zUnitsType: string;
    }

    Hierarchy

    • CommonHeader
      • TheNewHeader
    Index

    Properties

    axes: Axes

    Label and units of each axis, from the codes and the custom labels.

    calibrationLevel: number

    The raw codes of the header.

    concentrationFactor: number
    customLabels: CustomLabels

    The custom X, Y and Z labels, whether or not the file enables them.

    customLabelsApplied: boolean

    Whether at least one axis label comes from the custom labels.

    date?: string

    Acquisition date as an ISO string. Local-time layouts have no Z suffix; undefined when the file has no date or an invalid one.

    undefined
    
    dateLayout?: DateLayout

    Layout the date was decoded with, undefined when no date was decoded.

    undefined
    
    directory?: { position: number; size: number; time: number }[]

    The XYXY subfile directory, when it is valid.

    undefined
    
    directoryOffset?: number

    Offset of the XYXY subfile directory (fnpts), when it is valid.

    undefined
    
    drawAsSticks: boolean

    TXYXYS data (e.g. mass spectrum centroids) are drawn as sticks.

    endingX: number
    experimentType: string
    exponentY: number
    fileVersion: number
    invertedPeaks: boolean

    Y types from 128 on have inverted (downward) peaks.

    isChromatogram: boolean

    The experiment is a chromatogram (TCGRAM with the general experiment code, or a chromatography experiment code).

    kind: "new"
    logOffset: number
    memo: string

    Memo, decoded and cut at its first NUL.

    memoFragments: string[]

    Readable text left after the first NUL of the memo by the writer.

    methodFile: string
    modifications: Modification[]

    Modifications applied to the data, in letter order.

    modifiedFlag: number
    numberPoints: number
    parameters: FlagParameters
    peakPointNumber: number
    planeSize?: number

    Number of consecutive subfiles in one W plane (set by the data block reader for 4D files).

    undefined
    
    postingDisposition: number
    postingLabel: string

    Meaning of the DDE posting disposition (fpost).

    processingCode: number
    processingLabels: string[]

    Processing steps recorded in fprocs, empty when unspecified.

    rawDate: number

    The raw fdate DWORD.

    reserved: string
    resolutionDescription: string
    sourceInstrumentDescription: string
    spare: number[]
    spectra: number
    startingX: number
    subMethodSampleInjectionNumber: number
    wAxisUnits: string
    wPlaneIncrement: number
    wPlanes: number
    xDirection?: XDirection

    Order of the X values in the file, set when the data are read.

    undefined
    
    xUnitsType: string
    xyzLabels: string

    The custom-label area with its NUL separators removed.

    yUnitsType: string
    zpdIndex?: number

    Index of the zero path difference point of an interferogram (Y type 1). Absent when fpeakpt is 0 (unknown) or the file is not an interferogram.

    undefined
    
    zSpacing?: "even" | "ordered" | "random"

    Spacing of the Z values of a multifile (set by the data block reader).

    undefined
    
    zSubIncrement: number
    zUnitsType: string