MODE-Analysis Tool: General

MODE-Analysis Functionality

The MODE-Analysis tool may be used to summarize and aggregate results from one or more MODE runs. It is meant as a simple and convenient way to summarize MODE output without needing to write complicated scripts. However, users are welcome to use whatever scripting language or tools they would like to parse, summarize, and plot the MODE output.

The functionaliy of MODE-Analysis is similar to that of Stat-Analysis. You may run MODE-Analysis by passing in a configuration file containing all of the filtering parameters or pass the filtering parameters directly on the command line. For MODE-Analysis, a single job must be defined on the command line - whereas for Stat-Analysis, multiple jobs may be defined in the configuration file. MODE-Analysis currently supports two types of jobs:

• The -summary job operates on the columns of data selected by the user. For each column of data selected, it computes summary information.
• The -bycase job is used to summarize the number and area of matched/unmatched objects for each case found subject to filtering parameters.

MODE-Analysis Usage

View the usage statement for MODE-Analysis by simply typing the following:

bin/mode_analysis

Usage: mode_analysis
	-lookin path	Input MODE file or a top-level directory containing MODE files to be used (at least one required)
	-summary | -bycase	Job type to be run (exactly one required).
	[-column name]	Column of the MODE line for the analysis (at least one required for -summary job).
	[-dump_row filename]	File name to which the MODE lines used for the analysis should be written (optional).
	[-out filename]	File name to which output should be written rather than the screen (optional).
	[-log filename]	Outputs log messages to the specified file
	[-v level]	Level of logging
	[-help]	Prints this usage statement (optional).
	[MODE FILE LIST]	List of MODE file names to be used (optional).
	[-config config_file] | [MODE LINE OPTIONS]	MODEAnalysis config file containing MODE line filtering options to be used (optional). OR MODE line filtering options (see below) to be used explicitly on the command line (optional).

The usage statement is rather long since all of the filtering parameters are listed. Scroll up to the top and note that you must supply at least one directory or file in which to find MODE output (using the -lookin path command line argument) and a job specification (-summary or -bycase).

The list of MODE LINE OPTIONS in the usage statement is organized into the following 7 groups:

• The toggles selections are used to specify which MODE lines should be used for the analysis job. Users are strongly encouraged to specify these well since not doing so will lead to misleading results.
• The multiple set string options selections may be used to filter out lines based on string values in the MODE output columns.
• The multiple set integer options selections may be used to filter out lines based on integer values in the MODE output columns.
• The integer max/min options selections may be used to filter out lines based on a range of integer values in the MODE output columns.
• The date/time max/min options selections may be used to filter out lines based on date/time ranges in the MODE output columns.
• The floating point max/min options selections may be used to filter out lines based on a range of floating point values in the MODE output columns.
• The miscellaneous options selection may be used to define a polyline and select only lines with objects whose centroid resides inside that masking polyline.