readgssi

https://readgssi.readthedocs.io/en/latest
Admin
Software to read and process ground-penetrating radar data files from GSSI instruments, with tools...
Tokens:24,253
Snippets:233
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install ReadGSSI from Source using Git

Source: https://readgssi.readthedocs.io/en/latest/installing.html

Install a specific commit of ReadGSSI by cloning the repository and then installing it using pip. This is useful for development or when a specific version is required.

```bash
conda config --add channels conda-forge
conda create -n readgssi python==3.7 pandas h5py pytz obspy
conda activate readgssi
pip install git+https://github.com/iannesbitt/readgssi

```

```bash
cd ~
git clone https://github.com/iannesbitt/readgssi

# make code changes if you wish, then:

pip install ~/readgssi

```

--------------------------------

### Install readgssi from Anaconda Cloud

Source: https://readgssi.readthedocs.io/en/latest/installing.html

Create a new conda environment named 'readgssi' and install the package from the 'iannesbitt' channel. This is the recommended method for a straightforward installation.

```bash
# create an environment named readgssi and install readgssi from the iannesbitt channel:
conda create -n readgssi -c iannesbitt readgssi
# and then activate the environment by doing:
conda activate readgssi

```

--------------------------------

### Install ReadGSSI on ARMv7l Architecture

Source: https://readgssi.readthedocs.io/en/latest/installing.html

Commands for installing ReadGSSI and its dependencies on an ARMv7l architecture, such as a Raspberry Pi. This includes system package installations and pip upgrades.

```bash
# from https://github.com/obspy/obspy/wiki/Installation-on-Linux-via-Apt-Repository
deb http://deb.obspy.org stretch main
wget --quiet -O - https://raw.github.com/obspy/obspy/master/misc/debian/public.key | sudo apt-key add -
sudo apt-get update
sudo apt-get install python-obspy python3-obspy
sudo apt-get install ttf-bistream-vera
rm -rf ~/.matplotlib ~/.cache/matplotlib
sudo apt-get install python-pandas python-h5py
pip install -U pytz pynmea2 geopy readgssi

```

--------------------------------

### Install ReadGSSI from PyPI using Conda

Source: https://readgssi.readthedocs.io/en/latest/installing.html

Use this command to set up a conda environment and install ReadGSSI from PyPI. This ensures dependencies are managed within a dedicated environment.

```bash
conda config --add channels conda-forge
conda create -n readgssi python==3.7 pandas h5py pytz obspy
conda activate readgssi
pip install readgssi

```

--------------------------------

### Basic ReadGSSI Testing Commands

Source: https://readgssi.readthedocs.io/en/latest/installing.html

Verify the ReadGSSI installation by checking its version and help text. These commands confirm that the package is accessible and functional after installation.

```bash
readgssi -V  # this will display the version
readgssi -h  # this will display the help text

```

--------------------------------

### Verify Conda Installation

Source: https://readgssi.readthedocs.io/en/latest/installing.html

Check if conda is installed and accessible in your terminal.

```bash
conda --version

```

--------------------------------

### Display readgssi Help Text

Source: https://readgssi.readthedocs.io/en/latest/general.html

Run `readgssi -h` in your bash console to view all available command-line options and their descriptions. This is essential for understanding how to use the tool for file processing.

```bash
readgssi -h
```

--------------------------------

### Generate SVG plot with custom DPI and no title

Source: https://readgssi.readthedocs.io/en/latest/plotting.html

Output plots in SVG format for scalable vector graphics, ideal for journals. This example also sets DPI to 300 and removes the title.

```python
readgssi.readgssi(infile='DZT__001.DZT', outfile='0d.svg', frmt='svg',
                  zero=[233], plotting=True, figsize=5, stack='auto',
                  gain=60, epsr=80, z='m', title=False, dpi=300,
                  freqmin=70, freqmax=130, bgr=True, win=75)

```

```bash
readgssi -i DZT__001.DZT -o 0d.svg -f svg -Z 233 -p 5 -s auto -g 60 -z m -E 80 -T -D 300 -r 75 -t 70-130

```

--------------------------------

### readgssi.dzt.header_info

Source: https://readgssi.readthedocs.io/en/latest/dzt.html

