updated doc strings

Author: samueldmcdermott

deepszsim/filters.py

@@ -5,7 +5,7 @@
 import numpy as np
 
 def get_tSZ_signal_aperture_photometry(dT_map, radmax_arcmin, pixel_scale, 
-                                       fmax_arcmin=np.sqrt(2)):
+                                       fmax=np.sqrt(2)):
     """
     Parameters:
     ----------
@@ -14,8 +14,8 @@ def get_tSZ_signal_aperture_photometry(dT_map, radmax_arcmin, pixel_scale,
         the radius of the inner aperture, in arcmin
     pixel_scale: float
         How many arcmin per pixel for the current settings
-    fmax_arcmin: float
-        fmax+radmax is the radius of the outer aperture, in arcmin
+    fmax: float
+        fmax * radmax_arcmin is the radius of the outer aperture, in arcmin
 
     Returns:
     -------
@@ -28,7 +28,7 @@ def get_tSZ_signal_aperture_photometry(dT_map, radmax_arcmin, pixel_scale,
     """
 
     radmax_pixels = radmax_arcmin / pixel_scale
-    radius_out_pixels = radmax_pixels * fmax_arcmin
+    radius_out_pixels = radmax_pixels * fmax
 
     center = np.array(dT_map.shape) // 2
     x, y = np.indices(dT_map.shape)

deepszsim/make_sz_cluster.py

