gis-tools-ts - v0.6.0
    Preparing search index...

    Class GRIB2Reader

    GRIB2 Reader

    This class reads a GRIB2 file and returns a list of GRIB2 products. Implements the FeatureIterator interface.

    // pull .idx file FIRST and filter the ones you want
    const filters = [':DZDT:0.01 mb:', ':TMP:0.4 mb:', ':ABSV:0.4 mb:anl:'];
    const idxs = await parsedIDXFromURL(`${link}.idx`, filters);
    // now bulid the reader
    const gribReader =  await GRIB2Reader.fromIDX(link, idxs);

    for await (const feature of gribReader) {
      console.log(feature);
    }

    const gribReader = new GRIB2Reader(link);

    Implements

    Index

    Constructors

    constructor

    Methods

    [asyncIterator] fromIDX

    Constructors

    Methods

    • Iterate through each packet and add their products to the geometry

      Returns AsyncGenerator<
          VectorFeature<
              {
                  backgroundGenProcess: number;
                  forecastGenProcess: { code: number; value: string };
                  forecastTime: { code: number; value: Date };
                  genProcessType: { code: number; value: string };
                  hoursAfterRefTime: number;
                  minAfterRefTime: number;
                  paramater: {
                      abbrev: string;
                      category: string;
                      parameter: string;
                      units: string;
                  };
                  parameterCategory: number;
                  parameterNumber: number;
                  surface1: { scale: number; type: string; unit: string; value: number };
                  surface1Scale: number;
                  surface1Type: number;
                  surface1Value: number;
                  surface2: { scale: number; type: string; unit: string; value: number };
                  surface2Scale: number;
                  surface2Type: number;
                  surface2Value: number;
                  unitOfTimeRangeIndicator: { code: number; value: string };
              }[],
              Record<string, number>,
              Properties,
              VectorMultiPointGeometry<Record<string, number>>,
          >,
      >

    • Create a GRIB2Reader from a .idx file

      Parameters

      • source: string | Reader

        Either the http path to the .idx file or the entire GRIB file

      • idxs: SectionLocations[]

        The parsed .idx file with the locations of each section

      Returns Promise<GRIB2Reader>

      A GRIB2Reader of the specific sections

    Settings

    Member Visibility

    On This Page

    GRIB2 Reader
    Constructors
    Methods