Command Line Interface (CLI) tool

A command line interface has been developed to be used directly from a shell prompt to access SCT functionalities with an easy to use approach. All the main functionalities are supported with a dedicated command with its help documentation.

The main command line tool that can be accessed using the sct command in your favorite shell.

Another set of companion CLI utilities has been developed aside from the main CLI tool and can be accessed using specific commands that are listed here

See the tutorials page for actual examples on how to use CLI to perform specific analyses.

SCT CLI

SCT command line can be invoked in the terminal session as:

sct [--version] [--config/-cfg] [--help/-h]

This is the entry point for the console script. The configuration needed to perform the analysis must be provided at here using the –config/-cfg argument. The available analysis have been implemented as commands of this parent CLI but the above command alone won’t perform any kind of operation. To select the operation of choice, use the available commands that can be listed using the –help/-h option.

Point Target Analysis

Point target analysis can be performed using the following command just specifying the input product and the output directory. Obviously, an external file containing point targets locations and data must be provided in order to properly run the analysis.

sct [--config "path_to_config"] target-analysis -p "product_path" -out "output_dir" -pt "point_target_file_path"

This is the basic way of performing this analysis. There are other options that can be specified for the analysis and they can be listed using the –help/-h option.

Important

The external source of point targets data provided as a .csv file must be compliant with the template that can be

downloaded from the resources folder on GitHub.

Check the related documentation for further information.

Radiometric Analysis

Radiometric analysis has been implemented with a set of commands that let the user select the specific type of Radiometric analysis to be performed, namely nesz, average elevation profiles and scalloping. Further information about each of these analysis can be found here.

sct [--config "path_to_config"] radiometric-analysis [nesz/average_profiles/scalloping] -p "product_path" -out "output_dir" -g "graphs_enabled"

To list all the available options use the –help/-h argument.