JAXA Earth API for JavaScript
    検索インデックスを準備しています...

    クラス ImageCollection

    データセットに関する情報を格納したImageCollectionのクラスです。主に日時とバンドの情報を扱います。

    データセットのcollection.jsonのURLを指定してインスタンスを作成し、initを実行することで準備を完了します。

    その後、firstlastprevnextなどを用いてこのデータセットで利用できる日時を探し、 日時とバンド名を指定した上でgetImageを実行することでImageを取得できます。

    import * as je from "./jaxa.earth.esm.js";

    // 利用したいデータセットを特定するためのcollection.jsonを指定します。
    const collectionUrl = "https://s3.ap-northeast-1.wasabisys.com/je-pds/cog/v1/JAXA.G-Portal_GCOM-W.AMSR2_standard.L3-SMC.daytime.v3_global_monthly/collection.json";

    // ImageCollectionを作って初期化します。初期化するとcollection.jsonから必要な情報を読み込みます。
    const ic = new je.ImageCollection({ collectionUrl });
    await ic.init();

    // 最初の日時を取得します。
    console.log(ic.first());
    console.log(ic.formatDate(ic.first()));

    // 最後の日時を取得します。
    console.log(ic.last());
    console.log(ic.formatDate(ic.last()));

    // 指定した日時の前の日時を取得します。カタログファイル内を通信しながら探索するため、awaitの指定が必要です。
    console.log(await ic.prev(new Date(Date.UTC(2023, 2 - 1))));

    // 指定した日時の次の日時を取得します。カタログファイル内を通信しながら探索するため、awaitの指定が必要です。
    console.log(await ic.next(new Date(Date.UTC(2023, 2 - 1))));

    // 指定した日時範囲のうち、データが存在する日時を取得します。
    console.log(await ic.getDateAll(
    new Date(Date.UTC(2020, 1 - 1, 1)), //開始(この値を含む)
    new Date(Date.UTC(2022, 1 - 1, 1)), //終了(この値は含まない)
    ));

    // 利用できるバンド名を取得します。
    console.log(ic.getBandIdAll());

    // ImageCollectionからje.Imageを取得します。
    const im = await ic.getImage({
    // 日時を指定します。指定した日時のデータを取得します。指定しない場合は現在の日時が指定されることで最新のデータを取得できます。
    // この例では2021/6のデータが取得されます。
    date: new Date(Date.UTC(2021, 6 - 1)),

    // バンド名を指定します。省略した場合は1つ目のバンド名を自動で選択します。
    band: "SMC",
    });
    インデックス

    コンストラクター

    • パラメータ

      • options: { collectionUrl: string }
        • collectionUrl: string

          データセットのcollection.jsonのURLです。

      戻り値 ImageCollection

    メソッド

    • collectionUrlで指定されたcollection.jsonを読み込んで、このインスタンスを利用できるように準備します。

      戻り値 Promise<void>

    • 日時の文字列表現を返します。例えば月単位のデータセットの場合は"YYYY/MM"、日単位のデータセットの場合は"YYYY/MM/DD"、気候値(複数年のデータから得られる平均値等)の場合は"MM"のように、データセット固有の時間間隔を反映した文字列表現に変換します。

      パラメータ

      • date: Date

      戻り値 string

    • 利用可能な最初の日時を返します。

      戻り値 Date

    • 利用可能な最後の日時を返します。

      戻り値 Date

    • 引数に指定された日時よりも前のデータが存在する日時を返します。カタログファイル内を通信しながら探索するため、Promiseを返します。

      パラメータ

      • date: Date

      戻り値 Promise<Date>

    • 引数に指定された日時よりも後のデータが存在する日時を返します。カタログファイル内を通信しながら探索するため、Promiseを返します。

      パラメータ

      • date: Date

      戻り値 Promise<Date>

    • 指定した日時範囲(start <= Date < end)に含まれるデータの日時を全て返します。

      パラメータ

      • start: Date

        日時を探索する開始日時です。

      • end: Date

        日時を探索する終了日時です。(この日時は含みません)

      戻り値 Promise<Date[]>

    • 指定した日時範囲(start <= Date < end)に含まれるデータの日時を全て文字列表現で返します。

      パラメータ

      • start: Date

        日時を探索する開始日時です。

      • end: Date

        日時を探索する終了日時です。(この日時は含みません)

      戻り値 Promise<string[]>

    • このImageCollectionで利用できるバンド名を全て返します。collection.jsonの中で定義されるバンド名の順番を維持した文字列の配列として取得できます。

      戻り値 string[]

      利用できるバンド名の配列

    • 指定された日時、バンド名のImageを取得します。

      日時の指定に関しては次の通りです。

      • 指定した日時にデータが存在する場合は、そのデータを返します。
      • 指定した日時に端数があり、ピンポイントのデータが存在しない場合には、その直前のデータを指すように丸められます。例えば月別のデータに対して、2025/02/05 12:00を指定した場合は2025/02が選択されます。
      • 指定を省略した場合は、現在日時new Date()が指定されることで最も最新のデータを取得できます。

      バンド名の指定に関しては次の通りです。

      • 指定した場合はそのバンド名のデータを返します。
      • 指定を省略した場合は、collection.json上で定義されている1個目のバンド名を自動で選択します。

      パラメータ

      • options: { date?: Date; band?: string }
        • オプションdate?: Date

          日時を指定します。

        • オプションband?: string

          バンド名を指定します。

      戻り値 Promise<Image>