Prints relevant header data from a DZT file.

```APIDOC
## readgssi.dzt.header_info(_header_, _data_)

### Description
Function to print relevant header data.

### Parameters
#### Path Parameters
- **header** (dict) - The header dictionary
- **data** (numpy.ndarray) - The data array
```

--------------------------------

### Process all DZT files in a folder

Source: https://readgssi.readthedocs.io/en/latest/advanced.html

Loops through all files ending with .DZT in the current directory and processes each using readgssi with specified parameters. Use this to batch process a directory of data.

```bash
for f in `ls *.DZT`; do readgssi -p 8 -n -r 0 -g 40 -Z 233 -z ns -N -x m -s auto -i $f; done
```

--------------------------------

### Basic Plotting with Bash

Source: https://readgssi.readthedocs.io/en/latest/plotting.html

Plot radargrams directly from the command line using the `-p` flag for plot height and `-Z` for the zero offset. This is useful for quick visualizations.

```bash
readgssi -i DZT__001.DZT -o 0a.png -Z 233 -p 5

```

--------------------------------

### readgssi.readgssi.main()

Source: https://readgssi.readthedocs.io/en/latest/readgssi.html

This function is used to gather and parse command-line arguments for creating function calls. It is not intended for use directly from the Python console.

```APIDOC
## readgssi.readgssi.main()

### Description
Gathers and parses command line arguments to create function calls. This function is not for use from the python console.

### Method
(Not applicable, command-line interface function)

### Endpoint
(Not applicable, command-line interface function)
```

--------------------------------

### Setting Z-axis Units to Meters (Python and Bash)

Source: https://readgssi.readthedocs.io/en/latest/plotting.html

Display the Z-axis in meters for depth measurements. Use `epsr` and `z='m'` in Python, or `-E` and `-z m` in bash. This requires setting the relative permittivity (`epsr`) to approximate material properties.

```python
readgssi.readgssi(infile='DZT__001.DZT', outfile='0c.png', frmt=None,
                  zero=[233], plotting=True, figsize=5, stack='auto',
                  gain=60, epsr=80, z='m')

```

```bash
readgssi -i DZT__001.DZT -o 0c.png -Z 233 -p 5 -s auto -g 60 -z m -E 80

```

--------------------------------

### Read DZT file information with bash

Source: https://readgssi.readthedocs.io/en/latest/reading.html

Use the `readgssi` command with the `-i` flag followed by the DZT filename to print header information. This is useful for quickly inspecting file contents and metadata from the terminal.

```bash
$ readgssi -i DZT__001.DZT
2019-07-22 16:56:20 - reading...
2019-07-22 16:56:20 - input file:         DZT__001.DZT
2019-07-22 16:56:20 - WARNING: no time zero specified for channel 0, defaulting to 2
2019-07-22 16:56:20 - success. header values:
2019-07-22 16:56:20 - system:             SIR 4000 (system code 8)
2019-07-22 16:56:20 - antennas:           ['3207', None, None, None]
2019-07-22 16:56:20 - time zeros:         [2, None, None, None]
2019-07-22 16:56:20 - ant 0 center freq:  100 MHz
2019-07-22 16:56:20 - date created:       2017-07-25 18:21:24+00:00
2019-07-22 16:56:20 - date modified:      2018-08-06 17:02:24+00:00
2019-07-22 16:56:20 - gps-enabled file:   yes
2019-07-22 16:56:20 - number of channels: 1
2019-07-22 16:56:20 - samples per trace:  2048
2019-07-22 16:56:20 - bits per sample:    32 signed
2019-07-22 16:56:20 - traces per second:  24.0
2019-07-22 16:56:20 - traces per meter:   300.0
2019-07-22 16:56:20 - epsr:               80.0
2019-07-22 16:56:20 - speed of light:     3.35E+07 m/sec (11.18% of vacuum)
2019-07-22 16:56:20 - sampling depth:     33.5 m
2019-07-22 16:56:20 - "rhf_top":          3.4 m
2019-07-22 16:56:20 - offset to data:     131072 bytes
2019-07-22 16:56:20 - traces:             28343
2019-07-22 16:56:20 - seconds:            1180.95833333
2019-07-22 16:56:20 - array dimensions:   2048 x 28343
2019-07-22 16:56:20 - beginning processing for channel 0 (antenna 3207)

```

