Skip to main content

Level 1B product metadata

JSON metadata file describing the properties of the FarEarth Level 1B 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 which was used to generate the product.
        • Items (object)
          • productId (string): The product ID uniquely identifying the reference.
          • productType (string): The product type of the reference.
          • properties (object): Any additional 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 hash that further serves as identifying the exact software package version.
        • version (string): A version uniquely identifying the software package.
  • descriptor (object): Meta-data 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 identifying the product.
    • productType (string): This will always be 'L1B'.
    • sceneCol (integer, format: int32): If an interval is subdivided into multiple scenes (or tiles), the column index will reflect adjacent tiles across track starting counting at 1 for left-most scene. The interval will have at least one column, even it 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 it 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.
  • radiometric (object): Details relating to the radiometric properties relevant to the product.
    • 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.
    • sunAzimuth (number, format: double): From the scene center point on the ground, this is the angle between truth north and the sun (measured clockwise in degrees between 0 and 360).
    • sunElevation (number, format: double): The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90 to 90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10 means the data was captured during nautical twilight.
  • scanTimes (string): The file name in which all the scan-line scan-times of the product can be found.
  • sceneView (object): Details relating to the along/across/nadir track view of the product.
    • acrossTrack (number, format: double): The amount of degrees the scene center is off across track (roll).
    • alongTrack (number, format: double): The amount of degrees the scene center is off along track (pitch).
    • offNadirMode (string): Indicates if the scene is acquire (NADIR / ALONG_TRACK / ACROSS_TRACK). Must be one of: ["NADIR", "ALONG_TRACK", "ACROSS_TRACK"].
  • sensors (array): Details relating to the sensors relevant to the product.
    • Items (object)
      • bands (array): Details related to bands that were generated that is associated with the sensor.
        • Items (object)
          • band (string): The name of the band available in this group.
          • frames (array): List of frames within this band (typically push-frames has multiple frames).
            • Items (object)
              • angles (object): Solar and view angles relevant to the frame.
                • viewAzimuth (number, format: double): The angle measured from the sub-satellite point (point on the ground below the platform) between the scene center and true north (Measured clockwise from north in degrees between 0 and 360).
                • viewIncidence (number, format: double): The angle between the vertical (normal) to the intercepting surface and the line of sight back to the satellite at the scene center (in degrees, between 0 and 90).
                • viewOffNadir (number, format: double): The angle from the sensor between nadir and the scene center (in degrees, between 0 and 90).
              • frameIndex (integer, format: int32): The frame index of the current frame.
              • geometric (object): Geometric meta-data details associated with the band frame in question.
                • bandAlignment: To what model quality band alignment was achieved (either 'systemic' or 'precision'). Any frame which failed precision refinement will result in a fallback to 'systematic'. Refer to #/$defs/ModelType.
                • dimensions (array): The pixel dimensions of the frame (total rows and columns). Length must be equal to 2.
                  • Items (number)
                • geometry (array): A sequence of (x,y) coordinates forming a closed frame outline (with units in the stated 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.
              • rpc (string): The rational polynomial coefficients (RPC) file used during processing.
          • geometric (object): Details relating to the geometric data of the image.
            • measuredGsd (array): The ground sample distance measured of a single pixel given the ortho-geometric model (in meters). Length must be equal to 2.
              • Items (number)
            • projection (string): The projection string of the image (example, 'EPSG:32629').
            • resolution (array): The resolution for any pixel in the image (in meters). Length must be equal to 2.
              • Items (number)
          • group (string): The ID used to group different bands or their respective detector IDs together. Typically grouped together in the same image file by matching GSD resolutions.
          • id (string): The ID of the band available in this group.
          • 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.
          • radiometric (object): Details relating to the radiometric data of the image.
            • emissiveConstants (object): Emissive conversion constant values for the band.
              • constants (array): The emissive constants are model parameters used for radiance to brightness temperature conversion.
                • Items (number, format: double)
            • esun (object): Mean exo-atmospheric solar irradiance (ESUN) values for the band.
              • units (string): Typically 'W / (m^2 * um)'.
              • value (number, format: double): The ESUN value of the band in question.
            • radianceConversion (object): Radiance conversion values for the band.
              • gain (number, format: double): The gain of the imaging band.
              • offset (number, format: double): The offset of the imaging band.
            • spectral (object): The spectral layout of the band.
              • centerWavelength (number, format: double): The center band wavelength (in nanometers).
              • fullWidthHalfMax (number, format: double): The full-width half-max bandwidth of the band in question (in nanometers).
            • units (string): The pixel value representation of the image data (either 'DN' denoting raw digital numbers, or 'TOA Reflectance x 10k' denoting x10,000 scaled top-of-atmosphere reflectance, or 'TOA Brightness Temperature x 10 (K)' denoting x10 scaled top-of-atmostphere brightness temperature in Kelvin).
      • 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.
        • id (string): The detector ID.
        • name (string): The name or unique ID for the sensor.
      • quality (object): Quality metrics generated during processing.
        • geometric (array): Geometric quality metrics generated during processing.
          • Items (object)
            • frameIndex (integer, format: int32): The frame index of the current frame.
            • metrics (array): A list of disparities by image corner and center location. Will only be available if the adjacent property 'orthorectification' is equal to 'precision'.
              • Items (object)
                • location (string): The location in the image where the metrics are applicable to. The possible locations are: upper-left corner, lower-left corner, lower-right corner, upper-right corner, and scene center. Must be one of: ["UL", "LL", "LR", "UR", "CENTER"].
                • precisionLocation (array): The precision corrected coordinate in (longitude, latitude). Length must be equal to 2.
                  • Items (number)
                • rawLocation (array): Raw location in (longitude, latitude) prior to any corrections being applied. Length must be equal to 2.
                  • Items (number)
                • rawToPrecisionDisparityMeter (number, format: double): The difference in meters between the raw and precision coordinate locations.
                • rawToSystematicDisparityMeter (number, format: double): The difference in meters between the raw and systematic coordinate locations.
                • systematicLocation (array): The systematically corrected coordinate in (longitude, latitude). Length must be equal to 2.
                  • Items (number)
                • systematicToPrecisionDisparityMeter (number, format: double): The difference in meters between the systematic and precision coordinate locations.
            • orthorectification: To what model quality orthorectification was achieved (either 'systemic' or 'precision'). Any detector which failed precision refinement will result in a fallback to 'systematic'. Refer to #/$defs/ModelType.
  • software (object): Details regarding the software used to generate the L1B 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').
  • viewingAngles (string)

Definitions

  • ModelType (string): Must be one of: ["systematic", "precision"].