Skip to content

Commit

Permalink
doc fix
Browse files Browse the repository at this point in the history
  • Loading branch information
jpjones76 committed May 24, 2016
1 parent 2466cb9 commit b670d5b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
7 changes: 6 additions & 1 deletion docs/src/seisdata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,14 @@ Utility Functions

* ``purge!, purge``: Delete all channels with no data (defined for any channel ``i`` by ``isempty(S.x[i]) == true``).

* ``randseisdata()``: Generate a SeisData structure with pseudo-random headers and data. Specify ``c=false`` to allow campaign-style channels with ``fs=0``. Specify an integer argument to set the number of channels; otherwise, ``S.n`` varies from 12 to 24.

* ``randseisobj()``: Generate a Seisobj structure with pseudo-random headers and data.

* ``sync!, sync``: Synchronize time windows for all channels and fill time gaps. Calls ``autotap!``, which in turn de-means and calls ``ungap!``.

* ``ungap!, ungap``: Fill all time gaps in each channel of regularly sampled data.
* ``ungap!, ungap``: Fill all time gaps in each channel of regularly sampled data. By default, ``ungap`` invoked alone will cosine taper non-gap subsequences of time series data (keyword ``w=true``), and will fill time gaps with the mean of non-NaN data points (keyword ``m=true``). These behaviors can be changed by changing the keywords corresponding to each.



Native File I/O
Expand Down
6 changes: 0 additions & 6 deletions docs/src/utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@
***********************************
A few utility programs are included with SeisIO.

``plotseis(S)``: Plot time-aligned trace data from SeisData structure ``S``.

``randseisdata()``: Generate a SeisData structure with pseudo-random headers and data. Specify ``c=false`` to allow campaign-style channels with ``fs=0``. Specify an integer argument to set the number of channels; otherwise, ``S.n`` varies from 12 to 24.

``randseisobj()``: Generate a Seisobj structure with pseudo-random headers and data.

``getbandcode(fs, fc=FC)``: Generate a valid FDSN-compliant one-character band code for data sampled at ``fs``; corner frequency ``FC`` is optional.

``tx = t_expand(t)``: Expand sparse delta-encoded time representation ``t`` to generate time stamps for for each value in the corresponding data ``x``.
Expand Down

0 comments on commit b670d5b

Please sign in to comment.