Naming conventions in Maps (re #231)

- FullMap --> SurjectFull
- Vertical1DMap --> SurjectVertical1D
- Map2Dto3D --> Surject2Dto3D
- ActiveCells --> InjectActiveCells
- ActiveCellsTopo --> InjectActiveCellsTopo

SimPEG/Examples/EM_FDEM_1D_Inversion.py

@@ -21,8 +21,8 @@ def run(plotIt=True):
 
     active = mesh.vectorCCz<0.
     layer = (mesh.vectorCCz<0.) & (mesh.vectorCCz>=layerz)
-    actMap = Maps.ActiveCells(mesh, active, np.log(1e-8), nC=mesh.nCz)
-    mapping = Maps.ExpMap(mesh) * Maps.Vertical1DMap(mesh) * actMap
+    actMap = Maps.InjectActiveCells(mesh, active, np.log(1e-8), nC=mesh.nCz)
+    mapping = Maps.ExpMap(mesh) * Maps.SurjectVertical1D(mesh) * actMap
     sig_half = 2e-2
     sig_air = 1e-8
     sig_layer = 1e-2

SimPEG/Examples/EM_TDEM_1D_Inversion.py

@@ -19,8 +19,8 @@ def run(plotIt=True):
 
     active = mesh.vectorCCz<0.
     layer = (mesh.vectorCCz<0.) & (mesh.vectorCCz>=-100.)
-    actMap = Maps.ActiveCells(mesh, active, np.log(1e-8), nC=mesh.nCz)
-    mapping = Maps.ExpMap(mesh) * Maps.Vertical1DMap(mesh) * actMap
+    actMap = Maps.InjectActiveCells(mesh, active, np.log(1e-8), nC=mesh.nCz)
+    mapping = Maps.ExpMap(mesh) * Maps.SurjectVertical1D(mesh) * actMap
     sig_half = 2e-3
     sig_air = 1e-8
     sig_layer = 1e-3

SimPEG/Maps.py

@@ -296,11 +296,11 @@ class LogMap(IdentityMap):
     def inverse(self, m):
         return np.exp(Utils.mkvc(m))
 
-class FullMap(IdentityMap):
+class SurjectFull(IdentityMap):
     """
-    FullMap
+    SurjectFull
 
-    Given a scalar, the FullMap maps the value to the
+    Given a scalar, the SurjectFull maps the value to the
     full model space.
     """
 
@@ -328,8 +328,8 @@ class FullMap(IdentityMap):
         return np.ones([self.mesh.nC,1])
 
 
-class Vertical1DMap(IdentityMap):
-    """Vertical1DMap
+class SurjectVertical1D(IdentityMap):
+    """SurjectVertical1DMap
 
         Given a 1D vector through the last dimension
         of the mesh, this will extend to the full
@@ -370,7 +370,7 @@ class Vertical1DMap(IdentityMap):
         return sp.kron(sp.identity(self.nP), repVec)
 
 
-class Map2Dto3D(IdentityMap):
+class Surject2Dto3D(IdentityMap):
     """Map2Dto3D
 
         Given a 2D vector, this will extend to the full
@@ -458,7 +458,7 @@ class Mesh2Mesh(IdentityMap):
         return self.P
 
 
-class ActiveCells(IdentityMap):
+class InjectActiveCells(IdentityMap):
     """
         Active model parameters.
 
@@ -506,7 +506,7 @@ class ActiveCells(IdentityMap):
     def deriv(self, m):
         return self.P
 
-class ActiveCellsTopo(IdentityMap):
+class InjectActiveCellsTopo(IdentityMap):
     """
         Active model parameters. Extend for cells on topography to air cell (only works for tensor mesh)
 

tests/base/test_maps.py

@@ -5,8 +5,8 @@ from scipy.sparse.linalg import dsolve
 
 TOL = 1e-14
 
-MAPS_TO_TEST_2D = ["CircleMap", "ComplexMap", "ExpMap", "IdentityMap", "Vertical1DMap", "Weighting", "FullMap"]
-MAPS_TO_TEST_3D = [             "ComplexMap", "ExpMap", "IdentityMap", "Vertical1DMap", "Weighting", "FullMap"]
+MAPS_TO_TEST_2D = ["CircleMap", "ComplexMap", "ExpMap", "IdentityMap", "SurjectVertical1D", "Weighting", "SurjectFull"]
+MAPS_TO_TEST_3D = [             "ComplexMap", "ExpMap", "IdentityMap", "SurjectVertical1D", "Weighting", "SurjectFull"]
 
 class MapTests(unittest.TestCase):
 
@@ -52,7 +52,7 @@ class MapTests(unittest.TestCase):
     def test_mapMultiplication(self):
         M = Mesh.TensorMesh([2,3])
         expMap = Maps.ExpMap(M)
-        vertMap = Maps.Vertical1DMap(M)
+        vertMap = Maps.SurjectVertical1D(M)
         combo = expMap*vertMap
         m = np.arange(3.0)
         t_true = np.exp(np.r_[0,0,1,1,2,2.])
@@ -83,8 +83,8 @@ class MapTests(unittest.TestCase):
     def test_activeCells(self):
         M = Mesh.TensorMesh([2,4],'0C')
         expMap = Maps.ExpMap(M)
-        actMap = Maps.ActiveCells(M, M.vectorCCy <=0, 10, nC=M.nCy)
-        vertMap = Maps.Vertical1DMap(M)
+        actMap = Maps.InjectActiveCells(M, M.vectorCCy <=0, 10, nC=M.nCy)
+        vertMap = Maps.SurjectVertical1D(M)
         combo = vertMap * actMap
         m = np.r_[1,2.]
         mod = Models.Model(m,combo)
@@ -97,8 +97,8 @@ class MapTests(unittest.TestCase):
     def test_tripleMultiply(self):
         M = Mesh.TensorMesh([2,4],'0C')
         expMap = Maps.ExpMap(M)
-        vertMap = Maps.Vertical1DMap(M)
-        actMap = Maps.ActiveCells(M, M.vectorCCy <=0, 10, nC=M.nCy)
+        vertMap = Maps.SurjectVertical1D(M)
+        actMap = Maps.InjectActiveCells(M, M.vectorCCy <=0, 10, nC=M.nCy)
         m = np.r_[1,2.]
         t_true = np.exp(np.r_[1,1,2,2,10,10,10,10.])
         self.assertLess(np.linalg.norm((expMap * vertMap * actMap * m)-t_true,np.inf),TOL)
@@ -115,7 +115,7 @@ class MapTests(unittest.TestCase):
         M2 = Mesh.TensorMesh([2,4])
         M3 = Mesh.TensorMesh([3,2,4])
         m = np.random.rand(M2.nC)
-        m2to3 = Maps.Map2Dto3D(M3, normal='X')
+        m2to3 = Maps.Surject2Dto3D(M3, normal='X')
         m = np.arange(m2to3.nP)
         self.assertTrue(m2to3.test())
         self.assertTrue(np.all(Utils.mkvc( (m2to3 * m).reshape(M3.vnC,order='F')[0,:,:] ) == m))
@@ -125,7 +125,7 @@ class MapTests(unittest.TestCase):
         M2 = Mesh.TensorMesh([3,4])
         M3 = Mesh.TensorMesh([3,2,4])
         m = np.random.rand(M2.nC)
-        m2to3 = Maps.Map2Dto3D(M3, normal='Y')
+        m2to3 = Maps.Surject2Dto3D(M3, normal='Y')
         m = np.arange(m2to3.nP)
         self.assertTrue(m2to3.test())
         self.assertTrue(np.all(Utils.mkvc( (m2to3 * m).reshape(M3.vnC,order='F')[:,0,:] ) == m))
@@ -134,7 +134,7 @@ class MapTests(unittest.TestCase):
         M2 = Mesh.TensorMesh([3,2])
         M3 = Mesh.TensorMesh([3,2,4])
         m = np.random.rand(M2.nC)
-        m2to3 = Maps.Map2Dto3D(M3, normal='Z')
+        m2to3 = Maps.Surject2Dto3D(M3, normal='Z')
         m = np.arange(m2to3.nP)
         self.assertTrue(m2to3.test())
         self.assertTrue(np.all(Utils.mkvc( (m2to3 * m).reshape(M3.vnC,order='F')[:,:,0] ) == m))