Difference between revisions of "Geopsy: Tools"

From GeopsyWiki
Jump to navigation Jump to search
Line 1: Line 1:
 
[[Image:IconTools.png|thumb|right|200px|Tools menu]]
 
[[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 plug-in 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]]. The following tools are available:
 
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==
 
*[[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
Line 22: Line 23:
  
  
As said previously the tools plug-ins can be managed in the menu [[Geopsy: Preferences#Tool plugins preferences|''Preferences'']]. However, options for tool debug are also available from command line interface :
+
 
 +
== 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
 +
 
 +
 
 +
Structure Ratios (tag=structureratio, 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 <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
 +
 
 +
 
 +
 
 +
'''Example'''
 +
 
 +
  geopsy -db /home/user/MyDatabase.gpy -tool geopsyhv -slot 1
 +
        -group "MyGroup" -param tmp.log -autowin -peaks
 +
        -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.
 +
 
 +
 
 +
== Tools debug option ==
 +
As said previously the plug-in tools can be managed in the menu [[Geopsy: Preferences#Tool plugins preferences|''Preferences'']]. Additionaly, options for tool debugs are also available from command line interface :
 
   -debug-stream            // Debug mode (redirect all logs to stdout)
 
   -debug-stream            // Debug mode (redirect all logs to stdout)
 
   -clear-tools              // Reset to default tool list
 
   -clear-tools              // Reset to default tool list
 
   -debug-tools              // Test available tools and exit
 
   -debug-tools              // Test available tools and exit
 
   -add-tool-path <PATH>    // Add ''PATH'' to the list of paths to search for tools
 
   -add-tool-path <PATH>    // Add ''PATH'' to the list of paths to search for tools
 
Some advanced signal processing tools can be run from command line interface
 
-tool fk                  // run the conventional frequency wavenumber analysis
 
-tool hrfk                // run the high resolution frequency wavenumber analysis
 
-tool hv                  // compute the Horizontal-to-Vertical ratio
 
-tool hvrotate            // compute the Horizontal-to-Vertical rotate ratio
 
-tool linearfkactive      // run the multichannel analysis of surface waves
 
-tool linearfkpassive      // run the multichannel analysis of surface waves for ambient vibrations
 
-tool spac                // run the modified spatial autocorrelation technique
 
-tool spectrum            // compute the Fourier spectrum of signals
 
-tool spectrumrotate      // compute the rotate Fourier spectrum of signals
 
-tool structure
 

Revision as of 12:57, 12 March 2010

Tools menu

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. The following tools are available:

Advanced signal processing tools


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


Structure Ratios (tag=structureratio, 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 <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


Example

 geopsy -db /home/user/MyDatabase.gpy -tool geopsyhv -slot 1
        -group "MyGroup" -param tmp.log -autowin -peaks
        -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.


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