A two dimensional time series of values.
Usage
da.timeseries [switches…] [[station] [variables] times [archive]|[file]]
Switches
- --file=FILE
-
This is the output image file to write to. Supported formats: bmp, cur, ico, jpeg, jpg, pbm, pgm, png, ppm, svg, xbm, xpm.
Default: output.png
- --fit=TYPE
-
This is the type of fit displayed on the graph.
Default: Disabled
The possible values are:
- --fit=2poly
-
Same as --fit=secondorder
- --fit=3poly
-
Same as --fit=thirdorder
- --fit=disabled
-
No fit is displayed.
- --fit=leastsquares
-
Same as --fit=linear
- --fit=linear
-
Linear least squares.
- --fit=linearzero
-
Linear least squares forced through zero.
- --fit=lsq
-
Same as --fit=linear
- --fit=none
-
Same as --fit=disabled
- --fit=off
-
Same as --fit=disabled
- --fit=secondorder
-
Second order polynomial.
- --fit=secondorderzero
-
Second order polynomial forced through zero.
- --fit=thirdorder
-
Third order polynomial.
- --fit=thirdorderzero
-
Third order polynomial forced through zero.
- --fit=zerolinear
-
Same as --fit=linearzero
- --fit=zerosecondorder
-
Same as --fit=secondorderzero
- --fit=zerothirdorder
-
Same as --fit=thirdorderzero
- --grid=TYPE
-
This is the grid mode to display. This enables or disables the possible grids that are shown.
Default: Disabled
The possible values are:
- --grid=both
-
Both X and Y grid lines are displayed.
- --grid=disabled
-
No grid is displayed.
- --grid=enable
-
Same as --grid=both
- --grid=enabled
-
Same as --grid=both
- --grid=none
-
Same as --grid=disabled
- --grid=off
-
Same as --grid=disabled
- --grid=x
-
Only grid lines extending from the X axis are displayed.
- --grid=x-y
-
Same as --grid=both
- --grid=xy
-
Same as --grid=both
- --grid=y
-
Only grid lines extending from the Y axis are displayed.
- --height=INTEGER
-
This is the height of the output file.
Default: 768
This option only accepts integers greater than or equal to 1.
- --legend=TYPE
-
This is the legend mode to use. This sets the position of the legend for the graph.
Default: Inside top left corner
The possible values are:
- --legend=bottomleft
-
The legend is located inside the trace area at the bottom left corner.
- --legend=bottomright
-
The legend is located inside the trace area at the bottom right corner.
- --legend=disabled
-
No legend is displayed.
- --legend=inside
-
Same as --legend=topleft
- --legend=left
-
The legend is located outside and to the left of the graph.
- --legend=none
-
Same as --legend=disabled
- --legend=off
-
Same as --legend=disabled
- --legend=outside
-
Same as --legend=right
- --legend=right
-
The legend is located outside and to the right of the graph.
- --legend=topleft
-
The legend is located inside the trace area at the top left corner.
- --legend=topright
-
The legend is located inside the trace area at the top right corner.
- --log[=BOOLEAN]
-
This changes the variable axes to be logarithmic.
- --opaque[=BOOLEAN]
-
When enabled on an output format that supports transparency, this causes the output image to have an opaque white background instead of the normal transparent one.
- --quantile=NUMBER
-
This causes the plot to only include the inner percentage of data set. For example, setting this to 99, causes the graph to exclude the top and bottom 0.5% of data.
This option only accepts numbers strictly greater than 0 and less than or equal to 100. Undefined values are permitted, to indicate that the option is set but not to a specific value.
- --title=STRING
-
This is the main graph title.
- --width=INTEGER
-
This is the width of the output file.
Default: 1024
This option only accepts integers greater than or equal to 1.
- --x-title=STRING
-
This is the title output along the X axis.
Default: Generated from the axis units.
- --y=VARIABLE
-
This is the variable or variables to plot on the Y axis.
- --y-title=STRING
-
This is the title output along the Y axis.
Default: Generated from the axis units.
- --z=VARIABLE
-
This is the variable or variables that determine the trace color. This generates a continuum of colors between minimum and maximum values for the variable.
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
- Single trace
-
This will create a simple time series plot of BaG_A11 for all cut sizes.
da.plot.timeseries --y bnd A11a 2015-05-01 2015-05-03