• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Data connectivity & integrationPipeline Builder ExpressionsExtract imagery metadata

    Extract imagery metadata

    Supported in: Batch, Streaming

    Extracts metadata fields from an image.

    Expression categories: Media

    Declared arguments

    • Media reference - The column containing media references to imagery in the media set.
      Expression<Media reference>
    • Metadata to include - Select the metadata columns to include in the output. For metadata columns that do not apply for the given image, the value will be null. For example, geo metadata should only be relevant for images with geospatial context such as satellite imagery with world coordinates. If this does not apply to the image, this field will return null.
      Set<Enum<Attributes, Bands, Bytes, Dimensions, Format, Geographic Metadata, ICC Profile>>

    Output type: Struct

    Examples

    Example 1: Base case

    Argument values:

    • Media reference: Media Reference
    • Metadata to include: [Attributes, Bands, Bytes, Dimensions, Format, Geographic Metadata, ICC Profile]
    Media ReferenceOutput
    {"mimeType":"image/tiff","reference":{"type":"mediaSetItem","mediaSetItem":{"mediaSetRid":"ri.mio.test.media-set.1","mediaItemRid":"ri.mio.test.media-item.1"}}}{
     attributes: {
     outer_key1 -> {
     inner_key1 -> inner_value1,
    },
    ...

    Example 2: Base case

    Argument values:

    • Media reference: Media Reference
    • Metadata to include: [Bands, Dimensions, Geographic Metadata]
    Media ReferenceOutput
    {"mimeType":"image/tiff","reference":{"type":"mediaSetItem","mediaSetItem":{"mediaSetRid":"ri.mio.test.media-set.1","mediaItemRid":"ri.mio.test.media-item.1"}}}{
     bands: [ {
     color_interpretation: RED,
     type: BYTE,
    }, {<b...

    Example 3: Base case

    Argument values:

    • Media reference: Media Reference
    • Metadata to include: [ICC Profile]
    Media ReferenceOutput
    {"mimeType":"image/tiff","reference":{"type":"mediaSetItem","mediaSetItem":{"mediaSetRid":"ri.mio.test.media-set.1","mediaItemRid":"ri.mio.test.media-item.1"}}}{
     icc_profile: some-icc-profile,
    }