Graph Processing Tool

GPT

The Graph Processing Tool (GPT) is the command line interface for executing graphs created using the Graph Builder. Data sources and parameters found in the graph file can be replaced at the command line using arguments passed to the GPT.

The GPT could also be used to read a product, execute a single operator and produce output in the specified format without the use of a graph.


Usage:
  {0} <op>|<graph-file> [options] [<source-file-1> <source-file-2> ...]

Description:
  This tool is used to execute raster data operators in batch-mode.
  The operators can be used stand-alone or combined as a directed acyclic
  graph (DAG). Processing graphs are represented using XML. More info
  about processing graphs, the operator API, and the graph XML format can
  be found in the documentation.

Arguments:
  <op>               Name of an operator. See below for the list of <op>s.
  <graph-file>       Operator graph file (XML format).
  <source-file-i>    The <i>th source product file. The actual number of source
                     file arguments is specified by <op>. May be optional for
                     operators which use the '-S' option.

Options:
  -h                 Displays command usage. If <op> is given, the specific
                     operator usage is displayed.
  -e                 Displays more detailed error messages. Displays a stack
                     trace, if an exception occurs.
  -t <file>          The target file. Default value is ''{1}''.
  -f <format>        Output file format, e.g. ''GeoTIFF'', ''HDF5'',
                     ''BEAM-DIMAP''. If not specified, format will be derived
                     from the target filename extension, if any, otherwise the
                     default format is ''{2}''. Ony used, if the graph
                     in <graph-file> does not specify its own ''Write'' operator.
  -p <file>          A (Java Properties) file containing processing
                     parameters in the form <name>=<value>. Entries in this
                     file are overwritten by the -P<name>=<value> command-line
                     option (see below).
  -c <cache-size>    Sets the tile cache size in bytes. Value can be suffixed
                     with ''K'', ''M'' and ''G''. Must be less than maximum
                     available heap space. If equal to or less than zero, tile
                     caching will be completely disabled. The default tile
                     cache size is ''{3}M''.
  -q <parallelism>   Sets the maximum parallelism used for the computation, i.e.
                     the maximum number of parallel (native) threads.
                     The default parallelism is ''{4}''.
  -x                 Clears the internal tile cache after writing a complete
                     row of tiles to the target product file. This option may
                     be useful if you run into memory problems.
  -T<target>=<file>  Defines a target product. Valid for graphs only. <target>
                     must be the identifier of a node in the graph. The node''s
                     output will be written to <file>.
  -S<source>=<file>  Defines a source product. <source> is specified by the
                     operator or the graph. In an XML graph, all occurrences of
                     $'{<source>'} will be replaced with references to a source
                     product located at <file>.
  -P<name>=<value>   Defines a processing parameter, <name> is specific for the
                     used operator or graph. In an XML graph, all occurrences of
                     $'{<name>'} will be replaced with <value>. Overwrites
                     parameter values specified by the ''-p'' option.
  -inFolder          For graphs with ProductSetReaders such as coregistration,
                     all products found in the specified folder and subfolders
                     will be used as input to the ProductSetReader
  -printHelp         Prints the usuage help for all operators

Running from the Command Line

To be able to properly run the GPT from the command line, make sure the environment variable NEST_HOME is set to the installation folder. Also, add the installation folder to the PATH so you may call the GPT from any folder.

Some example graphs can be found in $NEST_HOME/commandline.