Difference between revisions of "Geopsy: Tools"

From GeopsyWiki
Jump to navigation Jump to search
 
(25 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Image:IconTools.png|thumb|right|200px|Tools menu]]
 
  
 
Geopsy software provides powerful tools for advanced signal processings, for instance [[Ambient_vibration_array| ambient vibration array processings]] or [[H/V_spectral_ratio|H/V spectral ratio]]. A '''plugin mechanism''' allows you to install only selected tools corresponding to your need. Through the menu [[Geopsy: Preferences#Tool plugins preferences|''Preferences'']] it is possible to add (or remove) new tools without upgrading the main Geopsy frame.
 
Geopsy software provides powerful tools for advanced signal processings, for instance [[Ambient_vibration_array| ambient vibration array processings]] or [[H/V_spectral_ratio|H/V spectral ratio]]. A '''plugin mechanism''' allows you to install only selected tools corresponding to your need. Through the menu [[Geopsy: Preferences#Tool plugins preferences|''Preferences'']] it is possible to add (or remove) new tools without upgrading the main Geopsy frame.
 +
The advanced signal processings tools are available under the menu ''Tools'' or directly by clicking on the icons in the [[Geopsy: Toolbar| toolbar]].
 +
 +
For all the tools, the data can be processed:
 +
*from a [[Geopsy: Graphic|graphic viewer]], to verify the windowing and to display the results;
 +
*from a [[Geopsy: Table|table]]. In this case, Geopsy will display only the resulting curves.
 +
  
The advanced signal processings tools are available under the menu ''Tools'' or directly by clicking on the icons in the [[Geopsy: Toolbar| toolbar]]. The following tools are available:
 
  
 
== Advanced signal processing tools==
 
== Advanced signal processing tools==
 +
 +
[[Image:IconTools.png|thumb|right|350px|Tools menu]]
 +
 
*[[FK|F-K]] : conventional frequency wavenumber technique
 
*[[FK|F-K]] : conventional frequency wavenumber technique
 
*[[HRFK|High resolution F-K]] : high resolution frequency wavenumber technique
 
*[[HRFK|High resolution F-K]] : high resolution frequency wavenumber technique
 
*[[MSPAC|MSPAC]] : modified spatial autocorrelation technique
 
*[[MSPAC|MSPAC]] : modified spatial autocorrelation technique
*[[Active_source_experiment_(MASW)|Linear F-K for ''active'' experiments]] : multichannel analysis of surface waves
+
*[[Active source experiment (MASW)|Linear F-K for active experiments]] : multichannel analysis of surface waves (MASW)
*[[Geopsy:?|Linear F-K for ''passive'' experiments]] : multichannel analysis of surface waves for ambient vibrations
+
*[[Linear FK for passive experiments]] : multichannel analysis of surface waves for ambient vibrations
 
*[[Geopsy: Damping|Damping]] : computation of damping factor for soil or structure
 
*[[Geopsy: Damping|Damping]] : computation of damping factor for soil or structure
*[[Spectral amplitudes|Spectrum]] : Fourier amplitude spectra
+
*[[Geopsy: H/V and Spectrum Toolboxes|Spectrum]] : Fourier amplitude spectra
*[[Spectrum Rotate]] : Fourier amplitude spectra in the horizontal space
+
*[[Geopsy: H/V and Spectrum Toolboxes|Spectrum Rotate]] : Fourier amplitude spectra as a function of azimuth in the horizontal plane
*[[H/V spectral ratio]] : Horizontal-to-Vertical spectral ratio
+
*[[Geopsy: H/V and Spectrum Toolboxes|H/V spectral ratio]] : Horizontal-to-Vertical spectral ratio
*[[H/V Rotate]] : Horizontal-to-Vertical rotate spectral ratio  
+
*[[Geopsy: H/V and Spectrum Toolboxes|H/V Rotate]] : Horizontal-to-Vertical spectral ratio as a function of azimuth in the horizontal plane
*[[Geopsy:?|Noise reduction]]
+
*[[Shot stacks]]: improvement of signal-to-noise ratio for refraction/MASW shots
*[[Geopsy:?|Particle motion]]
+
*[[Particle motion]]: plots particle motion on various planes
 
*Refraction with NA: obsolete
 
*Refraction with NA: obsolete
 
*[[Geopsy: Time Frequency Analysis|Time frequency analysis]]
 
*[[Geopsy: Time Frequency Analysis|Time frequency analysis]]
*[[Geopsy:?|Structure spectrum]]
+
*[[Geopsy: Structure spectrum|Structure Spectrum]]
 
+
<br style="clear: both"/>
 
 
 
 
== Use plugins with command line interface ==
 
Some advanced signal processing tools can be run from command line interface
 
-tool <TOOL>              // Use plugin with tag TOOL
 
 
 
''TOOL'' refers to one plugin, namely geopshy,
 
 
 
 
 
Spectrum (tag=geopsyhv, slot=0) options:
 
  -param <FILE.log>        Set processing parameters as specified in FILE.log
 
  -taper <PERC>            Set taper length (% of total window)
 
  -autowin                  Calculate windows automatically
 
  -loadwin <FILE.log>      Set windows from FILE.log
 
  -clearpeaks [<RES>]      Remove all existing peaks
 
  -addpeak <[RES,]MIN,MAX>  Add a peak between MIN and MAX frequency
 
  -peaks [<RES>]           Output frequency peaks
 
  -save <DIR>              Save all results in directory DIR
 
  -curves                  Output spectral curves for all windows
 
  -average                  Output average spectral curve
 
 
 
 
 
H/V (tag=geopsyhv, slot=1) options:
 
  -param <FILE.log>        Set processing parameters as specified in FILE.log
 
  -taper <PERC>            Set taper length (% of total window)
 
  -autowin                  Calculate windows automatically
 
  -loadwin <FILE.log>      Set windows from FILE.log
 
  -clearpeaks [<RES>]      Remove all existing peaks
 
  -addpeak <[RES,]MIN,MAX>  Add a peak between MIN and MAX frequency
 
  -peaks [<RES>]            Output frequency peaks
 
  -save <DIR>              Save all results in directory DIR
 
  -curves                  Output H/V curves for all windows
 
  -average                  Output H/V average curve
 
 
 
 
 
Spectrum Rotate (tag=geopsyhv, slot=2) options:
 
  -param <FILE.log>        Set processing parameters as specified in FILE.log
 
  -taper <PERC>            Set taper length (% of total window)
 
  -autowin                  Calculate windows automatically
 
  -loadwin <FILE.log>      Set windows from FILE.log
 
  -clearpeaks [<RES>]      Remove all existing peaks
 
  -addpeak <[RES,]MIN,MAX>  Add a peak between MIN and MAX frequency
 
  -peaks [<RES>]            Output frequency peaks
 
  -save <DIR>              Save all results in directory DIR
 
 
 
 
 
H/V Rotate (tag=geopsyhv, slot=3) options:
 
  -param <FILE.log>        Set processing parameters as specified in FILE.log
 
  -taper <PERC>            Set taper length (% of total window)
 
  -autowin                  Calculate windows automatically
 
  -loadwin <FILE.log>      Set windows from FILE.log
 
  -clearpeaks [<RES>]      Remove all existing peaks
 
  -addpeak <[RES,]MIN,MAX>  Add a peak between MIN and MAX frequency
 
  -peaks [<RES>]            Output frequency peaks
 
  -save <DIR>              Save all results in directory DIR
 
 
 
 
 
FK (tag=geopsyarray, slot=0) options:
 
  -param <FILE.log>        Set processing parameters as specified in FILE.log
 
  -export-grids            Export all FK grids for all frequency bands and
 
                            time windows to files fkgrid_fxxx_twxxx (be
 
                            careful, need a lot of disk space)
 
 
 
 
 
High resolution FK (tag=geopsyarray, slot=1) options:
 
  -param <FILE.log>        Set processing parameters as specified in FILE.log
 
 
 
 
 
SPAC (tag=geopsyarray, slot=2) options:
 
  -param <FILE.log>        Set processing parameters as specified in FILE.log
 
  -rings <FILE.rings>      Load ring file FILE.rings (mandatory option)
 
 
 
 
 
Linear FK Active (tag=geopsyarray, slot=3) options:
 
  -param <FILE.log>        Set processing parameters as specified in FILE.log
 
 
 
 
 
Linear FK Passive (tag=geopsyarray, slot=4) options:
 
  -param <FILE.log>         Set processing parameters as specified in FILE.log
 
  
 +
== Examples of results from advanced signal processing tools ==
  
Structure Ratios (tag=structureratio, slot=0) options:
+
*[[Geopsy: H/V and Spectrum Results|H/V Results]]
  -param <FILE.log>        Set processing parameters as specified in FILE.log
+
*[[Geopsy: H/V and Spectrum Results|Spectrum Results]]
  -taper <PERC>            Set taper length (% of total window)
+
*[[Geopsy: H/V and Spectrum Rotate Results|H/V Rotate Results]]
  -autowin                  Calculate windows automatically
+
*[[Geopsy: H/V and Spectrum Rotate Results|Spectrum Rotate Results]]
  -loadwin <FILE.log>      Set windows from FILE.log
 
  -clearpeaks <RES>        Remove all existing peaks.
 
  -addpeak <RES,MIN,MAX>    Add a peak between MIN and MAX frequency.
 
  -peaks <RES>              Output frequency peaks.
 
  -save <DIR>              Save all results in directory DIR
 
  -curves <RES>            Output spectral curves for all windows.
 
  -average <RES>            Output average spectral curve.
 
                           
 
                            RES is a number between 0 and 2:
 
                              0: (c2-c1)/c1
 
                              1: (c2-c1)/c2
 
                              2: c1/c2
 
  
 +
== Plugins ==
  
 +
The advanced signal processing tools belong to plugins that are organized as follow:
 +
* Plugin '''geopsyhv''' which contains
 +
** H/V spectral ratio
 +
** H/V rotate
 +
** Spectrum
 +
** Spectrum rotate
  
'''Example'''
+
* Plugin '''geopsyarray''' which contains
 +
** conventional frequency wavenumber technique F-K
 +
** High resolution frequency wavenumber technique HRFK
 +
** modified spatial autocorrelation technique MSPAC
 +
** multichannel analysis of surface waves for active and passive experiments
  
  geopsy -db /home/user/MyDatabase.gpy -tool geopsyhv -slot 1
+
* Plugin '''structureratio''' which contains
        -group "MyGroup" -param tmp.log -autowin -peaks
+
** Structure spectrum
        -clearpeaks -addpeak "4,6" -peaks
 
  
Open the  database "MyDatabase.gpy" and start H/V processing on group of signals named "MyGroup"'. Automatic windowing is used. Parameters are defined by "tmp.log". The default peaks are printed. Then, the list of peaks is cleared and a new one is added between 4 and 6 Hz.
+
== Command line tools ==
  
 +
* [[geopsy-fk]]: FK processing, equivalent to the tools available in plugin ''geopsyarray''.
 +
* [[geopsy-spac]]: SPAC processing, equivalent to the tools available in plugin ''geopsyarray''.
 +
* [[geopsy-hv]]: HVSR and spectra computation, equivalent to the tools available in plugin ''geopsyhv''.
 +
* [[geopsy-corr]]: cross-correlation computation over long time series.
  
 
== Tools debug option ==
 
== Tools debug option ==

Latest revision as of 08:49, 25 January 2024

Geopsy software provides powerful tools for advanced signal processings, for instance ambient vibration array processings or H/V spectral ratio. A plugin mechanism allows you to install only selected tools corresponding to your need. Through the menu Preferences it is possible to add (or remove) new tools without upgrading the main Geopsy frame. The advanced signal processings tools are available under the menu Tools or directly by clicking on the icons in the toolbar.

For all the tools, the data can be processed:

  • from a graphic viewer, to verify the windowing and to display the results;
  • from a table. In this case, Geopsy will display only the resulting curves.


Advanced signal processing tools

Tools menu


Examples of results from advanced signal processing tools

Plugins

The advanced signal processing tools belong to plugins that are organized as follow:

  • Plugin geopsyhv which contains
    • H/V spectral ratio
    • H/V rotate
    • Spectrum
    • Spectrum rotate
  • Plugin geopsyarray which contains
    • conventional frequency wavenumber technique F-K
    • High resolution frequency wavenumber technique HRFK
    • modified spatial autocorrelation technique MSPAC
    • multichannel analysis of surface waves for active and passive experiments
  • Plugin structureratio which contains
    • Structure spectrum

Command line tools

  • geopsy-fk: FK processing, equivalent to the tools available in plugin geopsyarray.
  • geopsy-spac: SPAC processing, equivalent to the tools available in plugin geopsyarray.
  • geopsy-hv: HVSR and spectra computation, equivalent to the tools available in plugin geopsyhv.
  • geopsy-corr: cross-correlation computation over long time series.

Tools debug option

As said previously the plug-in tools can be managed in the menu Preferences. Additionaly, options for tool debugs are also available from command line interface :

 -debug-stream             // Debug mode (redirect all logs to stdout)
 -clear-tools              // Reset to default tool list
 -debug-tools              // Test available tools and exit
 -add-tool-path <PATH>     // Add PATH to the list of paths to search for tools