impdar¶
The main executable for the ImpDAR package.
usage: impdar [-h] {load,proc,plot,convert} ...
Sub-commands:¶
load¶
Load data
impdar load [-h] [-channel CHANNEL] [-gps_offset GPS_OFFSET] [-t_srs T_SRS]
[-s_srs S_SRS] [-o O] [--nans {interp,delete}] [-dname DNAME]
[--filetype {mat,pe,gssi,stomat,gprMax,gecko,segy,mcords_mat,mcords_nc,UoA_mat,UoA_h5,ramac,bsi,delores,osu,ramac,tek}]
{mat,pe,gssi,stomat,gprMax,gecko,segy,mcords_mat,mcords_nc,UoA_mat,UoA_h5,ramac,bsi,delores,osu,ramac,tek}
fns_in [fns_in ...]
Positional Arguments¶
- filetype
Possible choices: mat, pe, gssi, stomat, gprMax, gecko, segy, mcords_mat, mcords_nc, UoA_mat, UoA_h5, ramac, bsi, delores, osu, ramac, tek
Type of file
- fns_in
File(s) to load
Named Arguments¶
- -channel
Receiver channel to load this is primarily for the St. Olaf HF data.
Default: 1
- -gps_offset
Offset of GPS and data times for UoA_mat
Default: 0.0
- -t_srs
Convert to this coordinate reference system. (GDAL required), default UTM
- -s_srs
Convert from this system. (GDAL required), default UTM
- -o
Write to this filename
- --nans
Possible choices: interp, delete
Interpolate or delete bad GPS. Only used by BSI.
- -dname
Name of data field
Default: “data”
- --filetype
Possible choices: mat, pe, gssi, stomat, gprMax, gecko, segy, mcords_mat, mcords_nc, UoA_mat, UoA_h5, ramac, bsi, delores, osu, ramac, tek
Type of file
Default: “mat”
proc¶
Process data
impdar proc [-h] [-cat] [-vbp VBP VBP] [-hfilt HFILT HFILT] [-ahfilt AHFILT]
[-rev] [-nmo NMO NMO] [-crop CROP CROP CROP]
[-hcrop HCROP HCROP HCROP] [-restack RESTACK]
[-interp INTERP INTERP] [-denoise DENOISE DENOISE]
[-migrate MIGRATE] [-o O]
fn [fn ...]
Positional Arguments¶
- fn
File(s) to process
Named Arguments¶
- -cat
Concatenate the files
Default: False
- -vbp
Bandpass the data vertically at low (MHz) and high (MHz)
- -hfilt
Remove the average trace (average between hfilt0 and hfilt1)
- -ahfilt
Adaptive horizontal filtering
- -rev
Reverse profile
Default: False
- -nmo
Normal moveout correction. First argument is the transmitter-receiver separation. Second argument is the velocity of the radar wave (in m/s).
- -crop
Crop the radar data in the travel-time direction. Args are the limit, whether to crop off [“top”, “bottom”], with limit defined in terms of [“snum”, “twtt”, “depth”]
- -hcrop
Crop the radar data in the horizontal. Arguments are the limit, whether to crop off [“left”, “right], with limit defined in terms of [“tnum”, “dist”]
- -restack
Restack to this (odd) number of traces
- -interp
Reinterpolate GPS. First argument is the new spacing, in meters. Second argument is the filename (csv or mat) with the new GPS data
- -denoise
Denoising filter vertical and horizontal (scipy wiener for now)
- -migrate
Migrate with the indicated routine.
- -o
Write to this filename
plot¶
Plot data
impdar plot [-h] [-s] [-yd] [-xd] [-tr TR TR] [-power POWER]
[-spectra SPECTRA SPECTRA] [-o O] [-freq_limit FREQ_LIMIT]
[-window WINDOW] [-scaling SCALING]
fns [fns ...]
Positional Arguments¶
- fns
File(s) to plot
Named Arguments¶
- -s
Save file (do not plt.show())
Default: False
- -yd
Plot the depth rather than travel time
Default: False
- -xd
Plot the dist rather than the trace num
Default: False
- -tr
Plot the traces in this range (line plot)
- -power
Input a picked layer number to plot the RMS power for each trace in map view.
- -spectra
Plot power spectral density across traces of radar profile. Input frequency bounds (MHz).
- -o
Write to this filename
- -freq_limit
Maximum frequeny to plot power spectral density to
- -window
Type of window function to be used for the singal.periodogram() method
Default: “hanning”
- -scaling
Whether to plot power spectral density or power spectrum: default is spectrum
Default: “spectrum”
convert¶
Convert filetype (lossy)
impdar convert [-h]
[-in_fmt {mat,pe,gssi,stomat,gprMax,gecko,segy,mcords_mat,mcords_nc,UoA_mat,UoA_h5,ramac,bsi,delores,osu,ramac,tek}]
[-t_srs T_SRS]
fns_in [fns_in ...] {shp,mat,segy}
Positional Arguments¶
- fns_in
File(s) to convert
- out_fmt
Possible choices: shp, mat, segy
Named Arguments¶
- -in_fmt
Possible choices: mat, pe, gssi, stomat, gprMax, gecko, segy, mcords_mat, mcords_nc, UoA_mat, UoA_h5, ramac, bsi, delores, osu, ramac, tek
Input format type. If none, guess from extension, but be warned, we are bad at guessing!
- -t_srs
Target srs, in a format recognized by gdal. Default None (write raw input)