Merge pull request #6 from martinkilbinger/cfis

cfis module added

Author: martinkilbinger

cs_util/cat.py

@@ -4,7 +4,7 @@
 
 :Description: This script contains methods to read and write galaxy catalogues.
 
-:Author: Martin Kilbinger
+:Author: Martin Kilbinger <martin.kilbinger@cea.fr>
 
 """
 

cs_util/cfis.py

@@ -0,0 +1,112 @@
+"""CFIS.
+
+:Name: cfis.py
+
+:Description: This script contains CFIS-specific methods.
+
+:Author: Martin Kilbinger <martin.kilbinger@cea.fr>
+
+"""
+
+
+import re
+import numpy as np
+from astropy import units
+from astropy import coordinates as coords
+
+
+class Cfis(object):
+    """Cfis
+
+    Class for CFIS image properties.
+
+    """
+    size = {'tile' : 0.5 * units.deg}
+
+
+def get_tile_number(tile_name):
+    """Get Tile Number.
+
+    Return tile number of given image tile name.
+
+    Parameters
+    ----------
+    tile_name : str
+        tile name
+
+    Raises
+    ------
+    ValueError
+        if tile name does not match expected pipeline numbering scheme
+
+    Returns
+    -------
+    tuple
+        tile number for x and tile number for y
+
+    """
+    m = re.search(r'(\d{3})[\.-](\d{3})', tile_name)
+    if m is None or len(m.groups()) != 2:
+        raise ValueError(
+            f'Image name \'{tile_name}\' does not match tile name syntax'
+        )
+
+    nix = m.groups()[0]
+    niy = m.groups()[1]
+
+    return nix, niy
+
+
+def get_tile_coord_from_nixy(nix, niy):
+    """Get Tile Coord From Nixy.
+
+    Return coordinates corresponding to tile with number (nix,niy).
+
+    Parameters
+    ----------
+    nix : str or list
+        tile number(s) for x coordinate(s);
+    niy : str or list
+        tile number(s) for y coordinate(s)
+
+    See also
+    --------
+    get_tile_number_from_coord
+
+    Returns
+    -------
+    tuple
+        right ascension and declination
+
+    """
+    number_pattern = re.compile(r'\d{3}')
+
+    # Transform from str to int
+    if not np.isscalar(nix):
+        # Check input numbers
+        if not all(
+            [bool(number_pattern.fullmatch(number)) for number in nix + niy]
+        ):
+            raise ValueError('Input needs to be three-digit numbers')
+
+        # Transform to list
+        xi = np.array(nix).astype(int)
+        yi = np.array(niy).astype(int)
+    else:
+        if not all(
+            [bool(number_pattern.fullmatch(number)) for number in [nix, niy]]
+        ):
+            raise ValueError('Input needs to be three-digit numbers')
+
+        xi = int(nix)
+        yi = int(niy)
+
+    # Declination
+    d = yi / 2 - 90
+    dec = coords.Angle(d, unit='deg')
+
+    # Right ascension
+    r = xi / 2 / np.cos(dec.radian)
+    ra = coords.Angle(r, unit='deg')
+
+    return ra, dec

cs_util/tests/test_cfis.py

@@ -0,0 +1,132 @@
+"""UNIT TESTS FOR CFIS SUBPACKAGE.
+
+This module contains unit tests for the cfis subpackage.
+
+"""
+
+import os
+
+import numpy as np
+from numpy import testing as npt
+from astropy import units
+
+from unittest import TestCase
+
+from cs_util import cfis
+
+
+class CfisTestCase(TestCase):
+    """Test case for the ``cfis`` module."""
+
+    def setUp(self):
+        """Set test parameter values."""
+
+        self._size_tile = 0.5 * units.deg
+
+        self._tile_number_ok = ['270.283', '188-308']
+        self._nix = ['270', '188']
+        self._niy = ['283', '308']
+        self._dec = [51.5, 64]
+        self._ra = [216.86237, 214.43017]
+        self._unit = units.deg
+
+        self._nix_nok = ['23x', '1234']
+        self._tile_number_nok = '12x.456'
+
+    def tearDown(self):
+        """Unset test parameter values."""
+        self._tile_number_ok = None
+        self._nix = None
+        self._niy = None
+        self._dec = None
+        self._ra = None
+        self._unit = None
+        self._tile_number_nok = None
+
+    def test_Cfis(self):
+        """Test ``cs_util.Cfis`` class."""
+        self.assertTrue(self._size_tile == cfis.Cfis().size['tile'])
+
+    def test_get_tile_number(self):
+        """Test ``cs_util.get_tile_number`` method."""
+
+        # Test return values for valid input tile numbers
+        for idx, tile_number_ok in enumerate(self._tile_number_ok):
+            nix, niy = cfis.get_tile_number(tile_number_ok)
+            self.assertTrue(
+                (nix == self._nix[idx]) and (niy == self._niy[idx]),
+                msg=f'{nix}!={self._nix[idx]} or {niy}!={self._niy[idx]}',
+            )
+
+        self.assertRaises(
+            ValueError,
+            cfis.get_tile_number,
+            self._tile_number_nok
+        )
+
+    def test_get_tile_coord_from_nixy(self):
+        """Test ``cs_util.get_tile_coord_from_nixy`` method."""
+
+        # Call with scalar arguments
+        for idx in range(len(self._nix)):
+            ra, dec = cfis.get_tile_coord_from_nixy(
+                self._nix[idx],
+                self._niy[idx],
+            )
+
+            # Test values
+            npt.assert_almost_equal(
+                ra.value,
+                self._ra[idx],
+                err_msg=f'{ra}!={self._ra[idx]}',
+                decimal=5,
+            )
+            npt.assert_almost_equal(
+                dec.value,
+                self._dec[idx],
+                err_msg=f'{dec}!={self._dec[idx]}',
+            )
+
+            # Test units
+            self.assertTrue(ra.unit == self._unit)
+            self.assertTrue(dec.unit == self._unit)
+
+        # Call with list arguments
+        ra, dec = cfis.get_tile_coord_from_nixy(self._nix, self._niy)
+        for idx in range(len(self._nix)):
+
+            # Test values
+            npt.assert_almost_equal(
+                ra[idx].value,
+                self._ra[idx],
+                err_msg=f'{ra[idx]}!={self._ra[idx]}',
+                decimal=5,
+            )
+            npt.assert_almost_equal(
+                dec[idx].value,
+                self._dec[idx],
+                err_msg=f'{dec[idx]}!={self._dec[idx]}',
+            )
+            # Test units
+            self.assertTrue(ra[idx].unit == self._unit)
+            self.assertTrue(dec[idx].unit == self._unit)
+
+        # Test exception for invalid input
+        self.assertRaises(
+            ValueError,
+            cfis.get_tile_coord_from_nixy,
+            self._nix_nok,
+            self._niy,
+        )
+        self.assertRaises(
+            ValueError,
+            cfis.get_tile_coord_from_nixy,
+            self._niy,
+            self._nix_nok,
+        )
+        self.assertRaises(
+            ValueError,
+            cfis.get_tile_coord_from_nixy,
+            self._nix_nok[0],
+            self._niy[0],
+        )

requirements.txt

@@ -1,6 +1,5 @@
 astropy
 datetime
-jinja2==3.0
 numpy
 matplotlib
 vos