Dinver: dinverext - Revision history

Marc: /* Target panel */

2015-05-11T12:18:37Z

Target panel

Marc: /* Definition of conditions */

2010-09-07T01:19:04Z

Definition of conditions

Marc at 13:14, 12 March 2010

2010-03-12T13:14:47Z

Clotaire Michel: New page: '''dinverext''' is an external plugin for dinver. It implements forward computations for any Inverse problem using an external software that can be launch...

2010-03-11T16:16:08Z

New page: '''dinverext''' is an external plugin for dinver. It implements forward computations for any Inverse problem using an external software that can be launch...

New page

'''dinverext''' is an external plugin for [[dinver]]. It implements forward computations for any [[Wikipedia:Inverse problem|Inverse problem]] using an external software that can be launched in command line.

== Invoking ''dinverext'' ==

[[Image:Dinverext_plugin_selection.png|thumb|right|200px|Plugin selection at '''dinver''' startup]]
Upon [[dinver]] startup, select the '''External forward computation''' module by checking the corresponding check box.
See [[Dinver plugins]] for more details, especially if '''External forward computation''' module does not appear by default.

The module selection can be set also directly in the command line invoking [[dinver]]:

dinver -i dinverext

The use of this plugin is mostly common to [[Dinver#Generic Dinver interface|Generic Dinver interface]] except the [[#Target panel|Target]] and [[#Parameters panel|Parameters]] panels.

== Target panel ==

[[Image:Dinverext_target_panel.png|thumb|left|300px|Target panel]]

If this panel does not appear, you can show it with menu [[Dinver:Menus:Tools|Tools]]. It lets you select the information about your forward code. The different text boxes are:

*''Working directory'' is the path to the external scripts the user wrote for the forward computation. Clicking on the button opens a pop-up menu to interactively select this path.
*''External command'' is the command line invoking the script of the user that computes the forward model and the misfit between the forward model and the data. Among its input, it should receive the ''DinverModel'' variable, a vector of real values containing the model parameters as defined in the [[#Parameters panel|''Parameters panel'']]. It has to output the variable ''DinverMisfit'', containing the misfit value (real number).

== Parameters panel ==

[[Image:Dinvermat_parameter_panel.png|thumb|center|800px|Parameter panel]]

If this panel does not appear, you can show it with menu [[Dinver:Menus:Tools|Tools]].

It defines the parameters of the forward model. The order of definition sets the order in the ''DinverModel'' vector.

===Definition of a parameter===
A parameter is defined writing the following command in the ''Parameters panel'':
parameter("WritingTime","s",10,3600,"linear",1)

All the parameters should be provided. The two first variables are strings setting the name of the parameter and its unit. The variable name is used to set the conditions, for display purposes but not in the scripting. The vector containing the parameters is ''DinverModel'' (see [[#Target panel|above]]). The two next variables are the minimum and maximum values that can take the parameter. The fifth parameter is the scale of the parameter grid, either ''"linear"'' or ''"log"''. The last variable is the precision of the parameter grid. In ''"linear"'' scale, the precision is absolute, in ''"log"'' scale, the precision is relative. ''0'' is the default parameter producing 500 bins in the parameter grid. In the example, the parameter ''"WritingTime"'' can vary between 10 and 3600 seconds on a linear scale with a precision of 1 second.

===Definition of conditions===
Conditions between parameters can be set using the following functions in the ''Parameters panel'', after the definition of the parameters:
*''linear'' is used to define a linear condition, as for example:
linear("WritingTime","<",1.5,"SleepingTime",0);
This means: <math>WritingTime<1.5*SleepingTime+0</math>. The first variable is the left hand-side parameter name, the second variable is the inequality sign ''"<"'' or ''">"'', the third variable is the constant to multiply to the right hand-side parameter, then the right hand-side parameter and finally the constant to add to the right-hand side.
*Any other condition type could be implemented on request to [mailto:bug@geopsy.org bug@geopsy.org]

@@ Line 20: / Line 20: @@
 *''Working directory'' is the path to the external scripts the user wrote for the forward computation. Clicking on the button opens a pop-up menu to interactively select this path.
-*''External command'' is the command line invoking the script of the user that computes the forward model and the misfit between the forward model and the data. Among its input, it should receive the ''DinverModel'' variable, a vector of real values containing the model parameters as defined in the [[#Parameters panel|''Parameters panel'']]. It has to output the variable ''DinverMisfit'', containing the misfit value (real number).
+*''External command'' is the command line invoking the script that computes the misfit between the forward model and the data. Before running the user script ''dinver'' creates file ''parameters'' (one line per parameter). The type and the number of parameters is defined in the [[#Parameters panel|''Parameters panel'']]. The user script must create a file ''misfit'' which contains a single value, the misfit corresponding to the provided set of of parameters
 == Parameters panel ==

@@ Line 41: / Line 41: @@
   linear("WritingTime","<",1.5,"SleepingTime",0);
 This means: <math>WritingTime<1.5*SleepingTime+0</math>. The first variable is the left hand-side parameter name, the second variable is the inequality sign ''"<"'' or ''">"'', the third variable is the constant to multiply to the right hand-side parameter, then the right hand-side parameter and finally the constant to add to the right-hand side.
-*Any other condition type could be implemented on request to [mailto:bug@geopsy.org bug@geopsy.org]
+*Any other condition type could be implemented on request to [http://www.geopsy.org/forum Geopsy Forum].

@@ Line 17: / Line 17: @@
 [[Image:Dinverext_target_panel.png|thumb|left|300px|Target panel]]
-If this panel does not appear, you can show it with menu [[Dinver:Menus:Tools|Tools]]. It lets you select the information about your forward code. The different text boxes are:
+If this panel does not appear, you can show it with [[Dinver: Tools menu|Tools menu]]. It lets you select the information about your forward code. The different text boxes are:
 *''Working directory'' is the path to the external scripts the user wrote for the forward computation. Clicking on the button opens a pop-up menu to interactively select this path.