--------------------------------

### Basic Plotting with Python

Source: https://readgssi.readthedocs.io/en/latest/plotting.html

Use this Python snippet for basic radargram plotting. Set `plotting=True` and specify `figsize` for vertical plot size. The `zero` parameter removes data before the direct wave.

```python
from readgssi import readgssi
readgssi.readgssi(infile='DZT__001.DZT', outfile='0a.png', frmt=None,
                  zero=[233], plotting=True, figsize=5)

```

--------------------------------

### readgssi.arrayops.stack

Source: https://readgssi.readthedocs.io/en/latest/arrayops.html

Applies a stacking algorithm to sum adjacent traces, reducing noise and aiding in visualization.

```APIDOC
## stack()

### Description
Stacking algorithm. Stacking is the process of summing adjacent traces in order to reduce noise — the thought being that random noise around zero will cancel out and data will either add or subtract, making it easier to discern. It is also useful for displaying long lines on a computer screen. Usage is covered in the Stacking section of the tutorial. `stack='auto'` results in an approximately 2.5:1 x:y axis ratio. `stack=3` sums three adjacent traces into a single trace across the width of the array.

### Parameters
- **ar** (numpy.ndarray) - Input data array
- **by** (int) - Factor to stack by. Default is “auto”.

### Return
radar array (numpy.ndarray)
```

--------------------------------

### Basic readgssi Bash Usage

Source: https://readgssi.readthedocs.io/en/latest/general.html

The fundamental structure for using `readgssi` from the command line requires specifying an input file with the `-i` or `--infile` flag. This is the minimum required to process a GSSI data file.

```bash
readgssi -i input.DZT [OPTIONS]
```

--------------------------------

### Translate Radar Data to CSV

Source: https://readgssi.readthedocs.io/en/latest/translate.html

Outputs radar data to a CSV file using pandas. Requires the radar array, output file path, and optionally a header dictionary and verbosity setting.

```python
readgssi.translate.csv(_ar_ , _outfile_abspath_ , _header =None_, _verbose =False_)
```

--------------------------------

### readgssi.dzt.readdzt

Source: https://readgssi.readthedocs.io/en/latest/dzt.html

Unpacks and returns header, data, and GPS information from a DZT file.

```APIDOC
## readgssi.dzt.readdzt(_infile, gps=Empty DataFrame Columns: [] Index: [], spm=None, start_scan=0, num_scans=-1, epsr=None, antfreq=[None, None, None, None], verbose=False, zero=[None, None, None, None]_)

### Description
Function to unpack and return things the program needs from the file header, and the data itself.

### Parameters
#### Path Parameters
- **infile** (str) - The DZT file location
- **gps** (bool) - Whether a GPS file exists. Defaults to False, but changed to `pandas.DataFrame` if a DZG file with the same name as `infile` exists.
- **spm** (float) - User value of samples per meter, if specified. Defaults to None.
- **epsr** (float) - User value of relative permittivity, if specified. Defaults to None.
- **zero** (list [int, int, int, int]) - List of time-zero values per channel. Defaults to a list of `None` values, which resolves to `rh_zero`.
- **verbose** (bool) - Verbose, defaults to False

### Return type
header (dict), radar array (numpy.ndarray), gps (False or `pandas.DataFrame`)
```

--------------------------------

### Process specific DZT files by numeric range

Source: https://readgssi.readthedocs.io/en/latest/advanced.html

Processes a sequential subset of DZT files (e.g., FILE__010.DZT to FILE__025.DZT) using bash's brace expansion. This is useful for targeted processing of files within a known naming convention.

```bash
for f in `ls FILE__{010..025}.DZT`; do readgssi -p 8 -n -r 0 -g 40 -Z 233 -z ns -N -x m -s auto -i $f; done
```

--------------------------------

### Setting Gain for Plotting (Python and Bash)

Source: https://readgssi.readthedocs.io/en/latest/plotting.html

Adjust radar signal gain for better visualization. Use the `gain` parameter in Python or `-g` in bash. The `stack='auto'` option is also included for optimal stacking.

