ARD Data Packaging module


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

Back to top

Description


The ARD Data Packaging module reads the scene folder for ARD (Analysis Ready Data) images, creates per-pixel quality file and layers, generates summary quality report for ARD products and compiles ISO and CARD4L-compliant XML files containing file metadata.
Back to top

Parameters


Name Caption
Spectral Normalization Input Folder Spectral Normalization Input Folder
Pre-Spectral Normalization Input Folder Pre-Spectral Normalization Input Folder
Output Folder Output folder
Overwrite Results Overwrite existing results
Send Email Email notification settings
DEM Source DEM tile source
Circular Error 90% Circular Error 90%
Spectral Normalization Coefficient of Determination Spectral Normalization Coefficient of Determination
Spectral Normalization Valid Pixel Count Spectral Normalization Valid Pixel Count
Tier Thresholds Thresholds used to classify a metric into tiers
Organisation Name Organisation name
Street Address Street address
City City
Postal/Zip Code Postal or zip code
Country Country
Email Email
Phone Number Phone number
Fax Number Fax number
Keywords Keywords
Dataset URI Dataset URI
Abstract Abstract
Purpose Purpose
Credit Credit
Other Credits Other credits
Lineage Statement Lineage statement
Data Description Data description
Data Product URL Data product URL
Back to top

Parameter descriptions

Spectral Normalization Input Folder

The path and name of the folder containing the images that were spectrally normalized. This is usually the folder with the name "specnorm" that can be found in the Automated Spectral Normalization workflow’s output folder.

Pre-Spectral Normalization Input Folder

The path and name of the folder containing the pre-spectrally normalized images. This is typically the folder with the name "superreg" that can be found in the Automated Geometric Correction workflow’s output folder. Furthermore, this is often the input that was previously specified for the Automated Spectral Normalization workflow.

Output Folder

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

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.

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.

DEM Source

The name of a single digital elevation model (DEM) file or a folder containing one or more DEM tiles.

This parameter can be specified by using any of the following:

The index.txt file lists the DEM files contained in the specified folder and provides information describing each DEM tile. The information in the DEM index file supersedes other DEM parameters in the module; all other DEM-related parameters are ignored. For more information about the format of the index.txt file and specific requirements for the individual DEM tiles, see Format of the DEM index file.

When the value of DEM Source is the name of an existing folder, the module searches that folder for a file named index.txt, and a set of DEM raster tiles. The index.txt file contains a single vector channel that lists the DEM files contained in the specified folder and provides information describing each DEM tile.

If no value is specified for this parameter, the module uses the default global DEM installed with CATALYST Enterprise (gmted2010).

Circular Error 90%

CE90 is a measure of pixel horizontal accuracy. It means within a confidence of 90%, a pixel's offset is smaller than the number stated by CE90. The smaller the number, the better the accuracy.

Spectral Normalization Coefficient of Determination

Coefficient of determination (R squared) of the spectral normalization regression, averaged over all processed channels.

Spectral Normalization Valid Pixel Count

Number of valid pixels used in the spectral normalization.

Tier Thresholds

For each quality metrics, user can enter the lower and upper thresholds for each of the tiers.

A metric is designated as certain quality tier if it is greater or equal to the lower tier threshold, and smaller than the upper tier threshold.

Organisation Name

Your organisation name.

Street Address

The street address at which your organisation resides.

Example: 1234 Geomatics Street.

City

The city in which your organisation resides.

Postal/Zip Code

The postal/zip code for your organisation.

Country

The country in which your organisation resides.

Email

The email to contact your organisation.

Phone Number

The phone number for your organisation.

Fax Number

The fax number for your organisation.

Keywords

Comma-delimited list of keywords representing your data.

Dataset URI

Uniform Resource Identifier (URI) of the dataset to which the metadata applies.

Abstract

Brief narrative summary regarding the content of the resource.

Purpose

Summary of the intentions with which the resource was developed.

Credit

Recognition of those who contributed to the resource.

Other Credits

Other information required to complete the citation.

Lineage Statement

Statement regarding the lineage of the data set.

Data Description

A description of the raw data used to generate the data set.

Data Product URL

URL for the raw data product.

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 ARD Data Packaging module creates per-pixel quality file and layers and generates summary quality report for ARD products. It then uses input ARD images, quality file and quality report to compile ISO and CARD4L-compliant XML files.

For each scene contained in the input-scenes folder, the module spawns the following child jobs:
  • Quality Layer Generation: to generate per-pixel quality file and layers for image files
  • ARD Quality Assessment:to classify ARD products into tiers based on quality metrics
  • Data Packer: to pack metadata into XML files

Job results

The results of the processing by this module are written to subfolders created in the specified output folder, as follows:

The final XML files of ARD product will be generated in the input scene folder together with ARD images.

For more information on the results of each individual module in this workflow:

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