Interferometer simulator now live in auto array

Author: Jammy2211

autoarray/operators/fourier_transform.py

@@ -7,25 +7,25 @@
 class Transformer(object):
     def __init__(self, uv_wavelengths, grid_radians, preload_transform=True):
 
-        self.uv_wavelengths = uv_wavelengths
-        self.grid_radians = grid_radians
+        self.uv_wavelengths = uv_wavelengths.astype('float')
+        self.grid_radians = grid_radians.in_1d_binned
 
         self.total_visibilities = uv_wavelengths.shape[0]
-        self.total_image_pixels = grid_radians.shape[0]
+        self.total_image_pixels = grid_radians.shape_1d
 
         self.preload_transform = preload_transform
 
         if preload_transform:
 
             self.preload_real_transforms = self.preload_real_transforms(
-                grid_radians=grid_radians,
-                uv_wavelengths=uv_wavelengths,
+                grid_radians=self.grid_radians,
+                uv_wavelengths=self.uv_wavelengths,
                 total_image_pixels=self.total_image_pixels,
             )
 
             self.preload_imag_transforms = self.preload_imag_transforms(
-                grid_radians=grid_radians,
-                uv_wavelengths=uv_wavelengths,
+                grid_radians=self.grid_radians,
+                uv_wavelengths=self.uv_wavelengths,
                 total_image_pixels=self.total_image_pixels,
             )
 

autoarray/simulator/__init__.py

@@ -1 +1,2 @@
 from .simulator import ImagingSimulator as imaging
+from .simulator import InterferometerSimulator as interferometer

autoarray/simulator/dataset/sma_uv_wavelengths.fits

@@ -1,7 +1,9 @@
-import autoarray as aa
-
-from autoarray.dataset import imaging
+import os
 