```python
readgssi.readgssi(infile='DZT__001.DZT', outfile='0b.png', frmt=None,
                  zero=[233], plotting=True, figsize=5, stack='auto',
                  gain=60)

```

```bash
readgssi -i DZT__001.DZT -o 0b.png -Z 233 -p 5 -s auto -g 60

```

--------------------------------

### translate.segy

Source: https://readgssi.readthedocs.io/en/latest/translate.html

Outputs data to SEGY format. Warning: SEGY output is not yet available.

```APIDOC
## translate.segy

### Description
Outputs data to SEGY format.
Warning: SEGY output is not yet available.
In the future, this function will output to SEGY format.

### Parameters

#### Parameters
- **ar** (numpy.ndarray) - Required - Radar array
- **outfile_abspath** (str) - Required - Output file path
- **header** (dict) - Optional - File header dictionary to write, if desired. Defaults to None.
- **verbose** (bool) - Optional - Verbose, defaults to False
```

--------------------------------

### Basic DZT Translation

Source: https://readgssi.readthedocs.io/en/latest/translating.html

Translate radar data to the native DZT format. Use this for basic conversion without any processing.

```python
readgssi.readgssi(infile='DZT__001.DZT', outfile='DZT__001-out.DZT', frmt='dzt')
```

```bash
readgssi -i DZT__001.DZT -o DZT__001-out.DZT -f dzt
```

--------------------------------

### translate.h5

Source: https://readgssi.readthedocs.io/en/latest/translate.html

Outputs data to HDF5 format. Warning: HDF5 output is not yet available.

```APIDOC
## translate.h5

### Description
Outputs data to HDF5 format.
Warning: HDF5 output is not yet available.
In the future, this function will output to HDF5 format.

### Parameters

#### Parameters
- **ar** (numpy.ndarray) - Required - Radar array
- **infile_basename** (str) - Required - Input file basename
- **outfile_abspath** (str) - Required - Output file path
- **header** (dict) - Optional - File header dictionary to write, if desired. Defaults to None.
- **verbose** (bool) - Optional - Verbose, defaults to False
```

--------------------------------

### Autostacking Radar Data in Python and Bash

Source: https://readgssi.readthedocs.io/en/latest/processing.html

Use 'auto' stacking for automatic adjustment of the stacking parameter based on the array's width-to-height ratio. This is useful for reducing manual effort in determining optimal stacking values.

```python
readgssi.readgssi(infile='DZT__001.DZT', outfile='1a.png', frmt=None,
                  zero=[233], plot=5, gain=60, stack='auto')

```

```bash
readgssi -i DZT__001.DZT -o 1a.png -Z 233 -p 5 -g 60 -s auto

```

--------------------------------

### translate.writetime

Source: https://readgssi.readthedocs.io/en/latest/translate.html

Writes datetime objects to `rfDateByte` binary objects in DZT headers. This is the inverse of the `readgssi.dzt.readtime()` function.

```APIDOC
## translate.writetime

### Description
Function to write dates to `rfDateByte` binary objects in DZT headers. An inverse of the `readgssi.dzt.readtime()` function.
DZT `rfDateByte` objects are 32 bits of binary (01001010111110011010011100101111), structured as little endian u5u6u5u5u4u7 where all numbers are base 2 unsigned int (uX) composed of X number of bits. Four bytes is an unnecessarily high level of compression for a single date object in a filetype that often contains tens or hundreds of megabytes of array information anyway.
So this function reads a datetime object and outputs (seconds/2, min, hr, day, month, year-1980).
For more information on `rfDateByte`, see page 55 of GSSI’s SIR 3000 manual.

### Parameters

#### Parameters
- **d** (datetime) - Required - the `datetime.datetime` to be encoded

### Return type
bytes
```

--------------------------------

### readgssi.dzx.get_user_marks

Source: https://readgssi.readthedocs.io/en/latest/dzx.html

Finds and returns a list of user marks from a DZX file. Note: This function may be prone to errors due to variations in DZX file formats.