@@ -228,8 +228,7 @@ def Pth_Battaglia2012(radius_mpc, M200_SM, redshift_z, load_vars_dict = None,
     return _Pth_Battaglia2012(P0, radius_mpc, R200_Mpc, alpha, beta, gamma, xc)
 
 
-def Pe_to_y(profile, radii_mpc, M200_SM, redshift_z, load_vars_dict, alpha = 1.0, gamma = -0.3, R200_Mpc = None,
-            Rmaxy = None):
+def Pe_to_y(profile, radii_mpc, M200_SM, redshift_z, load_vars_dict, alpha = 1.0, gamma = -0.3, R200_Mpc = None):
     '''
     Converts from an electron pressure profile to a compton-y profile,
     integrates over line of sight from -1 to 1 Mpc relative to center.
@@ -264,28 +263,12 @@ def Pe_to_y(profile, radii_mpc, M200_SM, redshift_z, load_vars_dict, alpha = 1.0
     if R200_Mpc is None:
         R200_Mpc = get_r200_angsize_and_c200(M200_SM, redshift_z, load_vars_dict)[1]
     radii_mpc = (radii_mpc * u.Mpc).value
-    if Rmaxy is None:
-        rmax = radii_mpc.max()
-    elif '200' in Rmaxy:
-        rmax = R200_Mpc
-    else:
-        print('please specify a valid `Rmaxy`')
-        return None
     if profile != "Battaglia2012":
         print("only implementing `Battaglia2012` for profile")
     profile = Pth_Battaglia2012
     pressure_integ = np.empty_like(radii_mpc)
     P200_kevcm3 = P200_Battaglia2012(M200_SM, redshift_z, load_vars_dict, R200_Mpc = R200_Mpc).value
 
-    # integral = np.trapz(np.array([profile(np.sqrt(np.linspace(0, np.sqrt(radii_mpc.max()**2. - rv**2.)+1.,
-    #                                                               1000)**2 +
-    #                                      rv**2), M200_SM, redshift_z, load_vars_dict = None, alpha = alpha,
-    #                       gamma = gamma, R200_Mpc = r200) for rv in radii_mpc]), np.array([np.linspace(0,
-    #                                                                                             np.sqrt(radii_mpc.max(
-    # )**2. - rv**2.)+1., 1000) for rv in radii_mpc]))
-    # y_pro = integral * P200_kevcm3 * keVcm3_to_Jm3 * Thomson_scale * \
-    #         thermal_to_electron_pressure * 2*Mpc_to_m
-    # return y_pro
     for i, radius in enumerate(radii_mpc):
         # Multiply profile by P200 specifically for Battaglia 2012 profile,
         # since it returns Pth/P200 instead of Pth
@@ -303,7 +286,7 @@ def Pe_to_y(profile, radii_mpc, M200_SM, redshift_z, load_vars_dict, alpha = 1.0
 
 
 def _make_y_submap(profile, M200_SM, redshift_z, load_vars_dict, image_size_pixels, pixel_size_arcmin, alpha = 1.0,
-                   gamma = -0.3, R200_Mpc = None, Rmaxy = None):
+                   gamma = -0.3, R200_Mpc = None):
     '''
     Converts from an electron pressure profile to a compton-y profile,
     integrates over line of sight from -1 to 1 Mpc relative to center.
@@ -324,6 +307,10 @@ def _make_y_submap(profile, M200_SM, redshift_z, load_vars_dict, image_size_pixe
         size of final submap in number of pixels
     pixel_size_arcmin: float
         size of each pixel in arcmin
+    alpha: float
+        variable fixed by Battaglia et al 2012 to 1.0
+    gamma: float
+        variable fixed by Battaglia et al 2012 to -0.3
     R200_Mpc: None or float
         if None, will calculate the radius that corresponds to the mass M200, the redshift redshift_z,
         and the cosmology contained in load_vars_dict
@@ -341,8 +328,7 @@ def _make_y_submap(profile, M200_SM, redshift_z, load_vars_dict, image_size_pixe
     mindist = utils.arcmin_to_Mpc(pixel_size_arcmin*0.1, redshift_z, load_vars_dict['cosmo'])
     R = np.maximum(mindist, np.sqrt(X[:, None]**2 + X[None, :]**2).flatten())
 
-    cy = Pe_to_y(profile, R, M200_SM, redshift_z, load_vars_dict, alpha = alpha, gamma = gamma, R200_Mpc = R200_Mpc,
-                 Rmaxy = Rmaxy)  #
+    cy = Pe_to_y(profile, R, M200_SM, redshift_z, load_vars_dict, alpha = alpha, gamma = gamma, R200_Mpc = R200_Mpc)  #
     # evaluate compton-y for each
     # neccesary radius
 
@@ -366,7 +352,7 @@ def _make_y_submap(profile, M200_SM, redshift_z, load_vars_dict, image_size_pixe
 
 def generate_y_submap(M200_SM, redshift_z, profile = "Battaglia2012",
                       image_size_pixels = None, pixel_size_arcmin = None, load_vars_dict = None, alpha = 1.0, gamma = -0.3,
-                      R200_Mpc = None, Rmaxy = None):
+                      R200_Mpc = None):
     '''
     Converts from an electron pressure profile to a compton-y profile,
     integrates over line of sight from -1 to 1 Mpc relative to center.
@@ -387,6 +373,10 @@ def generate_y_submap(M200_SM, redshift_z, profile = "Battaglia2012",
     load_vars_dict: dict
         result of running the load_vars() function, which includes a dictionary of cosmological and experimental
         parameters
+    alpha: float
+        variable fixed by Battaglia et al 2012 to 1.0
+    gamma: float
+        variable fixed by Battaglia et al 2012 to -0.3
     R200_Mpc: None or float
         if None, will calculate the radius that corresponds to the mass M200, the redshift redshift_z,
         and the cosmology contained in load_vars_dict
@@ -406,7 +396,7 @@ def generate_y_submap(M200_SM, redshift_z, profile = "Battaglia2012",
 
     y_map = _make_y_submap(profile, M200_SM, redshift_z, load_vars_dict,
                            image_size_pixels, pixel_size_arcmin,
-                           alpha = alpha, gamma = gamma, R200_Mpc = R200_Mpc, Rmaxy = Rmaxy)
+                           alpha = alpha, gamma = gamma, R200_Mpc = R200_Mpc)
 
     return y_map
 
@@ -421,6 +411,9 @@ def get_r200_angsize_and_c200(M200_SM, redshift_z, load_vars_dict, angsize_densi
     load_vars_dict: dict
         must contain 'cosmo' (a FlatLambaCDM instance describing the background cosmology),
         'sigma8' (float, around 0.8), and 'ns' (float, around 0.96)
+    angsize_density: None or str
+        density measure at which to calculate the angular size, if desired. If `None`, will not
+        calculate an angular size. Otherwise, use a valid choice as specified in `colossus.halo.mass_adv`
 
     Returns:
     -------

deepszsim/noise.py

@@ -9,8 +9,12 @@ def generate_noise_map(image_size, noise_level, pix_size):
     Generates a white noise map based on the noise level and beam size.
 
     Args:
-        image_size (int): Size of the noise map (N x N).
-        noise_level (float): Noise level of the survey.
+        image_size: int
+            Size of the noise map (N x N).
+        noise_level: float
+            Noise level of the survey.
+        pix_size: int
+            size of pixels in arcminutes
 
     Returns:
         ndarray: Noise map.

deepszsim/simclusters.py

@@ -10,7 +10,7 @@
 
 class simulate_clusters:
     def __init__(self, M200 = None, redshift_z = None, num_halos = None, halo_params_dict = None,
-                 R200_Mpc = None, Rmaxy = None, profile = "Battaglia2012",
+                 R200_Mpc = None, profile = "Battaglia2012",
                  image_size_pixels = None, image_size_arcmin = None, pixel_size_arcmin = None,
                  alpha = 1.0, gamma = -0.3,
                  load_vars_yaml = os.path.join(os.path.dirname(__file__), 'Settings', 'inputdata.yaml'),
@@ -19,9 +19,9 @@ def __init__(self, M200 = None, redshift_z = None, num_halos = None, halo_params
         """
         Parameters
         ----------
-        M200_dist: float or array-like of float
+        M200: float or array-like of float
             the mass contained within R200 in solar masses (same length as z_dist)
-        z_dist: float or array-like of float
+        redshift_z: float or array-like of float
             the redshift of the cluster (unitless) (same length as M200_dist)
         num_halos: None or int
             number of halos to simulate if none supplied
@@ -47,6 +47,8 @@ def __init__(self, M200 = None, redshift_z = None, num_halos = None, halo_params
             path to yaml file with params
         seed: None or int
             random seed value to sample with
+        tqverb: bool
+            whether or not to display tqdm progress bar while making T maps
         """
 
         if (M200 is not None) and (redshift_z is not None):
@@ -98,8 +100,6 @@ def __init__(self, M200 = None, redshift_z = None, num_halos = None, halo_params
                                                            angsize_density = '500c')[1:3]
                  for i in range(self._size)]).T
 
-        self.Rmaxy = Rmaxy
-        
         self.id_list = [
             str(self.M200[i])[:5] + str(self.redshift_z[i] * 100)[:2] + str(self._rng.integers(10**6)).zfill(6)
             for i in range(self._size)]
@@ -112,7 +112,6 @@ def __init__(self, M200 = None, redshift_z = None, num_halos = None, halo_params
 
     def get_y_maps(self):
         """
-
         Returns
         -------
         np.ndarray(float)
@@ -125,14 +124,12 @@ def get_y_maps(self):
             self.y_maps = np.array([make_sz_cluster.generate_y_submap(self.M200[i],
                                                       self.redshift_z[i],
                                                       R200_Mpc = self.R200_Mpc[i],
-                                                      Rmaxy = self.Rmaxy,
                                                       load_vars_dict = self.vars)
                                     for i in tqdm(range(self._size), disable = (not self.tqverb))])
             return self.y_maps
 
     def get_dT_maps(self):
         """
-
         Returns
         -------
         np.ndarray(float)
@@ -153,6 +150,8 @@ def get_T_maps(self, add_CMB = True, returnval = False):
         ----------
         add_CMB: bool
             whether or not to include the CMB contribution to the final map
+        returnval: bool
+            whether or not to return the T maps themselves or simply update internal attribute
 
         Returns
         -------