From 5f46461bfeab77a1477e6b589aaa38e036148aa4 Mon Sep 17 00:00:00 2001 From: Lindsey Heagy Date: Thu, 15 Jan 2015 13:35:44 -0800 Subject: [PATCH] added documentation for log mapping --- SimPEG/Maps.py | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/SimPEG/Maps.py b/SimPEG/Maps.py index ffe9f3f2..4ab1d855 100644 --- a/SimPEG/Maps.py +++ b/SimPEG/Maps.py @@ -160,7 +160,6 @@ class ComboMap(IdentityMap): class ExpMap(IdentityMap): """ - Changes the model into the physical property. A common example of this is to invert for electrical conductivity @@ -223,6 +222,25 @@ class ExpMap(IdentityMap): class LogMap(IdentityMap): + """ + Changes the model into the physical property. + + If \\(p\\) is the physical property and \\(m\\) is the model, then + + ..math:: + + p = \\log(m) + + and + + ..math:: + + m = \\exp(p) + + NOTE: If you have a model which is log conductivity (ie. \\(m = \\log(\\sigma)\\)), + you should be using an ExpMap + + """ def __init__(self, mesh, **kwargs): IdentityMap.__init__(self, mesh, **kwargs)