```APIDOC
## `readgssi.dzx.get_user_marks`

### Description
Finds and returns a list of user marks from a dzx. Since there are multiple types of dzx without good documentation, this is prone to errors.

### Parameters
#### Path Parameters
- **infile** (str) - Required - The full DZX file path
- **verbose** (bool) - Optional - Verbosity, defaults to False
```

--------------------------------

### Translate Radar Data to DZT

Source: https://readgssi.readthedocs.io/en/latest/translate.html

Outputs radar data to a RADAN-compatible DZT file. This function is only compatible with single-channel files and is useful for circumventing RADAN's distance-normalization bug. It requires the radar array, output file path, a header dictionary, and optionally a verbosity setting.

```python
readgssi.translate.dzt(_ar_ , _outfile_abspath_ , _header_ , _verbose =False_)
```

```python
from readgssi.dzt import readdzt
from readgssi import translate
from readgssi.arrayops import stack, distance_normalize

# first, read a data file
header, data, gps = readdzt('FILE__001.DZT')

# do some stuff
# (distance normalization must be done before stacking)
for a in data:
    header, data[a], gps = distance_normalize(header=header, ar=data[a], gps=gps)
    header, data[a], stack = stack(header=header, ar=data[a], stack=10)
```

--------------------------------

### translate.numpy

Source: https://readgssi.readthedocs.io/en/latest/translate.html

Outputs data to a binary NumPy file (.npy) with an option to write the header to a .json file as well.

```APIDOC
## translate.numpy

### Description
Outputs to binary numpy binary file (.npy) with the option of writing the header to .json as well.

### Parameters

#### Parameters
- **ar** (numpy.ndarray) - Required - Radar array
- **outfile_abspath** (str) - Required - Output file path
- **header** (dict) - Optional - File header dictionary to write, if desired. Defaults to None.
- **verbose** (bool) - Optional - Verbose, defaults to False
```

--------------------------------

### readgssi.functions.dzxerror

Source: https://readgssi.readthedocs.io/en/latest/functions.html

Prints an error message and calls genericerror with filetype set to 'DZX'.

```APIDOC
## `readgssi.functions.dzxerror(_e =''_)`

### Description
Prints an error message then calls gpx2dzg.functions.genericerror() and passes filetype=’DZX’.

### Parameters
#### Path Parameters
- **e** (estr) - Required - The error message to print.
```

--------------------------------

### Read GSSI Data to Python Objects (Python)

Source: https://readgssi.readthedocs.io/en/latest/reading.html

Read a GSSI .DZT file into header (dict), radar arrays (numpy.ndarray), and GPS info (pandas.DataFrame). Suppress console output by omitting `verbose=True` and `frmt=None`. You can set the time zero using the `zero` parameter.

```python
>>> hdr, arrs, gps = readgssi.readgssi(infile='DZT__001.DZT', zero=[233])
>>> type(hdr)
<class 'dict'>
>>> type(arr[0])
<class 'numpy.ndarray'>
>>> type(gps)
<class 'pandas.core.frame.DataFrame'>
```

```python
>>> hdr, arrs, gps = readgssi.readgssi(infile='DZT__002.DZT', zero=[233])
2019-07-22 17:28:43 - WARNING: no DZG file found for GPS import
>>> print(gps)
False
```

--------------------------------

### Read GSSI File Header in Python

Source: https://readgssi.readthedocs.io/en/latest/general.html

Use the `readgssi.readgssi()` function to print header information from a GSSI radar data file. This is useful for quickly inspecting file metadata. Note potential warnings about time zero defaults.

