Skip to main content

Get image metadata

GET 
/:script_id/metadata

Get metadata about an image given an IPE resource ID, function name, and parameters.

Request​

Path Parameters

    script_id stringrequired

    script ID

    Example: ortho

Query Parameters

    function stringrequired

    The function to process

    Example: pansharp_ortho
    p string[]

    The function parameters if required. Note these are always prepended by a p= query string param since they are dynamic based on the selected function

    Example: p=catalogID=10400100655F5400&p=crs=EPSG:4326

Responses​

Success

Schema
    imageMetadata object

    Image Metadata

    version stringrequired

    ImageMetadata Version

    minTileX int64required

    X Index of the first tile

    minTileY int64required

    Y Index of the first tile

    maxTileX int64required

    Exclusive x Index of the last tile. (numTilesX=maxTileX-minTileX)

    maxTileY int64required

    Exclusive y Index of the last tile. (numTilesY=maxTileY-minTileY)

    tileSizeX int32required

    Number of pixels per tile in the X dimension

    tileSizeY int32required

    Number of pixels per tile in the Y dimension

    numBands int32required

    Number of bands/layers in the image

    dataType SampleDataTyperequired

    Possible values: [BINARY, BYTE, SHORT, UNSIGNED_SHORT, INTEGER, UNSIGNED_INTEGER, LONG, UNSIGNED_LONG, FLOAT, DOUBLE]

    The data type of the pixels

    minPixelX int64required

    X Index of the first pixel

    minPixelY int64required

    Y Index of the first pixel

    maxPixelX int64required

    Exclusive x index of the last pixel. (width=maxPixelX-minPixelX)

    maxPixelY int64required

    Exclusive y Index of the last pixel. (height=maxPixelY-minPixelY)

    tileOffsetX int32required

    The pixel X index of the first pixel in the first tile.

    tileOffsetY int32required

    The pixel Y index of the first pixel in the first tile.

    spatialTransform object

    Describes how image pixel coordinates relate to real world coordinates in some well-known spatial reference system. The 6 Double values represent the 6 parameters in an affine transform which transform pixel coordinates into map coordinates.

    spatialReferenceSystemType SpatialTransformTyperequired

    Possible values: [EPSG, IDEAL, UNDEFINED]

    The type of spatial reference system.

    spatialReferenceSystemIdentifier stringrequired

    The spatial reference system identifier expressed as a string corresponding to the spatialReferenceSystemType.

    affine objectrequired

    The affine transform.

    scaleX doublerequired

    The scale factor in the x direction (one of the 6 affine transform parameters).

    scaleY doublerequired

    The scale factor in the y direction (one of the 6 affine transform parameters).

    translateX doublerequired

    The translation factor in the x direction (one of the 6 affine transform parameters).

    translateY doublerequired

    The translation factor in the y direction (one of the 6 affine transform parameters).

    shearX doublerequired

    The shear factor in the x direction (one of the 6 affine transform parameters). Note that this parameter is usually 0 since geospatial images do not usually have rotation once rectified to a map projection.

    shearY doublerequired

    The shear factor in the y direction (one of the 6 affine transform parameters). Note that this parameter is usually 0 since geospatial images do not usually have rotation once rectified to a map projection.

    sourceMetadata object

    Source image collect metadata

    collectId string
    imageBoundsWGS84 stringrequired

    Possible values: non-empty

    vehicleName VehicleName

    Possible values: [WV03, WV02, WV01, LG01, LG02, LG03, LG04]

    vendorName string
    vendorDatasetIdentifier string
    firstLineTime string
    scanDirection AcquisitionScanDirection

    Possible values: [Forward, Reverse]

    dsaOrderMirrorFlag boolean
    theoreticalLowDN int32
    theoreticalHighDN int32
    sunAzimuth object
    min double
    max double
    mean double
    sunElevation object
    min double
    max double
    mean double
    satelliteAzimuth object
    min double
    max double
    mean double
    targetAzimuth object
    min double
    max double
    mean double
    satelliteElevation object
    min double
    max double
    mean double
    offNadirAngle object
    min double
    max double
    mean double
    cloudCover double
    bandMetadata object
    property name* CollectBandMetadata
    absoluteCalibrationFactor double
    effectiveBandwidth double
    spectralMidpoint double
    tdiLevel double
    noDataValue double
    bandAlias ImageBand

    Possible values: [pan, blue, green, red, nir1, coastal, yellow, red_edge, red_edge1, red_edge2, nir2, s1, s2, s3, s4, s5, s6, s7, s8, dem, alpha, undefined]

    bandsetMetadata object
    property name* CollectBandsetMetadata
    bandsetName string
    numLinesInDsa int32
    firstUsableLine int32
    numUsableLines int32
    colorInterpretation BandColorInterpretation

    Possible values: [PAN, PAN_WITH_ALPHA, RGB, RGBA, RGBN, BGR, BGRA, BGRN, WORLDVIEW_8_BAND, WORLDVIEW_SWIR, LEGION_8_BAND, UNSPECIFIED]

    Band Color Interpretation

    bands ImageBand[]

    Possible values: [pan, blue, green, red, nir1, coastal, yellow, red_edge, red_edge1, red_edge2, nir2, s1, s2, s3, s4, s5, s6, s7, s8, dem, alpha, undefined]

    numLinesPerSecond double
    groundSampleDistanceMeters double
    numDSAs int32
    badDSAs int32[]
    bands object

    Image band names

    empty boolean
Loading...