Open Data Cube (ODC) Metadata Generation module


Quick linksDescription :: Parameters :: Parameter descriptions :: Details

Back to top

Description


The Open Data Cube (ODC) Metadata Generation module reads the specified Input Folder for .pix or .tif files to automatically create ODC index files for and optionally index and ingest into the ODC.
Back to top

Parameters


Name Caption
Input Folder Input folder
Quality Layer Folder Quality Layer Folder
Output Folder Output folder
Send Email Email notification settings
Overwrite Results Overwrite existing results
Index Results Index results into the ODC
Ingest Results Ingest results into the ODC
Ingest Definition Ingest definition (yaml)
Back to top

Parameter descriptions

Input Folder

The path and name of the folder containing images for which to create ODC yaml index files.

Quality Layer Folder

The path and name of the folder containing the quality layers for images in the Input Folder.

Output Folder

The path and name of the folder to which to write the output files.

Send Email

If necessary, you can set up CATALYST Enterprise to send an email notification on job start and job completion.

With this check box selected, an email message is sent to each address specified in the Email Addresses box after the job starts and on completion.

You can specify one or more addresses, and each must be separated by a comma or a semi-colon. The email address of the user currently logged in displays by default.

Overwrite Results

Select this check box to overwrite the existing output files, if any exist. If this check box is left clear, and an output file exists in the relevant folder, the status of the job displays a message informing you of the existence and name of the output file. The message is also written to the event log of the job.

Index Results

Whether to add the generated index to the ODC or not.

Ingest Results

Whether to ingest the indexed data into the ODC or not.

Ingest Definition

The yaml ingest definition used to ingest data into the ODC.

Back to top

Details

General job details

Preprocessing requirements

Before running this module, the following requirements must be met to ensure the job processes successfully and produces accurate results:

Module details

The Open Data Cube (ODC) Metadata Generation module reads the Input Folder for valid imagery files. Valid files which have been processed through the ARD workflow are then indexed, and optionally inserted into the ODC and ingested.

Job results

The Open Data Cube (ODC) Metadata Generation module produces a single yaml index file containing metadata for all valid input scenes.

The module also optionally indexes and ingests and input scenes into the ODC.

© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.