```python
>>> from readgssi import readgssi
>>> readgssi.readgssi(infile='DZT__001.DZT', frmt=None, verbose=True)
2019-07-22 16:56:20 - reading...
2019-07-22 16:56:20 - input file:         DZT__001.DZT
2019-07-22 16:56:20 - WARNING: no time zero specified for channel 0, defaulting to 2
2019-07-22 16:56:20 - success. header values:
2019-07-22 16:56:20 - system:             SIR 4000 (system code 8)
2019-07-22 16:56:20 - antennas:           ['3207', None, None, None]
2019-07-22 16:56:20 - time zeros:         [2, None, None, None]
2019-07-22 16:56:20 - ant 0 center freq:  100 MHz
2019-07-22 16:56:20 - date created:       2017-07-25 18:21:24+00:00
2019-07-22 16:56:20 - date modified:      2018-08-06 17:02:24+00:00
2019-07-22 16:56:20 - gps-enabled file:   yes
2019-07-22 16:56:20 - number of channels: 1
2019-07-22 16:56:20 - samples per trace:  2048
2019-07-22 16:56:20 - bits per sample:    32 signed
2019-07-22 16:56:20 - traces per second:  24.0
2019-07-22 16:56:20 - traces per meter:   300.0
2019-07-22 16:56:20 - epsr:               80.0
2019-07-22 16:56:20 - speed of light:     3.35E+07 m/sec (11.18% of vacuum)
2019-07-22 16:56:20 - sampling depth:     33.5 m
2019-07-22 16:56:20 - "rhf_top":          3.4 m
2019-07-22 16:56:20 - offset to data:     131072 bytes
2019-07-22 16:56:20 - traces:             28343
2019-07-22 16:56:20 - seconds:            1180.95833333
2019-07-22 16:56:20 - array dimensions:   2048 x 28343
2019-07-22 16:56:20 - beginning processing for channel 0 (antenna 3207)
>>>
```

--------------------------------

### Combine Boxcar and Frequency Filters

Source: https://readgssi.readthedocs.io/en/latest/processing.html

Combine the boxcar moving window filter and the vertical triangular filter for enhanced GSSI data cleaning. This can significantly improve the clarity of features like thermoclines in lake profiles.

```python
readgssi.readgssi(infile='DZT__001.DZT', outfile='2c.png', frmt=None,
                  zero=[233], plot=5, stack='auto', gain=60, dpi=300,
                  bgr=100, freqmin=60, freqmax=100)
```

```bash
readgssi -i DZT__001.DZT -o 2c.png -Z 233 -p 5 -s auto -g 60 -D 300 -r 100 -t 70-130
```

--------------------------------

### readgssi.functions.dzterror

Source: https://readgssi.readthedocs.io/en/latest/functions.html

Prints an error message and calls genericerror with filetype set to 'DZT'.

```APIDOC
## `readgssi.functions.dzterror(_e =''_)`

### Description
Prints an error message then calls gpx2dzg.functions.genericerror() and passes filetype=’DZT’.

### Parameters
#### Path Parameters
- **e** (estr) - Required - The error message to print.
```

--------------------------------

### readgssi.functions.naming

Source: https://readgssi.readthedocs.io/en/latest/functions.html

Generates a descriptive filename based on processing steps. Useful for tracking data transformations.

```APIDOC
## readgssi.functions.naming

### Description
The Dr. Seth W. Campbell Honorary Naming Scheme. Descriptive naming, used to indicate the processing steps done on each file, if a specific output filename is not given. The theory behind this naming scheme is simple: it can be tough to remember how you made that plot!

### Parameters
* **outfile** (str) - The base output filename. If None, a new `outfile` will be generated from the input file basename. If it already exists, subsequent arguments will be appended. Defaults to None.
* **infile_basename** (str) - The input file basename (without file extension). Defaults to None.
* **chans** (list[int]) - A list of channels, which is converted to the number of channels using `len()`. Defaults to [1].
* **chan** (int) - The current channel number. Defaults to 0.
* **normalize** (bool) - Whether or not the array is distance-normalized. Defaults to False.
* **zero** (int) - The zero point for this particular channel. Defaults to None.
* **stack** (int) - The number of times the array was stacked. Defaults to 1.
* **reverse** (bool) - Whether or not the file was reversed. Defaults to False.
* **bgr** (bool) - Whether or not BGR was applied. Defaults to False.
* **win** (int) - The BGR window size if applicable. 0 is full-width BGR, greater than 0 is window size. Defaults to None.
* **gain** (float) - The gain value applied to the plot. Defaults to None.
* **dewow** (bool) - Whether or not dewow was applied. Defaults to None.
* **freqmin** (int) - The lower corner of the bandpass filter if applicable. Defaults to None.
* **freqmax** (int) - The upper corner of the bandpass filter if applicable. Defaults to None.
* **plotting** (int) - Stand-in for whether or not a plot was generated. The integer represents the plot height. Defaults to None.
* **zoom** (list[int]) - The zoom extents applied to the image. Defaults to None.
* **absval** (bool) - Whether or not the plot is displayed with absolute value of gradient. Defaults to False.
```

