Skip to main content

L1C Module command-line parameters

1. Overview​

  • This page describes how to use the command-line interface of the FarEarth Edge application
  • All options can be specified by either a command-line parameter or by the corresponding environmental variable
  • All environmental variables are uppercase and prefixed with 'FE_'
  • The value of the command-line parameter takes precedence if both are specified
Usage: farearth <module-id> --input <INPUT_DIR> --output <OUTPUT_DIR>

2. Parameter list​

<module-id>​

  • The name of the FarEarth module to call
  • Multiple modules are available, each with a specific purpose and unique parameters
  • An example would be the mysat_raw_to_l1c module, which reads raw MY-SAT imagery and generates L1C products
  • The module ID must be provided as the first parameter
  • Mandatory (an error is raised if missing)

-i,--input / FE_INPUT_DIR​

  • The path to the directory where the raw imagery can be found
  • Prior agreement regarding the format of the raw data determines what files are necessary
  • However, the type of files can typically be grouped into two areas:
    1. Imagery - either raw binary files or other raster formats (example, TIFF)
    2. Attitude and ephemeris - timestamped measurements of attitude and ephemeris, typically in JSON, CSV, or raw format
  • Mandatory (an error is raised if missing)

-o,--output / FE_OUTPUT_DIR​

  • The output directory where the L1C product files will be written
  • The format of the directory aligns with FarEarth's standard L1C format
  • This consists of a main GeoJSON metadata file, in which all other files in the directory are listed
  • The format of the GeoJSON metadata file is expressed as STAC
  • Mandatory (an error is raised if missing)

-c,--cpf / FE_CPF_FILE​

  • The path at which the geometric calibration parameter file (CPF) can be found
  • This file will be available for download from the FarEarth Cloud Platform once calibration has been completed
  • The typical size of this file is in the region of 100 KB
  • Mandatory (an error is raised if missing)

-r,--rpf / FE_RPF_FILE​

  • The path where the radiometric calibration parameter file (RPF) can be found
  • This file will be available for download from the FarEarth Cloud Platform once calibration has been completed
  • The typical size of this file is in the region of 100 MB
  • Mandatory (an error is raised if missing)

--pernix / FE_PERNIX_DB​

  • Pernix is FarEarth's Edge-optimised local filesystem spatial database
  • Pernix consists of a directory which contains an index of millions of spatial assets
  • Individual assets are grouped by archive directories adjacent to the index file
  • This ensures that the directory tree is limited to below approximately 200 individual files
  • Depending on the deployed processing ancillaries, this might contain:
    1. Digital elevation models (DEM) used for terrain correction
    2. Ground reference imagery (GRI) chip tiles used for precision geometric correction
    3. Planetary ephemeris files used to translate temporal and spatial reference frames

-m,--master-band <string> / FE_MASTER_BAND​

  • The band used as master reference during precision geolocation and band-alignment
  • Optional. This is automatically determined by either:
    1. The band chosen in the CPF
    2. Or, if that band is not present, the next closest band by central wavelength

--compression <string> / FE_COMPRESSION​

  • Whether compression should be applied to the output imagery
  • Options are: [NONE/LZW/DEFLATE/PACKBITS]
  • Defaults to NONE

--correlation-id <string> / FE_CORRELATION_ID​

  • An optional user-supplied string constant that can be used as a tracking ID
  • Will be published in the output product's STAC properties as correlationId
  • Examples:
    • SESSION_20261026T131347
    • 1314c973-71e4-4136-b267-8583d90e265d

-b,--band <string> / FE_BANDS​

  • IDs of all the bands to process
  • Will raise an error if a band is requested that is not present
  • Optional. If not specified, all bands will be included for processing
  • Examples:
    • -b RED
    • -b RED -b GREEN -b BLUE
    • -b RED,GREEN,BLUE
    • RED,GREEN,BLUE if provided as environmental variable

--systematic / FE_SYSTEMATIC​

  • Force systematic processing and do not attempt precision ortho correction
  • Systematic processing only relies on attitude and ephemeris provided in the input to correct the image
  • No external references like DEM and GRI chips are used
  • Precision band alignment is still possible, since it does not require external references
  • Optional. Default: false

