JAXA Earth API for JavaScript
    Preparing search index...

    Interface DataObject

    An object that stores the retrieved data in an easy-to-handle form, which can be obtained via getDataObject, Image#getDataObject, and similar methods.

    A DataObject can be visualized as an image by using createCanvas and similar functions together with the settings of ColorMap.

    interface DataObject {
        width: number;
        height: number;
        data: Uint32Array<ArrayBufferLike> | Float32Array<ArrayBufferLike>;
        bbox: Bbox;
        unit: string;
        date: Date;
        formattedDate: string;
        projection: Projection;
        src: { cog: string; stac: string }[];
        photometricInterpretation: number;
        colors?: string[];
        classes?: any;
    }
    Index

    Properties

    width: number

    The width of the image (in pixels).

    height: number

    The height of the image (in pixels).

    data: Uint32Array<ArrayBufferLike> | Float32Array<ArrayBufferLike>

    A one-dimensional array (Float32Array or Uint32Array) that stores the value of each pixel in order, from the top-left to the top-right of the image and from top to bottom. The number of elements in the array is width * height. The data for pixel (i, j) is stored at index i + j * width of the one-dimensional array.

    When photometricInterpretation = 1 or 3, the Float32Array data type is used. Pixels with no value, such as those outside the observation range or missing due to clouds, store NaN.

    When photometricInterpretation = 2, the Uint32Array data type is used. Pixels with no value, such as those outside the observation range or missing because they do not meet quality requirements, store 0x00000000 (a transparent color).

    bbox: Bbox

    A Bbox representing the latitude-longitude range.

    unit: string

    The unit of the values stored in data. For a dimensionless quantity with no unit, "" is stored.

    date: Date

    A Date indicating the date and time of the data.

    formattedDate: string

    A string representation of the date and time of the data. It reflects the time interval specific to the dataset; for example, "YYYY/MM" for a monthly dataset, "YYYY/MM/DD" for a daily dataset, and "MM" for a climatological value (such as an average obtained from multiple years of data).

    projection: Projection

    The projection Projection, such as "EPSG:4326".

    src: { cog: string; stac: string }[]

    URLs to the original COG file and STAC file.

    photometricInterpretation: number

    The value of photometricInterpretation defined in the original GeoTIFF file. The JAXA Earth API supports the following values.

    • photometricInterpretation = 1 (BlackIsZero): Indicates data in which each pixel stores a physical quantity value. This corresponds to data on what is known as a measurement level: an "ordinal scale" (magnitudes can be compared but arithmetic operations are meaningless, e.g., vegetation indices), an "interval scale" (addition and subtraction are possible but multiplication and division are meaningless, e.g., temperature in degrees Celsius), or a "ratio scale" (all arithmetic operations are possible, e.g., precipitation or temperature in kelvin).
    • photometricInterpretation = 2 (RGB): Indicates a color image in which each pixel stores an RRGGBBAA color value. Nearest-neighbor resampling is possible, but bilinear resampling cannot be used. Originally this should be processed with four times the number of elements as [RR, GG, BB, AA] according to the GeoTIFF samplesPerPixel = 4 and planarConfiguration = 1, but for convenience RRGGBBAA is stored in each 32-bit value of the Uint32Array, so that the number of elements in data (width * height) is processed identically to the BlackIsZero case.
    • photometricInterpretation = 3 (Palette color): Indicates data in which each pixel stores a value representing a class classification. This is data on what is known as a "nominal scale" measurement level (such as land cover classification); the ranking or magnitude between values is meaningless, and arithmetic operations cannot produce meaningful values. Nearest-neighbor resampling is possible, but bilinear resampling cannot be used.
    colors?: string[]

    When photometricInterpretation = 3 (Palette color), this stores the color used to paint each value. It takes precedence over ColorMap. An array of color code strings is created from the information specified in the ColorMap of the IFD (Image File Directory) in the GeoTIFF file and stored here.

    classes?: any

    When photometricInterpretation = 3 (Palette color), this stores the description content of each value. It stores the JSON defined in classification:classes within the STAC catalog file.