+from autoarray.util import array_util
+from autoarray.structures import grids, kernel
+from autoarray.dataset import imaging, interferometer
+from autoarray.operators import fourier_transform
 
 class ImagingSimulator(object):
     def __init__(
@@ -66,7 +68,7 @@ def lsst(
         """Default settings for an observation with the Large Synotpic Survey Telescope.
 
         This can be customized by over-riding the default input values."""
-        psf = aa.kernel.from_gaussian(
+        psf = kernel.Kernel.from_gaussian(
             shape_2d=psf_shape_2d, sigma=psf_sigma, pixel_scales=pixel_scales
         )
         return ImagingSimulator(
@@ -98,7 +100,7 @@ def euclid(
         """Default settings for an observation with the Euclid space satellite.
 
         This can be customized by over-riding the default input values."""
-        psf = aa.kernel.from_gaussian(
+        psf = kernel.Kernel.from_gaussian(
             shape_2d=psf_shape_2d, sigma=psf_sigma, pixel_scales=pixel_scales
         )
         return ImagingSimulator(
@@ -130,7 +132,7 @@ def hst(
         """Default settings for an observation with the Hubble Space Telescope.
 
         This can be customized by over-riding the default input values."""
-        psf = aa.kernel.from_gaussian(
+        psf = kernel.Kernel.from_gaussian(
             shape_2d=psf_shape_2d, sigma=psf_sigma, pixel_scales=pixel_scales
         )
         return ImagingSimulator(
@@ -163,7 +165,7 @@ def hst_up_sampled(
         pixel-scale to better sample the PSF.
 
         This can be customized by over-riding the default input values."""
-        psf = aa.kernel.from_gaussian(
+        psf = kernel.Kernel.from_gaussian(
             shape_2d=psf_shape_2d, sigma=psf_sigma, pixel_scales=pixel_scales
         )
         return ImagingSimulator(
@@ -195,7 +197,7 @@ def keck_adaptive_optics(
         """Default settings for an observation using Keck Adaptive Optics imaging.
 
         This can be customized by over-riding the default input values."""
-        psf = aa.kernel.from_gaussian(
+        psf = kernel.Kernel.from_gaussian(
             shape_2d=psf_shape_2d, sigma=psf_sigma, pixel_scales=pixel_scales
         )
         return ImagingSimulator(
@@ -212,7 +214,7 @@ def keck_adaptive_optics(
 
     @property
     def grid(self):
-        return aa.grid.uniform(
+        return grids.Grid.uniform(
             shape_2d=self.shape_2d,
             pixel_scales=self.pixel_scales,
             sub_size=self.sub_size,
@@ -252,3 +254,140 @@ def from_image(self, image, name=None):
             noise_seed=self.noise_seed,
             name=name,
         )
+
+
+class InterferometerSimulator(object):
+    def __init__(
+        self,
+        real_space_shape_2d,
+        real_space_pixel_scales,
+        uv_wavelengths,
+        sub_size,
+        exposure_time,
+        background_sky_level,
+        primary_beam=None,
+        noise_sigma=0.1,
+        noise_if_add_noise_false=0.1,
+        noise_seed=-1,
+        origin=(0.0, 0.0),
+    ):
+        """A class representing a Imaging observation, using the shape of the image, the pixel scale,
+        psf, exposure time, etc.
+
+        Parameters
+        ----------
+        real_space_shape_2d : (int, int)
+            The shape of the observation. Note that we do not simulator a full Imaging frame (e.g. 2000 x 2000 pixels for \
+            Hubble imaging), but instead just a cut-out around the strong lens.
+        real_space_pixel_scales : float
+            The size of each pixel in arc seconds.
+        psf : PSF
+            An arrays describing the PSF kernel of the image.
+        exposure_time : float
+            The exposure time of an observation using this data_type.
+        background_sky_level : float
+            The level of the background sky of an observationg using this data_type.
+        """
+
+        if type(real_space_pixel_scales) is float:
+            real_space_pixel_scales = (real_space_pixel_scales, real_space_pixel_scales)
+
+        self.real_space_shape_2d = real_space_shape_2d
+        self.real_space_pixel_scales = real_space_pixel_scales
+        self.uv_wavelengths = uv_wavelengths
+        self.sub_size = sub_size
+        self.origin = origin
+        self.transformer = fourier_transform.Transformer(uv_wavelengths=self.uv_wavelengths, grid_radians=self.grid.in_1d_binned.in_radians)
+        self.exposure_time = exposure_time
+        self.background_sky_level = background_sky_level
+        self.primary_beam = primary_beam
+        self.noise_sigma = noise_sigma
+        self.noise_if_add_noise_false = noise_if_add_noise_false
+        self.noise_seed = noise_seed
+
+    @property
+    def grid(self):
+        return grids.Grid.uniform(
+            shape_2d=self.real_space_shape_2d,
+            pixel_scales=self.real_space_pixel_scales,
+            sub_size=self.sub_size,
+            origin=self.origin,
+        )
+
+    @classmethod
+    def sma(
+        cls,
+        real_space_shape_2d=(151, 151),
+        real_space_pixel_scales=(0.05, 0.05),
+        sub_size=8,
+        primary_beam_shape_2d=None,
+        primary_beam_sigma=None,
+        exposure_time=100.0,
+        background_sky_level=1.0,
+        noise_sigma=0.1,
+        noise_if_add_noise_false=0.1,
+        noise_seed=-1,
+    ):
+        """Default settings for an observation with the Large Synotpic Survey Telescope.
+
+        This can be customized by over-riding the default input values."""
+
+        uv_wavelengths_path = "{}/dataset/sma_uv_wavelengths.fits".format(
+        os.path.dirname(os.path.realpath(__file__)))
+
+        uv_wavelengths = array_util.numpy_array_1d_from_fits(file_path=uv_wavelengths_path, hdu=0)
+
+        if primary_beam_shape_2d is not None and primary_beam_sigma is not None:
+            primary_beam = kernel.Kernel.from_gaussian(
+                shape_2d=primary_beam_shape_2d, sigma=primary_beam_sigma, pixel_scales=real_space_pixel_scales
+            )
+        else:
+            primary_beam = None
+
+        return InterferometerSimulator(
+            real_space_shape_2d=real_space_shape_2d,
+            real_space_pixel_scales=real_space_pixel_scales,
+            uv_wavelengths=uv_wavelengths,
+            sub_size=sub_size,
+            primary_beam=primary_beam,
+            exposure_time=exposure_time,
+            background_sky_level=background_sky_level,
+            noise_sigma=noise_sigma,
+            noise_if_add_noise_false=noise_if_add_noise_false,
+            noise_seed=noise_seed,
+        )
+
+    def from_real_space_image(self, real_space_image):
+        """
+        Create a realistic simulated image by applying effects to a plain simulated image.
+
+        Parameters
+        ----------
+        name
+        real_space_image : ndarray
+            The image before simulating (e.g. the lens and source galaxies before optics blurring and Imaging read-out).
+        pixel_scales: float
+            The scale of each pixel in arc seconds
+        exposure_time_map : ndarray
+            An arrays representing the effective exposure time of each pixel.
+        psf: PSF
+            An arrays describing the PSF the simulated image is blurred with.
+        background_sky_map : ndarray
+            The value of background sky in every image pixel (electrons per second).
+        add_noise: Bool
+            If True poisson noise_maps is simulated and added to the image, based on the total counts in each image
+            pixel
+        noise_seed: int
+            A seed for random noise_maps generation
+        """
+        return interferometer.SimulatedInterferometer.simulate(
+            real_space_image=real_space_image,
+            real_space_pixel_scales=self.real_space_pixel_scales,
+            exposure_time=self.exposure_time,
+            transformer=self.transformer,
+            primary_beam=self.primary_beam,
+            background_sky_level=self.background_sky_level,
+            noise_sigma=self.noise_sigma,
+            noise_if_add_noise_false=self.noise_if_add_noise_false,
+            noise_seed=self.noise_seed,
+        )

autoarray/simulator/simulator.py

@@ -1,5 +1,6 @@
 import autoarray as aa
 
+import pytest
 import numpy as np
 import os
 
@@ -8,7 +9,7 @@
 )
 
 
-class TestImaging:
+class TestImagingSimulator:
     def test__simulator_grid_is_uniform_grid_with_same_inputs(self):
 
         grid = aa.grid.uniform(
@@ -146,3 +147,77 @@ def test__from_image_same_as_manual_image_input(self):
         assert (
             imaging_simulated.exposure_time_map == imaging_manual.exposure_time_map
         ).all()
+
+
+class TestInterferometerSimulator:
+    def test__simulator_grid_is_uniform_grid_with_same_inputs(self):
+
+        grid = aa.grid.uniform(
+            shape_2d=(31, 31), pixel_scales=0.05, sub_size=1, origin=(0.1, 0.1)
+        )
+
+        simulator = aa.simulator.interferometer(
+            real_space_shape_2d=(31, 31),
+            real_space_pixel_scales=0.05,
+            uv_wavelengths=np.ones((7,2)),
+            sub_size=1,
+            origin=(0.1, 0.1),
+            exposure_time=20.0,
+            background_sky_level=10.0,
+        )
+
+        assert (simulator.grid == grid).all()
+
+    def test__constructor_and_specific_instrument_class_methods(self):
+
+        sma = aa.simulator.interferometer.sma()
+
+        uv_wavelengths_path = "{}/dataset/sma_uv_wavelengths.fits".format(
+            os.path.dirname(os.path.realpath(__file__)))
+
+        sma_uv_wavelengths = aa.util.array.numpy_array_1d_from_fits(file_path=uv_wavelengths_path, hdu=0)
+
+        assert sma.real_space_shape_2d == (151, 151)
+        assert sma.real_space_pixel_scales == (0.05, 0.05)
+        assert (sma.uv_wavelengths == sma_uv_wavelengths).all()
+        assert sma.uv_wavelengths[0] == pytest.approx([184584.953125, -16373.30566406], 1.0e-4)
+        assert sma.exposure_time == 100.0
+        assert sma.background_sky_level == 1.0
+
+    def test__from_real_space_image_same_as_manual_image_input(self):
+
+        primary_beam = aa.kernel.manual_2d(
+            array=np.array([[0.0, 1.0, 0.0], [1.0, 2.0, 1.0], [0.0, 1.0, 0.0]]),
+            pixel_scales=1.0,
+        )
+
+        real_space_image = aa.array.manual_2d([[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]])
+
+        simulator = aa.simulator.interferometer(
+            real_space_shape_2d=(2, 3),
+            real_space_pixel_scales=0.05,
+            uv_wavelengths=np.ones((7,2)),
+            sub_size=1,
+            primary_beam=primary_beam,
+            exposure_time=10000.0,
+            background_sky_level=100.0,
+            noise_sigma=0.1,
+            noise_seed=1,
+        )
+
+        interferometer_simulated = simulator.from_real_space_image(real_space_image=real_space_image)
+
+        interferometer_manual = aa.interferometer.simulate(
+            real_space_image=real_space_image,
+            real_space_pixel_scales=0.05,
+            transformer=simulator.transformer,
+            exposure_time=10000.0,
+            primary_beam=primary_beam,
+            background_sky_level=100.0,
+            noise_sigma=0.1,
+            noise_seed=1,
+        )
+
+        assert (interferometer_simulated.visibilities == interferometer_manual.visibilities).all()
+        assert (interferometer_simulated.noise_map == interferometer_manual.noise_map).all()
+        assert (interferometer_simulated.primary_beam.in_2d == interferometer_manual.primary_beam.in_2d).all()

test_autoarray/unit/simulator/dataset/sma_uv_wavelengths.fits

@@ -13,7 +13,7 @@ assert_pickle_matches = False
 
 [numba]
 nopython = True
-cache = True
+cache = False
 parallel = False
 
 [inversion]