--------------------------------

### Update ANT dictionary in readgssi.config

Source: https://readgssi.readthedocs.io/en/latest/troubleshooting.html

Modify the ANT dictionary in `readgssi.config` to add new antenna codes and their corresponding center frequencies. This is necessary when encountering KeyError related to 'ANT' in `readgssi.dzt.readdzt()`.

```python
ANT = {
    # 'code': integer center frequency
    '100MHz': 100,
    '200MHz': 200,
    '270MHz': 270,
    '350MHz': 350,
    '400MHz': 400,
    '500MHz': 500,
    '800MHz': 800,
    '900MHz': 900,
    '1600MHz': 1600,
    '2000MHz': 2000,
    '2300MHz': 2300,
    '2600MHz': 2600,
    '3200': 'adjustable',
    '3200MLF': 'adjustable',
    'gprMa': 'adjustable',      # gprMax support
    'GSSI': 'adjustable',       # support for issue #11
    'CUSTOM': 'adjustable',
    '3207': 100,
    '3207AP': 100,
    '5106': 200,
    '5106A': 200,
    '50300': 300,
    '350': 350,
    '350HS': 350,
    'D400HS': 350,
    '50270': 270,
    '50270S': 270,
    'D50300': 300,
    '5103': 400,
    '5103A': 400,
    '50400': 400,
    '50400S': 400,
    '800': 800,
    'D50800': 800,
    '3101': 900,
    '3101A': 900,
    '51600': 1600,
    '51600S': 1600,
    'SS MINI': 1600,
    '62000': 2000,
    '62000-003': 2000,
    '62300': 2300,
    '62300XT': 2300,
    '52600': 2600,
    '52600S': 2600,
}
```

--------------------------------

### readgssi.dzt.readtime

Source: https://readgssi.readthedocs.io/en/latest/dzt.html

Reads dates from `rfDateByte` binary objects in DZT headers.

```APIDOC
## readgssi.dzt.readtime(_bytez_)

### Description
Function to read dates from `rfDateByte` binary objects in DZT headers.
DZT `rfDateByte` objects are 32 bits of binary (01001010111110011010011100101111), structured as little endian u5u6u5u5u4u7 where all numbers are base 2 unsigned int (uX) composed of X number of bits. Four bytes is an unnecessarily high level of compression for a single date object in a filetype that often contains tens or hundreds of megabytes of array information anyway.
So this function reads (seconds/2, min, hr, day, month, year-1980) then does seconds*2 and year+1980 and returns a datetime object.
For more information on `rfDateByte`, see page 55 of GSSI’s SIR 3000 manual.

### Parameters
#### Path Parameters
- **bytes** (bytes) - The `rfDateByte` to be decoded

### Return type
`datetime.datetime`
```

--------------------------------

### readgssi.functions.printmsg

Source: https://readgssi.readthedocs.io/en/latest/functions.html

Prints a message to the console with a date and timestamp.

```APIDOC
## readgssi.functions.printmsg

### Description
Prints with date/timestamp.

### Parameters
* **msg** (str) - Message to print
```

--------------------------------

### Plot Absolute Gradient with Bash

Source: https://readgssi.readthedocs.io/en/latest/plotting.html

Use the `-A` flag for absolute value and `-c gray_r` for a reversed grayscale colormap to plot the absolute gradient. This helps in identifying areas of polarity change, especially in ice environments with low electrical contrast.

```bash
readgssi -i DZT__001.DZT -o 0f.png -n -Z 233 -p 5 -s auto -g 100 -z m -E 80 -r 75 -t 70-130 -A -c gray_r

```

--------------------------------

### translate.gprpy

Source: https://readgssi.readthedocs.io/en/latest/translate.html

Saves data in a format compatible with GPRPy (numpy binary .npy and a .json formatted header file). Note: GPRPy support for this feature is forthcoming.

