Improve observer peculiar velocity (#96)

* Fix peculiar velocity cacl

* Move files

* Remove import

csiborgtools/field/__init__.py

@@ -12,14 +12,8 @@
 # You should have received a copy of the GNU General Public License along
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-from warnings import warn
+from .density import (DensityField, PotentialField, TidalTensorField,       # noqa
-
+                      VelocityField, power_spectrum)                        # noqa
-try:
+from .interp import (evaluate_cartesian, evaluate_sky, field2rsp,           # noqa
-    import MAS_library as MASL                                                  # noqa
+                     fill_outside, make_sky, observer_peculiar_velocity)                 # noqa
-    from .density import (DensityField, PotentialField, TidalTensorField,       # noqa
+from .utils import nside2radec, smoothen_field                              # noqa
-                          VelocityField, power_spectrum)                        # noqa
-    from .interp import (evaluate_cartesian, evaluate_sky, field2rsp,           # noqa
-                         fill_outside, make_sky, observer_vobs)                 # noqa
-    from .utils import nside2radec, smoothen_field                              # noqa
-except ImportError:
-    warn("MAS_library not found, `DensityField` and related Pylians-based routines will not be available")  # noqa

csiborgtools/field/interp.py

@@ -24,6 +24,11 @@ from .utils import force_single_precision, smoothen_field
 from ..utils import periodic_wrap_grid, radec_to_cartesian
 
 
+###############################################################################
+#                       Cartesian interpolation                               #
+###############################################################################
+
+
 def evaluate_cartesian(*fields, pos, smooth_scales=None, verbose=False):
     """
     Evaluate a scalar field(s) at Cartesian coordinates `pos`.
@@ -76,6 +81,51 @@ def evaluate_cartesian(*fields, pos, smooth_scales=None, verbose=False):
     return interp_fields
 
 
+def observer_peculiar_velocity(velocity_field, smooth_scales=None,
+                               observer=None, verbose=True):
+    """
+    Calculate the peculiar velocity in the centre of the box.
+
+    Parameters
+    ----------
+    velocity_field : 4-dimensional array of shape `(3, grid, grid, grid)`
+        Velocity field in `km / s`.
+    smooth_scales : (list of) float, optional
+        Smoothing scales in box units. If `None`, no smoothing is performed.
+    observer : 1-dimensional array of shape `(3,)`, optional
+        Observer position in box units. If `None`, the observer is assumed to
+        be in the centre of the box.
+    verbose : bool, optional
+        Smoothing verbosity flag.
+
+    Returns
+    -------
+    vpec : 1-dimensional array of shape `(3,)` or `(len(smooth_scales), 3)`
+    """
+    if observer is None:
+        pos = numpy.asanyarray([0.5, 0.5, 0.5]).reshape(1, 3)
+    else:
+        pos = numpy.asanyarray(observer).reshape(1, 3)
+
+    vx, vy, vz = evaluate_cartesian(
+        *velocity_field, pos=pos, smooth_scales=smooth_scales, verbose=verbose)
+
+    # Reshape since we evaluated only one point
+    vx = vx.reshape(-1, )
+    vy = vy.reshape(-1, )
+    vz = vz.reshape(-1, )
+
+    if smooth_scales is None:
+        return numpy.array([vx[0], vy[0], vz[0]])
+
+    return numpy.vstack([vx, vy, vz]).T
+
+
+###############################################################################
+#                              Sky maps                                       #
+###############################################################################
+
+
 def evaluate_sky(*fields, pos, mpc2box, smooth_scales=None, verbose=False):
     """
     Evaluate a scalar field(s) at radial distance `Mpc / h`, right ascensions
@@ -119,26 +169,6 @@ def evaluate_sky(*fields, pos, mpc2box, smooth_scales=None, verbose=False):
                               smooth_scales=smooth_scales, verbose=verbose)
 
 
-def observer_vobs(velocity_field):
-    """
-    Calculate the observer velocity from a velocity field. Assumes an observer
-    in the centre of the box.
-
-    Parameters
-    ----------
-    velocity_field : 4-dimensional array of shape `(3, grid, grid, grid)`
-
-    Returns
-    -------
-    1-dimensional array of shape `(3,)`
-    """
-    pos = numpy.asanyarray([0.5, 0.5, 0.5]).reshape(1, 3)
-    vobs = numpy.full(3, numpy.nan, dtype=numpy.float32)
-    for i in range(3):
-        vobs[i] = evaluate_cartesian(velocity_field[i, ...], pos=pos)[0]
-    return vobs
-
-
 def make_sky(field, angpos, dist, boxsize, volume_weight=True, verbose=True):
     r"""
     Make a sky map of a scalar field. The observer is in the centre of the
@@ -190,19 +220,9 @@ def make_sky(field, angpos, dist, boxsize, volume_weight=True, verbose=True):
     return out
 
 
-@jit(nopython=True)
+###############################################################################
-def divide_nonzero(field0, field1):
+#                     Real-to-redshift space field dragging                   #
-    """
+###############################################################################
-    Perform in-place `field0 /= field1` but only where `field1 != 0`.
-    """
-    assert field0.shape == field1.shape, "Field shapes must match."
-
-    imax, jmax, kmax = field0.shape
-    for i in range(imax):
-        for j in range(jmax):
-            for k in range(kmax):
-                if field1[i, j, k] != 0:
-                    field0[i, j, k] /= field1[i, j, k]
 
 
 @jit(nopython=True)
@@ -277,6 +297,25 @@ def field2rsp(field, radvel_field, box, MAS, init_value=0.):
 
     return rsp_field
 
+###############################################################################
+#                          Supplementary function                             #
+###############################################################################
+
+
+@jit(nopython=True)
+def divide_nonzero(field0, field1):
+    """
+    Perform in-place `field0 /= field1` but only where `field1 != 0`.
+    """
+    assert field0.shape == field1.shape, "Field shapes must match."
+
+    imax, jmax, kmax = field0.shape
+    for i in range(imax):
+        for j in range(jmax):
+            for k in range(kmax):
+                if field1[i, j, k] != 0:
+                    field0[i, j, k] /= field1[i, j, k]
+
 
 @jit(nopython=True)
 def fill_outside(field, fill_value, rmax, boxsize):

scripts/field_sample.py

@@ -29,6 +29,7 @@ from tqdm import tqdm
 import csiborgtools
 from utils import get_nsims
 
+# TODO get rid of this.
 MPC2BOX = 1 / 677.7