--ce95 / FE_MASTER_CHIP_DISPARITIES​

  • Calculates the CE95 disparity of tiepoints found between the input image and the reference
  • The calculated CE95 in meters will be attached to the output product's STAC metadata file as fe:qaGeo:ce95
  • Optional. Default: false

--no-rad / FE_NO_RAD​

  • Disable radiometric correction
  • Optional. Default: false

--no-proj / FE_NO_PROJ​

  • Disable projection of output imagery
  • Imagery products will be persisted as plain TIFFs instead of GeoTIFFs
  • Optional. Default: false

--no-dem / FE_NO_DEM​

  • Disable terrain correction via DEM
  • Optional. Default: false

--no-band-alignment / FE_NO_BAND_ALIGNMENT​

  • Disable precision band alignment
  • Optional. Default: false

--no-ortho-rpc / FE_NO_ORTHO_RPC​

  • Do not attempt precision geometric modelling
  • Precision correction of the geolocation is applied via a simple linear offset
  • Optional. Default: false

--no-destripe / FE_NO_DESTRIPE​

  • Disable radiometric noise filtering
  • Optional. Default: false

--gpu-disabled / FE_NO_GPU​

  • Force the use of CPU processing, even if a local GPU is available
  • Optional. Default: false

--overlap-bands / FE_OVERLAP_BANDS​

  • Ensure that the output imagery is the intersection of all bands
  • Since different bands might be imaged at varying times, some might lead or lag each other by a few rows
  • This means that some pixels around the edge of the image might be a mixture of valid data and invalid nodata
  • Optional. Default: false

--use-flat-dem / FE_USE_FLAT_DEM​

  • Approximate the terrain variation over a scene as a single value instead of relying on the full reference DEM
  • Optional. Default: false

--thumbnail / FE_THUMBNAIL​

  • Create a low-resolution PNG thumbnail image as part of the output
  • Optional. Default: false

--true-color-image / FE_TRUE_COLOR_IMAGE​

  • Create a full resolution RGB approximation TIFF as part of the output
  • Optional. Default: false

--hierarchical-classification / FE_HIERARCHICAL_CLASSIFICATION​

  • Generate an output image that serves as a thematic land-cover classification mask
  • The classes with their decimal representation are as follows:
    1. Snow: 1
    2. Cloud: 2
    3. Dark bare soil: 3
    4. Bright bare soil: 4
    5. Average vegetation: 5
    6. Bright vegetation: 6
    7. Dark vegetation: 7
    8. Yellow vegetation: 8
    9. Mixed vegetation or soil: 9
    10. Asphalt or dark sand: 10
    11. Bright sand, bare soil, or cloud: 11
    12. Sand, bare soil, or cloud: 12
    13. Dry vegetation or soil: 13
    14. Sparse vegetation or soil: 14
    15. Clear water: 15
    16. Turbid water: 16
    17. Clear water over sand: 17
  • Optional. Default: false

--ndvi / FE_NDVI​

  • Create an NDVI TIFF as part of the output
  • Optional. Default: false

--classification-image / FE_CLASSIFICATION_IMAGE​

  • Create a Copernicus Sentinel-2 compatible cloud, cirrus and snow mask as part of the output
  • The output image is formatted as a multi-band TIFF with:
    1. Band 1 represents opaque clouds when a pixel is 1
    2. Band 2 represents cirrus clouds when a pixel is 1
    3. Band 3 represents snow or ice when a pixel is 1
  • Optional. Default: false

--debug / FE_DEBUG​

  • Enable debugging logging and diagnostic file output
  • Debug logs and file outputs assist in diagnosing failures and anomalous behaviour
  • Optional. Default: false

--log-stdout-text​

  • Whether text output logging will be written to standard-output
  • Note that this parameter must be specified before the <module-id>
  • Optional. Default: enabled

--log-stdout-jsonl​

  • Whether JSONL output logging will be written to standard-output
  • Note that this parameter must be specified before the <module-id>
  • Optional. Default: disabled

--log-file-text <OUTPUT_FILE_PATH>​

  • Whether text output logging will be written to the specified file
  • The file will be overwritten if it already exists
  • Note that this parameter must be specified before the <module-id>
  • Optional. Default: disabled

--log-file-jsonl <OUTPUT_FILE_PATH>​

  • Whether JSONL output logging will be written to the specified file
  • The file will be overwritten if it already exists
  • Note that this parameter must be specified before the <module-id>
  • Optional. Default: disabled