```APIDOC
## translate.gprpy

### Description
Saves data in a format GPRPy can open (numpy binary .npy and a .json formatted header file).
Note: GPRPy support for this feature is forthcoming (https://github.com/NSGeophysics/GPRPy/issues/3#issuecomment-460462612).

### Parameters

#### Parameters
- **ar** (numpy.ndarray) - Required - Radar array
- **outfile_abspath** (str) - Required - Output file path
- **header** (dict) - Optional - File header dictionary to write, if desired. Defaults to None.
- **verbose** (bool) - Optional - Verbose, defaults to False
```

--------------------------------

### translate.json_header

Source: https://readgssi.readthedocs.io/en/latest/translate.html

Saves header values as a .json file, which can be used by other scripts, such as for exporting to GPRPy.

```APIDOC
## translate.json_header

### Description
Saves header values as a .json so another script can take what it needs. This is used to export to GPRPy.

### Parameters

#### Parameters
- **header** (dict) - Required - The file header dictionary
- **outfile_abspath** (str) - Required - Output file path
- **verbose** (bool) - Optional - Verbose, defaults to False
```

--------------------------------

### Plot Absolute Gradient with Python

Source: https://readgssi.readthedocs.io/en/latest/plotting.html

Use `absval=True` and `colormap='gray_r'` to plot the absolute value of the vertical gradient, highlighting areas of polarity change. This is useful for distinguishing glacial bed material through ice.

```python
readgssi.readgssi(infile='DZT__001.DZT', outfile='0e.png',
                  zero=[233], plotting=True, figsize=5, stack='auto',
                  epsr=80, z='m', title=False, dpi=300, gain=100,
                  absval=True, colormap='gray_r',
                  freqmin=70, freqmax=130, bgr=True, win=75)

```

--------------------------------

### Generate plot with 'seismic' colormap

Source: https://readgssi.readthedocs.io/en/latest/plotting.html

Customize the plot's colormap by specifying 'seismic' for a diverging blue-white-red scheme. This is useful for sub-bottom seismic data.

```python
readgssi.readgssi(infile='DZT__001.DZT', outfile='0e.png', frmt=None,
                  zero=[233], plotting=True, figsize=5, stack='auto',
                  epsr=80, z='m', title=False, dpi=300, gain=60,
                  colormap='seismic',
                  freqmin=70, freqmax=130, bgr=True, win=75)

```

```bash
readgssi -i DZT__001.DZT -o 0e.png -Z 233 -p 5 -s auto -g 60 -z m -E 80 -T -D 300 -r 75 -t 70-130 -c seismic

```

--------------------------------

### Manual Stacking of Radar Data in Python and Bash

Source: https://readgssi.readthedocs.io/en/latest/processing.html

Manually specify the stacking factor to control the X-axis length of the radar plot. Use a lower number for a longer X-axis (less stacking) and a higher number for a shorter X-axis (more stacking).

```python
readgssi.readgssi(infile='DZT__001.DZT', outfile='1b.png', frmt=None,
                  zero=[233], plot=5, gain=60, stack=3)

```

```bash
readgssi -i DZT__001.DZT -o 1b.png -Z 233 -p 5 -g 60 -s 3

```

--------------------------------

### Distance Normalize GSSI Data and Display in Meters

Source: https://readgssi.readthedocs.io/en/latest/processing.html

Normalize GSSI data for time-triggered recordings and display the X-axis in meters. This is crucial for accurate distance-based rendering and requires GPS information.

```python
readgssi.readgssi(infile='DZT__001.DZT', outfile='2c.png', frmt=None,
                  zero=[233], plotting=True, figsize=5, stack='auto',
                  gain=60, normalize=True, x='m')
```

```bash
readgssi -i DZT__001.DZT -o 3a.png -Z 233 -p 5 -s auto -g 60 -N -x m
```

--------------------------------

### Numpy Binary Translation of Processed Data

Source: https://readgssi.readthedocs.io/en/latest/translating.html

Translate processed radar data to numpy binary format. This is efficient for numerical operations.

```python
readgssi.readgssi(infile='DZT__001.DZT', outfile='DZT__001.csv', frmt='numpy',
                  normalize=True, freqmin=80, freqmax=120, bgr=0)
```

```bash
readgssi -i DZT__001.DZT -o DZT__001.csv -f numpy -N -t 80-120 -r 0
```
Tokens:
Raw