Difference between revisions of "Geopsy: Tools"

From GeopsyWiki
Jump to navigation Jump to search
Line 22: Line 22:
 
*[[Geopsy:?|Structure Spectrum]]
 
*[[Geopsy:?|Structure Spectrum]]
  
== Use plugins with command line interface ==
+
== Plugins ==
  
The advanced signal processing tools belong belong to three plugins:
+
The advanced signal processing tools belong to plugins
 
* '''geopsyhv'''
 
* '''geopsyhv'''
 
** H/V spectral ratio
 
** H/V spectral ratio
Line 48: Line 48:
  
  
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
 
  
  

Revision as of 13:27, 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

Plugins

The advanced signal processing tools belong to plugins

  • geopsyhv
    • H/V spectral ratio
    • H/V rotate
    • Spectrum
    • Spectrum rotate
  • geopsyarray
    • 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
  • structureratio
    • Structure spectrum

Each individual is identified by one SLOT number.

The following command line, using TOOL to specify plugin and SLOT to specify the signal processing tool, can be used to run

-tool <TOOL>               // Use plugin with tag TOOL

TOOL refers to one plugin, namely geopshy,



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