Skip to content

Commit 4654b39

Browse files
committed
edit docs for H,P to 12,P and ?XH to ?DH
1 parent bbf5555 commit 4654b39

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/atacr.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ horizontal (``?H1,2``) component data.
5757
It is of course possible to combine both corrections and apply them
5858
sequentially. In this case the tilt noise is removed first, followed by compliance.
5959
This analysis requires all four components: three-component
60-
seismic (``?HZ,1,2``) and pressure (``?XH``) data.
60+
seismic (``?HZ,1,2``) and pressure (``?DH``) data.
6161

6262
API documentation
6363
*****************
@@ -237,8 +237,8 @@ Usage
237237
-C CHANNELS, --channels CHANNELS
238238
Specify a comma-separated list of channels for which
239239
to perform the transfer function analysis. Possible
240-
options are 'H' (for horizontal channels) or 'P' (for
241-
pressure channel). Specifying 'H' allows for tilt
240+
options are '12' (for horizontal channels) or 'P' (for
241+
pressure channel). Specifying '12' allows for tilt
242242
correction. Specifying 'P' allows for compliance
243243
correction. [Default looks for both horizontal and
244244
pressure and allows for both tilt AND compliance
@@ -566,8 +566,8 @@ Usage
566566
-C CHANNELS, --channels CHANNELS
567567
Specify a comma-separated list of channels for which
568568
to perform the transfer function analysis. Possible
569-
options are 'H' (for horizontal channels) or 'P' (for
570-
pressure channel). Specifying 'H' allows for tilt
569+
options are '12' (for horizontal channels) or 'P' (for
570+
pressure channel). Specifying '12' allows for tilt
571571
correction. Specifying 'P' allows for compliance
572572
correction. [Default looks for both horizontal and
573573
pressure and allows for both tilt AND compliance
@@ -767,7 +767,7 @@ To check the station info for M08A, use the program ``ls_stdb``:
767767

768768
We wish to download one month of data for the station M08A for March 2012.
769769
The various options above allow us to select the additional channels to use
770-
(e.g., ``-C H,P`` for both horizontal and pressure data - which is the default
770+
(e.g., ``-C 12,P`` for both horizontal and pressure data - which is the default
771771
setting). Default frequency settings for data pre-processing match those of
772772
the Matlab ``ATaCR`` software and can therefore be ignored when calling the program.
773773
Since the file ``M08A.pkl`` contains only one station, it is not necessary to specify a
@@ -810,7 +810,7 @@ An example log printed on the terminal will look like:
810810
***********************************************************
811811
* Downloading day-long data for key 7D.M08A and day 2012.61
812812
*
813-
* Channels selected: ['H', 'P'] and vertical
813+
* Channels selected: ['12', 'P'] and vertical
814814
* 2012.061.*SAC
815815
* -> Downloading Seismic data...
816816
* ...done
@@ -826,7 +826,7 @@ An example log printed on the terminal will look like:
826826
***********************************************************
827827
* Downloading day-long data for key 7D.M08A and day 2012.62
828828
*
829-
* Channels selected: ['H', 'P'] and vertical
829+
* Channels selected: ['12', 'P'] and vertical
830830
* 2012.062.*SAC
831831
* -> Downloading Seismic data...
832832
@@ -1025,12 +1025,12 @@ Once the ``StaNoise`` objects have been produced and saved to disk, the transfer
10251025
functions across all available components can be calculated. By default the software
10261026
will calculate the ones for which the spectral averages are available.
10271027

1028-
For compliance only (i.e., only ``?HZ`` and ``?XH?`` components are available),
1028+
For compliance only (i.e., only ``?HZ`` and ``?DH?`` components are available),
10291029
the only transfer function possible is:
10301030

10311031
- ``ZP``
10321032

1033-
For tilt only (i.e., all of ``?HZ,1,2`` components are available, but not ``?XH``),
1033+
For tilt only (i.e., all of ``?HZ,1,2`` components are available, but not ``?DH``),
10341034
the transfer functions are:
10351035

10361036
- ``Z1``
@@ -1150,7 +1150,7 @@ Vanuatu earthquake (be conservative with the options), type in a terminal:
11501150
* Dep: 33.70; Mag: 6.6
11511151
* M08A -> Ev: 9651.91 km; 86.80 deg; 239.43; 40.95
11521152
1153-
* Channels selected: ['H', 'P'] and vertical
1153+
* Channels selected: ['12', 'P'] and vertical
11541154
* 2012.069.07.09
11551155
* -> Downloading Seismic data...
11561156
* ...done

docs/comply.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Once the ``StaNoise`` objects have been produced and saved to disk, the complian
165165
functions across all available components can be calculated. By default the software
166166
will calculate the ones for which the spectral averages are available.
167167

168-
If no horizontal components are available (i.e., only ``?HZ`` and ``?XH?`` components are available),
168+
If no horizontal components are available (i.e., only ``?HZ`` and ``?DH?`` components are available),
169169
the only compliance function possible is:
170170

171171
- ``ZP``

0 commit comments

Comments
 (0)