 # Diff of /branches/doubleplusgood/doc/inversion/Drivers.tex

revision 4344 by jfenwick, Wed Feb 27 03:42:40 2013 UTC revision 4345 by jfenwick, Fri Mar 29 07:09:41 2013 UTC
# Line 31  If the maximum number is reached, the it Line 31  If the maximum number is reached, the it
31  \end{methoddesc}  \end{methoddesc}
32
33  \begin{methoddesc}[InversionDriver]{setSolverTolerance}{\optional{m_tol=\None} \optional{, J_tol=\None}}  \begin{methoddesc}[InversionDriver]{setSolverTolerance}{\optional{m_tol=\None} \optional{, J_tol=\None}}
34  set the tolerance for the the solver used to minimize the cost function. If \member{m_tol} is set the iteration is terminated  set the tolerance for the solver used to minimize the cost function. If \member{m_tol} is set the iteration is terminated
35  if the relative change of the level set function is less than or equal \member{m_tol}, see condition~\ref{EQU:MIN:3a}.  if the relative change of the level set function is less than or equal \member{m_tol}, see condition~\ref{EQU:MIN:3a}.
36  If \member{J_tol} is set the iteration is terminated if the change of the cost  If \member{J_tol} is set the iteration is terminated if the change of the cost
37  function relative to the initial value is less than or equal \member{J_tol}, , see condition~\ref{EQU:MIN:3b}.  function relative to the initial value is less than or equal \member{J_tol}, , see condition~\ref{EQU:MIN:3b}.
# Line 57  incurable break down in the iteration in Line 57  incurable break down in the iteration in
57  \subsection{Gravity Inversion Driver}  \subsection{Gravity Inversion Driver}
58  For examples of usage please see Chapter~\ref{Chp:cook:gravity inversion}.  For examples of usage please see Chapter~\ref{Chp:cook:gravity inversion}.
59
60  \begin{classdesc}{GravityInversion}{\optional{solverclass=None}}  \begin{classdesc}{GravityInversion}{\optional{solverclass=None}
61    \optional{, fixGravityPotentialAtBottom=False}
62    }
63  Driver class to perform an inversion of Gravity (Bouguer) anomaly data.  Driver class to perform an inversion of Gravity (Bouguer) anomaly data.
64  This class is a sub-class of \class{InversionDriver}. The class uses the  This class is a sub-class of \class{InversionDriver}. The class uses the
65  standard \class{Regularization} for a single level set function,  standard \class{Regularization} for a single level set function,
# Line 67  see Section~\ref{Chp:ref:mapping density Line 69  see Section~\ref{Chp:ref:mapping density
69  \member{solverclass} set the solver class to be used for inversion,  \member{solverclass} set the solver class to be used for inversion,
70  see Chapter~\ref{chapter:ref:Minimization}.  see Chapter~\ref{chapter:ref:Minimization}.
71   By default the limited-memory Broyden-Fletcher-Goldfarb-Shanno (\emph{L-BFGS})~\cite{Nocedal1980}\index{L-BFGS} solver is used.   By default the limited-memory Broyden-Fletcher-Goldfarb-Shanno (\emph{L-BFGS})~\cite{Nocedal1980}\index{L-BFGS} solver is used.
72    If \member{fixGravityPotentialAtBottom} is set \optional{, fixGravityPotentialAtBottom=False}to \True the gravity potential at the bottom is set to zero.
73  \end{classdesc}  \end{classdesc}
74
75    \begin{methoddesc}[GravityInversion]{fixGravityPotentialAtBottom}{\optional{status=\True}}
76    If \member{status} is \True the gravity potential at the bottom is set to zero. Otherwise  the gravity
77     potential at the top is set to zero only.
78    \end{methoddesc}
79
80  \begin{methoddesc}[GravityInversion]{setup}{  \begin{methoddesc}[GravityInversion]{setup}{
81  domainbuilder  domainbuilder
82  \optional{, rho0=\None}  \optional{, rho0=\None}
# Line 77  domainbuilder Line 84  domainbuilder
84  \optional{, z0=\None}  \optional{, z0=\None}
85  \optional{, beta=\None}  \optional{, beta=\None}
86  \optional{, w0=\None}  \optional{, w0=\None}
87  \optional{, w1=\None}}  \optional{, w1=\None}
88    \optional{, rho_at_depth=\None}
89    }
90
91  sets up the inversion from an instance \member{domainbuilder} of a \class{DomainBuilder}, see Section~\ref{Chp:ref:domain builder}.  sets up the inversion from an instance \member{domainbuilder} of a \class{DomainBuilder}, see Section~\ref{Chp:ref:domain builder}.
92  Only gravitational data attached to the \member{domainbuilder} are considered in the inversion.  Only gravitational data attached to the \member{domainbuilder} are considered in the inversion.
93  \member{rho0} defines a reference density anomaly (default is 0),  \member{rho0} defines a reference density anomaly (default is 0),
# Line 89  see \class{DensityMapping} in Section~\r Line 99  see \class{DensityMapping} in Section~\r
99  $\omega^{(0)}$ and  $\omega^{(0)}$ and
100  $\omega^{(1)}$, respectively (see Equation~\ref{EQU:REG:1}).  $\omega^{(1)}$, respectively (see Equation~\ref{EQU:REG:1}).
101  By default \member{w0}=\None and \member{w1}=1 are used.  By default \member{w0}=\None and \member{w1}=1 are used.
102    \member{rho_at_depth} sets the value for density at depth. This is only used if density is fixed below a certain depth,
103    see \class{Domain Builder} in Section~\ref{Chp:ref:domain builder}.
104  \end{methoddesc}  \end{methoddesc}
105
106  \begin{methoddesc}[GravityInversion]{setInitialGuess}{\optional{rho=\None}}  \begin{methoddesc}[GravityInversion]{setInitialGuess}{\optional{rho=\None}}
# Line 98  sets an initial guess for the density an Line 110  sets an initial guess for the density an
110  \subsection{Magnetic Inversion Driver}  \subsection{Magnetic Inversion Driver}
111  For examples of usage please see Chapter~\ref{Chp:cook:magnetic inversion}.  For examples of usage please see Chapter~\ref{Chp:cook:magnetic inversion}.
112
113  \begin{classdesc}{MagneticInversion}{\optional{solverclass=None}}  \begin{classdesc}{MagneticInversion}{\optional{solverclass=None}
114    }
115  Driver class to perform an inversion of magnetic anomaly data. This class  Driver class to perform an inversion of magnetic anomaly data. This class
116  is a sub-class of \class{InversionDriver}. The class uses the standard  is a sub-class of \class{InversionDriver}. The class uses the standard
117  \class{Regularization} class for a single level set function, see Chapter~\ref{Chp:ref:regularization},  \class{Regularization} class for a single level set function, see Chapter~\ref{Chp:ref:regularization},
# Line 107  magnetic forward model \class{MagneticMo Line 120  magnetic forward model \class{MagneticMo
120  \member{solverclass} set the solver class to be used for inversion,  \member{solverclass} set the solver class to be used for inversion,
121  see Chapter~\ref{chapter:ref:Minimization}.  see Chapter~\ref{chapter:ref:Minimization}.
122   By default the limited-memory Broyden-Fletcher-Goldfarb-Shanno (\emph{L-BFGS})~\cite{Nocedal1980}\index{L-BFGS} solver is used.   By default the limited-memory Broyden-Fletcher-Goldfarb-Shanno (\emph{L-BFGS})~\cite{Nocedal1980}\index{L-BFGS} solver is used.
123
124  \end{classdesc}  \end{classdesc}
125
126    \begin{methoddesc}[MagneticInversion]{fixMagneticPotentialAtBottom}{\optional{status=\True}}
127    If \member{status} is \True the magnetic potential at the bottom is set to zero. Otherwise  the magnetic
128     potential at the top is set to zero only.
129    \end{methoddesc}
130
131
132
133  \begin{methoddesc}[MagneticInversion]{setup}{  \begin{methoddesc}[MagneticInversion]{setup}{
134  domainbuilder  domainbuilder
# Line 117  domainbuilder Line 137  domainbuilder
137  \optional{, z0=\None}  \optional{, z0=\None}
138  \optional{, beta=\None}  \optional{, beta=\None}
139  \optional{, w0=\None}  \optional{, w0=\None}
140  \optional{, w1=\None}}  \optional{, w1=\None}
141    \optional{, k_at_depth=\None}
142    }
143
144  sets up the inversion from an instance \member{domainbuilder} of a \class{DomainBuilder}, see Section~\ref{Chp:ref:domain builder}.  sets up the inversion from an instance \member{domainbuilder} of a \class{DomainBuilder}, see Section~\ref{Chp:ref:domain builder}.
145  Only magnetic data attached to the \member{domainbuilder} are considered in the inversion.  Only magnetic data attached to the \member{domainbuilder} are considered in the inversion.
# Line 130  see \class{SusceptibilityMapping} in Sec Line 152  see \class{SusceptibilityMapping} in Sec
152  $\omega^{(0)}$ and  $\omega^{(0)}$ and
153  $\omega^{(1)}$, respectively (see equation~\ref{EQU:REG:1}).  $\omega^{(1)}$, respectively (see equation~\ref{EQU:REG:1}).
154  By default \member{w0}=\None and \member{w1}=1 are used.  By default \member{w0}=\None and \member{w1}=1 are used.
155    \member{k_at_depth} sets the value for susceptibility at depth. This is only used if susceptibility is fixed below a certain depth,
156    see \class{Domain Builder} in Section~\ref{Chp:ref:domain builder}.
157  \end{methoddesc}  \end{methoddesc}
158
159  \begin{methoddesc}[MagneticInversion]{setInitialGuess}{\optional{k=\None}}  \begin{methoddesc}[MagneticInversion]{setInitialGuess}{\optional{k=\None}}
# Line 139  sets an initial guess for the susceptibi Line 163  sets an initial guess for the susceptibi
163  \subsection{Gravity and Magnetic Joint Inversion Driver}  \subsection{Gravity and Magnetic Joint Inversion Driver}
164  For examples of usage please see Chapter~\ref{Chp:cook:joint inversion}.  For examples of usage please see Chapter~\ref{Chp:cook:joint inversion}.
165
166  \begin{classdesc}{JointGravityMagneticInversion}{\optional{solverclass=None}}  \begin{classdesc}{JointGravityMagneticInversion}{\optional{solverclass=None}
167    }
168  Driver class to perform a joint inversion of Gravity (Bouguer) and magnetic anomaly data.  Driver class to perform a joint inversion of Gravity (Bouguer) and magnetic anomaly data.
169  This class is a sub-class of \class{InversionDriver}.  This class is a sub-class of \class{InversionDriver}.
170  The class uses the standard \class{Regularization} for two level set functions  The class uses the standard \class{Regularization} for two level set functions
# Line 153  see Chapter~\ref{chapter:ref:Minimizatio Line 178  see Chapter~\ref{chapter:ref:Minimizatio
178   By default the limited-memory Broyden-Fletcher-Goldfarb-Shanno (\emph{L-BFGS})~\cite{Nocedal1980}\index{L-BFGS} solver is used.   By default the limited-memory Broyden-Fletcher-Goldfarb-Shanno (\emph{L-BFGS})~\cite{Nocedal1980}\index{L-BFGS} solver is used.
179  \end{classdesc}  \end{classdesc}
180
181    \begin{methoddesc}[JointGravityMagneticInversion]{fixGravityPotentialAtBottom}{\optional{status=\True}}
182    If \member{status} is \True the gravity potential at the bottom is set to zero. Otherwise  the gravity
183     potential at the top is set to zero only.
184    \end{methoddesc}
185
186
187    \begin{methoddesc}[JointGravityMagneticInversion]{fixMagneticPotentialAtBottom}{\optional{status=\True}}
188    If \member{status} is \True the magnetic potential at the bottom is set to zero. Otherwise  the magnetic
189     potential at the top is set to zero only.
190    \end{methoddesc}
191
192  \begin{methoddesc}[JointGravityMagneticInversion]{setup}{  \begin{methoddesc}[JointGravityMagneticInversion]{setup}{
193  domainbuilder  domainbuilder
# Line 167  domainbuilder Line 202  domainbuilder
202  \optional{, w0=\None}  \optional{, w0=\None}
203  \optional{, w1=\None}  \optional{, w1=\None}
204  \optional{, w_gc=\None}  \optional{, w_gc=\None}
205    \optional{, rho_at_depth=\None}
206    \optional{, k_at_depth=\None}
207  }  }
208
209  sets up the inversion from an instance \member{domainbuilder} of a \class{DomainBuilder}, see Section~\ref{Chp:ref:domain builder}.  sets up the inversion from an instance \member{domainbuilder} of a \class{DomainBuilder}, see Section~\ref{Chp:ref:domain builder}.
210  Gravity and magnetic data attached to the \member{domainbuilder} are considered in the inversion.  Gravity and magnetic data attached to the \member{domainbuilder} are considered in the inversion.
211  \member{rho0} defines a reference density anomaly (default is $0$),  \member{rho0} defines a reference density anomaly (default is $0$),
# Line 185  $\omega^{(0)}$ and Line 223  $\omega^{(0)}$ and
223  $\omega^{(1)}$, respectively (see Equation~\ref{EQU:REG:1}).  $\omega^{(1)}$, respectively (see Equation~\ref{EQU:REG:1}).
224  \member{w_gc} sets the weighting factor $\omega^{(c)}$ for the cross gradient term.  \member{w_gc} sets the weighting factor $\omega^{(c)}$ for the cross gradient term.
225  By default \member{w0}=\None, \member{w1}=1 and \member{w_gc}=1 are used.  By default \member{w0}=\None, \member{w1}=1 and \member{w_gc}=1 are used.
226    \member{k_at_depth} sets the value for susceptibility at depth. This is only used if susceptibility is fixed below a certain depth,
227    see \class{Domain Builder} in Section~\ref{Chp:ref:domain builder}.
228    \member{rho_at_depth} sets the value for density at depth. This is only used if density is fixed below a certain depth,
229    see \class{Domain Builder} in Section~\ref{Chp:ref:domain builder}.
230  \end{methoddesc}  \end{methoddesc}
231
232  \begin{methoddesc}[JointGravityMagneticInversion]{setInitialGuess}{\optional{rho=\None, } \optional{k=\None}}  \begin{methoddesc}[JointGravityMagneticInversion]{setInitialGuess}{\optional{rho=\None, } \optional{k=\None}}

Legend:
 Removed from v.4344 changed lines Added in v.4345