Skip to main content

Level 1A product metadata

JSON metadata file describing the properties of the FarEarth Level 1A product.

Properties​

  • ancestry (array): A list of references comprising the inputs used to create the product.
    • Items (object)
      • productId (string): The unique product ID.
      • productType (string): The type or level of the product (example, RAW, DEM, L1A, L1C or L2A).
      • references (array): A list of references that was used to generate the product.
        • Items (object)
          • productId (string): The product ID uniquely identifies the reference.
          • productType (string): The product type of the reference.
          • properties (object): Any additional or optional properties that serves to describe the reference product.
      • software (object): Details relating to the software responsible for generating the product.
        • buildDate (string): An ISO date timestamp describing when the software package was built.
        • name (string): The name or ID of the software package.
        • revision (string): A revision that further serves to identify the exact software package version.
        • version (string): A version uniquely identifies the software package.
  • descriptor (object): Metadata relevant to the product (Spacecraft, sensor, date range of the product).
    • generationDate (string, format: date-time): The date on which the product was generated.
    • productId (string): The ID identifies the product.
    • productType (string): This will always be 'L1A'.
    • sceneCol (integer, format: int32): If an interval is subdivided into multiple scenes (or tiles), the column index will reflect adjacent tiles across-track starting count at 1 for the left-most scene. The interval will have at least one column, even if the interval is not subdivided.
    • sceneRow (integer, format: int32): If an interval is subdivided into multiple scenes (or tiles), the row index will increment proportionally along-track (starting at 1). The interval will have at least one row, even if the interval is not subdivided.
    • sensors (array): A list of sensor IDs relevant to the product (if required, with preference for hyphenated separators instead of spaces or underscores).
      • Items (string)
    • spacecraft (string): The ID of the spacecraft (if required, with preference for hyphenated separators instead of spaces or underscores, example, 'LANDSAT-7').
    • temporalRange (object): The UTC start and end date of the product (with leap-seconds included).
      • from
        • One of
          • string
          • number
      • to
        • One of
          • string
          • number
  • elevation (object): Details relating to the elevation of the product.
    • averageHae (number, format: double): The average height above ellipsoid in meters.
    • averageMsl (number, format: double): The average mean sea level in meters.
  • navAtt (string): The file name in which naviation and attitude data of the product can be found.
  • pixelCount (integer, format: int64): The total number of pixels across all bands of the product.
  • scanTimes (string): The file name in which all the scan line and scantimes of the product can be found.
  • sensors (array): Details relating to the sensors relevant to the product.
    • Items (object)
      • bands (array): The different band combinations available in the sensor.
        • Items (object)
          • frames (array): List of frames within this band (typically pushframes have multiple frames).
            • Items (object)
              • frameIndex (integer, format: int32): The frame index of the current frame.
              • geometric (object): Geometric metadata details associated with the band frame in question.
                • dimensions (array): The pixel dimensions of the band frame. Length must be equal to 2.
                  • Items (number)
                • geometry (array): A sequence of (x,y) points representing the outline of the band (in units described by the projection).
                  • Items (array): Length must be equal to 2.
                    • Items (number)
              • image (string): The file name of which the banded image is available in.
              • qaMask (string): The file name of a quality mask associated with the banded image data.
              • radiometric (object): Radiometric metadata details associated with the band frame in question.
                • earthSunDistance (number, format: double): The average distance between the center of the Earth and the center of the sun in Astronomical Units (AU). Typical values are between 0.9832 and 1.0167.
                • solarAzimuth (number, format: double): The solar azimuth (in degrees).
                • solarElevation (number, format: double): The solar elevation (in degrees).
              • rpc (string): The rational polynomial coefficients (RPC) file used during processing.
              • viewingGeometry (array): Viewing angles by corner and center pixel coordinates.
                • Items (object)
                  • incidenceAzimuth (number, format: double): The azimuth incidence viewing angle (typically in degrees).
                  • incidenceZenith (number, format: double): The zenith incidence viewing angle (typically in degrees).
                  • pixel (array): The pixel coordinate in (x, y). Length must be equal to 2.
                    • Items (number)
          • geometric (object): Geometric metadata details associated with the band in question.
            • projection (string): The projection string used.
            • resolution (array): The resolution of a single pixel. Length must be equal to 2.
              • Items (number)
          • group (string): Which logical group the band belongs to (typically grouped by bands of the same resolution).
          • id (string): The ID of the band in question.
          • integrationTime (object): The integration time in microseconds for the band in question.
            • units (string): The SI unit the value is expressed in.
            • value (number, format: double): The scalar value quantity.
          • name (string): The name of the band in question.
          • radiometric (object): Radiometric metadata details associated with the band in question.
            • emissiveConstants (object): An emissive conversion constant values for the band in question.
              • constants (array): The emissive constants are model parameters used for radiance to brightness temperature conversion.
                • Items (number, format: double)
            • esun (object): A mean exo-atmospheric solar irradiance (ESUN) value for the band in question.
              • units (string): The units in which the ESUN value is expressed in. Typically 'W / (m^2 * um)'.
              • value (number, format: double): A mean exo-atmospheric solar irradiance (ESUN) value for the band in question.
            • spectral (object): A simplified summary of the spectral response of the band in question.
              • centerWavelength (number, format: double): The center wavelength of the band's response function (in nanometers).
              • fullWidthHalfMax (number, format: double): The full width of half maximum bandwidth of the band's response function (in nanometers).
            • units (string): The measurement unit for the radiometric value. Typically 'W / (m^2 * sr * um)'.
          • sensor (object): The sensor configuration for the band in question.
            • acrossBinning (integer, format: int32): The number of bins used in the across-track direction.
            • alongBinning (integer, format: int32): The number of bins used in the along-track direction.
            • alongScanDirection (string): The imaging scanning direction with respect to the along-track direction. Must be one of: ["POSITIVE", "NEGATIVE"].
            • sensorStartRow (integer, format: int32): The start row used by the band in question.
            • sensorType (string): The imaging sensor type (push_broom or push_frame). Must be one of: ["PUSH_BROOM", "PUSH_FRAME"].
      • descriptor (object): Details relating to the imaging sensor (name, detector ID's, etc).
        • ancillaries (object): Ancillary reference files used as calibration input during processing.
          • cpf (string): The name of the general geometric calibration parameter file used during processing.
          • rpf (string): The name of the radiometric calibration parameter file used during processing.
        • dimensions (array): The dimensions of the sensor detector (total rows and columns). Length must be equal to 2.
          • Items (number)
        • id (string): The detector ID associated with the sensor.
        • name (string): The name or unique ID for the sensor.
  • software (object): Details regarding the software used to generate the L1A product.
    • name (string)
    • version (string)
  • thumbnails (array): Thumbnails of different band or sensor combinations.
    • Items (object)
      • image (string): The file name of the thumbnail.
      • name (string): The name of the thumbnail (example, 'RGB', 'FalseColor' or 'TrueColor').