This component provides a means of generating a high level summary timeline of input data. This timeline can provide information about changes to the data and metadata, coverage information, and significant events.
Usage
da.summary.timeline [switches…] [[station] variables times [archive]|[file]]
Switches
- --mode=TYPE
-
This is the base summary mode. This determines the results output as well as the method of displaying them.
Default: Instrument coverage
The possible values are:
- --mode=changes
-
Data change events
- --mode=cover
-
Coverage fraction report
- --mode=instrument
-
Instrument coverage summary
- --mode=presence
-
Variable presence summary
- --mode=variable
-
Variable coverage summary
- --active=TYPE
-
When enabled a summary of the currently active parameters is output. For example this would output the instruments active if instrument display is enabled.
Default: Determined by base mode
The possible values are:
- --active=latest
-
A summary of active parameters relative to the current time.
- --active=none
-
Latest active display disabled.
- --active=normal
-
A summary of active parameters.
- --breakdown=TYPE
-
This is the method that input data is broken down into separate traces or columns. For example in instrument mode all inputs belonging to the same instrument are combined into one output.
Default: Determined by base mode
The possible values are:
- --breakdown=flavorless
-
Break down data into a separate output for each unique combination of station, archive, and variable while combining flavors.
- --breakdown=instrument
-
Combine data for instruments together (e.x. "S11").
- --breakdown=variable
-
Break down data into a separate output for each unique combination of station, archive, variable and flavors.
- --cover[=BOOLEAN]
-
When enabled the timeline will incorporate coverage information into the display.
Default: Determined by base mode
- --data=STRING…
-
This sets any additional data paths to include in the final summary output.
- --data-active[=BOOLEAN]
-
When enabled the current values of the additional data parameters will be incorporated into the output report. This has no effect on symbol based timelines and no effect unless one or more additional data paths are set.
- --data-events[=BOOLEAN]
-
When enabled changes to the additional data specifications will be incorporated into the output. Unless one or more additional data paths are set, this will have no effect.
Default: Enabled
- --display=INTERVAL
-
This is the interval that data are displayed at. For example this sets the interval between lines in CSV report mode or the time in each symbol on a timeline. When not set it defaults to the calculation interval for reports or a fixed amount of time determined by the timeline size.
Default: Automatic
The interval must be greater than zero in length.
- --events=TYPE
-
This is the way change events are displayed.
Default: Determined by base mode
The possible values are:
- --events=csv
-
Comma separated events are displayed.
- --events=none
-
Event output disabled.
- --events=normal
-
Space separated events are displayed.
- --events=presence
-
Space separated presence or absence only events are displayed.
- --gap=INTERVAL
-
This is the interval between an event representing absence and the next valid one before anything is displayed. That is, this is them minimum amount of time something must be absent for before the absence is reported.
Default: One day
Undefined intervals are accepted. The interval must be greater than or equal to zero length.
- --instrument-active[=BOOLEAN]
-
When enabled active instrument information will be incorporated into the output report. This has no effect on symbol based timelines.
- --instrument-events[=BOOLEAN]
-
When enabled instrument change events will incorporated into the output.
Default: Determined by base mode
- --interval=INTERVAL
-
This is the interval that continuous parameters are calculated at. For example, all data are binned together at this interval when calculating coverage. This will also set the display interval if none is explicitly set.
Default: One day
The interval must be greater than zero in length.
- --legend[=BOOLEAN]
-
When set a legend is output when displaying a symbol based timeline.
Default: Enabled
- --metadata=STRING…
-
This sets any additional data paths to include in the final summary output. Because these are looked up from metadata values they will usually begin with a "^" indicating a metadata path
- --metadata-active[=BOOLEAN]
-
When enabled the current values of the additional data parameters will be incorporated into the output report. This has no effect on symbol based timelines and no effect unless one or more additional data paths are set.
- --metadata-events[=BOOLEAN]
-
When enabled changes to the additional data specifications will be incorporated into the output. Unless one or more additional data paths are set, this will have no effect.
Default: Enabled
- --presence-active[=BOOLEAN]
-
When enabled current presence information will be incorporated into the output report. This has no effect on symbol based timelines.
- --presence-events[=BOOLEAN]
-
When enabled presence change events will incorporated into the output.
Default: Determined by base mode
- --show-interval[=BOOLEAN]
-
When enabled data interval information will be incorporated into the output report. This has no effect on symbol based timelines.
- --timeline=TYPE
-
This is the way the timeline is displayed.
Default: Determined by base mode
The possible values are:
- --timeline=csv
-
A CSV style time series report is generated with the values at each time step reported as rows and with the outputs as columns.
- --timeline=horizontal
-
A timeline of symbols for each output is generated with the time axis as columns and the outputs as rows.
- --timeline=none
-
Timeline output disabled.
- --timeline=vertical
-
A timeline of symbols for each output is generated with the time axis as rows and the outputs as columns.
- --wavelength-active[=BOOLEAN]
-
When enabled current wavelength information will be incorporated into the output report. This has no effect on symbol based timelines.
- --wavelength-events[=BOOLEAN]
-
When enabled wavelength change events will incorporated into the output.
Default: Determined by base mode
Arguments
If no bare word input specification is supplied then data are read from standard input.
- station
-
This argument is used to specify the station used to look up variables that do not include a station as part of an archive read specification. The station is the three letter GAW station code of the location, such as
BND
. The argument accepts multiple stations specified as regular expressions and separated by:
or;
or,
. For exampleBND,MLO
and(BND|MLO)
are two ways of selecting both the BND and MLO stations.The special value
allstations
may also be specified to select all stations. - variables
-
This argument may be split into multiple actual program arguments. Each part consists of one or more variable specifications separated by
,
(commas). The station and archive used if none are explicitly given are defined in the other arguments or inferred from system defaults. For example simplyBsB_S11
selects the blue scattering from the S11 instrument and returns all cut sizes and metadata. If instead::BsB_S11:pm10
is used then only PM10 scattering is returned. That is, the selection specifies "any" station and archive (the defaults are set in the other arguments) then requires that it has the "PM10" flavor. A specification such asbnd:BsB_S11,thd:BsB_S11
allows for data selection from multiple stations.This may also be used to select a "record" type alias such as "S11a". In this mode all the variables defined in the alias are returned.
Finally the special value
everything
can be used to select all available data for the given station(s) and archive(s). - times
-
This argument may be split into multiple actual program arguments. This full list of time arguments defines a time bounds list that sets the range of data queried. The final resulting data are clipped to the given time bounds but any values that intersect them are returned.
- archive
-
This argument is used to specify the archive used to look up variables that do not include an archive as part of an archive read specification. The archive is the internal name, such as
raw
orclean_meta
. The argument accepts multiple archives specified as regular expressions and separated by:
or;
or,
. For exampleraw(_meta)?
selects both theraw
andraw_meta
archives.The special value
allarchives
may also be used to select all available archives. - file
-
This argument is used to specify the the file to read data from. If it is present and exists then data is read from the given file name instead of from standard input. Alternatively
-
(a single dash) may be used to explicitly specify standard input.
Examples
- Instrument and coverage information
-
da.summary.timeline bnd S11a 2015-05-01 2015-05-03
Or:
da.summary.timeline input_file.c3d
Or:
da.get bnd S11a 2015-05-01 2015-05-03 | da.summary.timeline
- Vertical instrument information at quarter resolution
-
da.summary.timeline --interval=1qa --timeline=vertical bnd S11a 2015-05-01 2015-05-03
- Coverage and data interval report
-
da.summary.timeline --mode=cover --show-interval bnd S11a 2015-05-01 2015-05-03
- Wavelength change events
-
da.summary.timeline --mode=changes --instrument-events=false --wavelength-events bnd S11a 2015-05-01 2015-05-03