GXFFT class¶
-
class
GXFFT
(handle=0)¶ GXFFT class.
This class allows for the application of predefined filters to data in an OASIS database. The system uses the Winograd algorithm to transform data in the spatial domain to the wavenumber or Fourier domain.
-
app_dens
(thick, dens)¶ Appparent density filter
Parameters: - thick (float) – Thickness (meters) of the earth model
- dens (float) – Background density (g/cm3) (default = 0)
New in version 5.0.
License: Geosoft Extended End-User License
-
app_susc
(strength)¶ Apparent susceptiblity filter
Parameters: strength (float) – Total magnetic field strength New in version 5.0.
License: Geosoft Extended End-User License
Note: Reduction to magnetic pole (
red_pol
) and downward continuation (contin
) should be called BEFORE usingapp_susc
.
-
b_worth
(clen, degree, filter_type)¶ Butterworth filter
Parameters: - clen (float) – Central cutoff wavelength (meter)
- degree (float) – Degree of the filter function (default = 8.0)
- filter_type (int) – Filter type: 1= Low-pass (regional) filter (default) 0= High-pass (residual) filter
New in version 5.0.
License: Geosoft Extended End-User License
-
band_pass
(llen, hlen, pass_defined)¶ Bandpass filter (using low and high wavelength cutoffs)
Parameters: - llen (float) – Low Cutoff wavelength (meters)
- hlen (float) – High Cutoff wavelength (meter)
- pass_defined (int) – 1= Pass the defined band (default); 0= Reject the band
New in version 5.0.
License: Geosoft Extended End-User License
-
contin
(dist)¶ Upward/Downward continuation filter
Parameters: dist (float) – Distance to continue; positive = downwards negative = upwards New in version 5.0.
License: Geosoft Extended End-User License
-
cos_roll
(llen, hlen, degree, type)¶ Cosine roll-off filter
Parameters: - llen (float) – Low wavelength start point (meters)
- hlen (float) – High wavelength end point (meters)
- degree (float) – Degree of the filter function (default = 2.0)
- type (int) – Filter type: 1= Low-pass (regional) filter (default) 0= High-pass (residual) filter
New in version 5.0.
License: Geosoft Extended End-User License
-
classmethod
create
(gvv, interv, trend)¶ Create a New
GXFFT
with detrend options.Parameters: - gvv (GXVV) –
GXVV
to transform. - interv (float) – Element space interval
- trend (int) – FFT_DETREND constants
Returns: GXFFT
ObjectReturn type: New in version 5.0.
License: Geosoft Extended End-User License
Note: The detrending options control the removal of a trend from the data before the
GXFFT
is applied. The default data expansion is 10% beforeGXFFT
.- gvv (GXVV) –
-
classmethod
create_ex
(gvv, interv, trend, expansion)¶ Create a New
GXFFT
with detrend and expansion options.Parameters: - gvv (GXVV) –
GXVV
to transform. - interv (float) – Element space interval
- trend (int) – FFT_DETREND constants
- expansion (float) – Minimum expansion %
Returns: GXFFT
ObjectReturn type: New in version 5.1.8.
License: Geosoft Extended End-User License
Note: The detrending options control the removal of a trend from the data before the
GXFFT
is applied. The expansion options control the minimum data expansion before theGXFFT
is applied.- gvv (GXVV) –
-
classmethod
create_ref
(gvv, interv, trend)¶ Create
GXFFT
object with detrend options from reference (original) channel, but noGXFFT
process.Parameters: - gvv (GXVV) –
GXVV
contains channel data to performGXFFT
operations upon. - interv (float) – Element space interval, should be the same as in
create_ex
call - trend (int) – FFT_DETREND constants
Returns: GXFFT
ObjectReturn type: New in version 5.0.
License: Geosoft Extended End-User License
Note: This just creates an object. It is intended to be called immediately after with
set_vv
.- gvv (GXVV) –
-
classmethod
create_ref_ex
(gvv, interv, trend, expansion, d_cmult)¶ Create
GXFFT
object with detrend and expansion options from reference (original) channel, but noGXFFT
process.Parameters: - gvv (GXVV) –
GXVV
contains channel data to performGXFFT
operations upon. - interv (float) – Element space interval, should be the same as in
create_ex
call - trend (int) – FFT_DETREND constants
- expansion (float) – Minimum expansion %, should be the same as in
create_ex
call - d_cmult (float) – DC level multiple
Returns: GXFFT
ObjectReturn type: New in version 5.1.8.
License: Geosoft Extended End-User License
Note: This just creates an object. It is intended to be called immediately after with
set_vv
.- gvv (GXVV) –
-
gaus
(dev, type)¶ Gaussian filter
Parameters: - dev (float) – Standard deviation cutoff of function (meters)
- type (int) – Filter type: 1= Low-pass (residual) filter (default) 0= High-pass (regional) filter
New in version 5.0.
License: Geosoft Extended End-User License
-
get_vv
(gv_vr, gv_vi)¶ Copies real and imaginary
GXVV
‘s to userGXVV
‘s.Parameters: New in version 5.0.
License: Geosoft Extended End-User License
-
h_drv
(order)¶ Horizontal derivative
Parameters: order (float) – Order of differentiation (default = 1) New in version 5.0.
License: Geosoft Extended End-User License
-
h_int
()¶ Horizontal integration
New in version 5.1.4.
License: Geosoft Extended End-User License
-
high_pass
(wlen, fid_int)¶ High bandpass filter
Parameters: - wlen (float) – Cutoff wavelength (meter)
- fid_int (float) – Fiducial increment of the
GXFFT
‘s channel data
New in version 5.0.
License: Geosoft Extended End-User License
-
inverse
(gvv, gv_vm)¶ Inverse the
GXFFT
from wave number domain to space domainParameters: New in version 5.0.
License: Geosoft Extended End-User License
-
is_null
()¶ Check if this is a null (undefined) instance
Returns: True if this is a null (undefined) instance, False otherwise. Return type: bool
-
low_pass
(wlen)¶ Low bandpass filter
Parameters: wlen (float) – Cutoff wavelength (meters) New in version 5.0.
License: Geosoft Extended End-User License
-
nyquist
()¶ Gets the Nyquist frequency (wavenumbers/sample unit).
Returns: Nyquist frequency (wavenumbers/sample unit). Return type: float New in version 5.0.
License: Geosoft Extended End-User License
-
rc_filter
(clen, filter_type)¶ RC filter
Parameters: - clen (float) – Central cutoff wavelength (meter)
- filter_type (int) – Filter type: 1= Low-pass (regional) filter (default) 0= High-pass (residual) filter
New in version 8.5.
License: Geosoft Extended End-User License
-
red_pol
(inc, dec, incp, dir)¶ Reduction to magnetic pole
Parameters: - inc (float) – Geomagnetic inclination (degrees)
- dec (float) – Geomagnetic declination (degrees)
- incp (float) – Inclination (degrees) for amplitude correction (default = 20.0)
- dir (float) – Direction (degrees) of Line from North
New in version 5.0.
License: Geosoft Extended End-User License
-
samp_incr
()¶ Gets the original sample increment.
Returns: Original sample increment. Return type: float New in version 5.0.
License: Geosoft Extended End-User License
-
set_vv
(gv_vr, gv_vi)¶ Sets real and imaginary VVs in
GXFFT
.Parameters: New in version 5.0.
License: Geosoft Extended End-User License
Note: The
GXVV
must have been obtained from the sameGXFFT
using theset_vv
method.
-
spectrum
(gvv)¶ Calculates a power spectrum
Parameters: gvv (GXVV) – Output power spectrum GXVV
New in version 5.0.
License: Geosoft Extended End-User License
-
v_drv
(order)¶ Vertical derivative
Parameters: order (float) – Order of differentiation (default = 1) New in version 5.0.
License: Geosoft Extended End-User License
-
v_int
()¶ Vertical integration
New in version 5.0.
License: Geosoft Extended End-User License
-
wave_incr
()¶ Get the wave number increment.
Returns: Wave number increment Return type: float New in version 5.0.
License: Geosoft Extended End-User License
-
write_spectrum
(gvv, out_file)¶ Writes a power spectrum to a file
Parameters: New in version 5.0.
License: Geosoft Extended End-User License
-
FFT_DETREND constants¶
Detrending option
-
FFT_DETREND_NONE
¶ No trend remove
-
gxapi.
FFT_DETREND_NONE
= 0
-
-
FFT_DETREND_ENDS
¶ Detrend order 1 using only two end points
-
gxapi.
FFT_DETREND_ENDS
= 1
-
-
FFT_DETREND_ALL
¶ Detrend order 1 using all data points
-
gxapi.
FFT_DETREND_ALL
= 2
-
-
FFT_DETREND_MEAN
¶ Remove mean value
-
gxapi.
FFT_DETREND_MEAN
= 3
-