From d916cb866d1b7914bb9879c90778f53971c20f79 Mon Sep 17 00:00:00 2001 From: Simon Birrer Date: Sat, 27 Jul 2024 15:27:03 -0400 Subject: [PATCH] document formatting improved --- docs/lenstronomy.LensModel.Profiles.rst | 605 ------------------ docs/lenstronomy.LensModel.rst | 83 --- docs/lenstronomy.LightModel.Profiles.rst | 141 ---- .../Microlensing/adaptive_boundary_mesh.py | 6 +- .../LensModel/Profiles/epl_multipole_m3m4.py | 10 +- .../Profiles/multi_gaussian_ellipse_kappa.py | 2 +- lenstronomy/Workflow/psf_fitting.py | 6 +- 7 files changed, 12 insertions(+), 841 deletions(-) delete mode 100644 docs/lenstronomy.LensModel.Profiles.rst delete mode 100644 docs/lenstronomy.LensModel.rst delete mode 100644 docs/lenstronomy.LightModel.Profiles.rst diff --git a/docs/lenstronomy.LensModel.Profiles.rst b/docs/lenstronomy.LensModel.Profiles.rst deleted file mode 100644 index 64488a33f..000000000 --- a/docs/lenstronomy.LensModel.Profiles.rst +++ /dev/null @@ -1,605 +0,0 @@ -lenstronomy.LensModel.Profiles package -====================================== - -Submodules ----------- - -lenstronomy.LensModel.Profiles.arc\_perturbations module --------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.arc_perturbations - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.base\_profile module ---------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.base_profile - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.blank\_plane module --------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.blank_plane - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.chameleon module ------------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.chameleon - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.cnfw module ------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.cnfw - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.cnfw\_ellipse module ---------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.cnfw_ellipse - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.const\_mag module ------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.const_mag - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.constant\_shift module ------------------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.constant_shift - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.convergence module -------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.convergence - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.coreBurkert module -------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.coreBurkert - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.cored\_density module ----------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.cored_density - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.cored\_density\_2 module -------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.cored_density_2 - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.cored\_density\_exp module ---------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.cored_density_exp - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.cored\_density\_mst module ---------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.cored_density_mst - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.cored\_steep\_ellipsoid module -------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.cored_steep_ellipsoid - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.curved\_arc\_const module --------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.curved_arc_const - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.curved\_arc\_sis\_mst module ------------------------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.curved_arc_sis_mst - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.curved\_arc\_spp module ------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.curved_arc_spp - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.curved\_arc\_spt module ------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.curved_arc_spt - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.curved\_arc\_tan\_diff module ------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.curved_arc_tan_diff - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.dipole module --------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.dipole - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.elliptical\_density\_slice module ----------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.elliptical_density_slice - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.epl module ------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.epl - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.epl\_boxydisky module ----------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.epl_boxydisky - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.epl\_numba module ------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.epl_numba - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.flexion module ---------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.flexion - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.flexionfg module ------------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.flexionfg - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.gauss\_decomposition module ----------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.gauss_decomposition - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.gaussian\_ellipse\_kappa module --------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.gaussian_ellipse_kappa - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.gaussian\_ellipse\_potential module ------------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.gaussian_ellipse_potential - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.gaussian\_kappa module ------------------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.gaussian_kappa - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.gaussian\_potential module ---------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.gaussian_potential - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.gnfw module ------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.gnfw - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.hernquist module ------------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.hernquist - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.hernquist\_ellipse module --------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.hernquist_ellipse - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.hernquist\_ellipse\_cse module -------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.hernquist_ellipse_cse - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.hessian module ---------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.hessian - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.interpol module ----------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.interpol - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.multi\_gaussian\_kappa module ------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.multi_gaussian_kappa - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.multipole module ------------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.multipole - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.nfw module ------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.nfw - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.nfw\_core\_truncated module ----------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.nfw_core_truncated - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.nfw\_ellipse module --------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.nfw_ellipse - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.nfw\_ellipse\_cse module -------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.nfw_ellipse_cse - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.nfw\_mass\_concentration module --------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.nfw_mass_concentration - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.nfw\_mass\_concentration\_ellipse module ------------------------------------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.nfw_mass_concentration_ellipse - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.nfw\_vir\_trunc module ------------------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.nfw_vir_trunc - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.nie module ------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.nie - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.nie\_potential module ----------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.nie_potential - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.numerical\_deflections module ------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.numerical_deflections - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.p\_jaffe module ----------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.p_jaffe - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.p\_jaffe\_ellipse module -------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.p_jaffe_ellipse - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.pemd module ------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.pemd - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.point\_mass module -------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.point_mass - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.pseudo\_double\_powerlaw module --------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.pseudo_double_powerlaw - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.radial\_interpolated module ----------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.radial_interpolated - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.sersic module --------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.sersic - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.sersic\_ellipse\_kappa module ------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.sersic_ellipse_kappa - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.sersic\_ellipse\_potential module ----------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.sersic_ellipse_potential - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.sersic\_utils module ---------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.sersic_utils - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.shapelet\_pot\_cartesian module --------------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.shapelet_pot_cartesian - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.shapelet\_pot\_polar module ----------------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.shapelet_pot_polar - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.shear module -------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.shear - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.sie module ------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.sie - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.sis module ------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.sis - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.sis\_truncate module ---------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.sis_truncate - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.spemd module -------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.spemd - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.spep module ------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.spep - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.splcore module ---------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.splcore - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.spp module ------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.spp - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.synthesis module ------------------------------------------------ - -.. automodule:: lenstronomy.LensModel.Profiles.synthesis - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.tnfw module ------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.tnfw - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.tnfw\_ellipse module ---------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.tnfw_ellipse - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.Profiles.uldm module ------------------------------------------- - -.. automodule:: lenstronomy.LensModel.Profiles.uldm - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: lenstronomy.LensModel.Profiles - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/lenstronomy.LensModel.rst b/docs/lenstronomy.LensModel.rst deleted file mode 100644 index 6779081dc..000000000 --- a/docs/lenstronomy.LensModel.rst +++ /dev/null @@ -1,83 +0,0 @@ -lenstronomy.LensModel package -============================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - lenstronomy.LensModel.LightConeSim - lenstronomy.LensModel.LineOfSight - lenstronomy.LensModel.MultiPlane - lenstronomy.LensModel.Profiles - lenstronomy.LensModel.QuadOptimizer - lenstronomy.LensModel.Solver - lenstronomy.LensModel.Util - -Submodules ----------- - -lenstronomy.LensModel.convergence\_integrals module ---------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.convergence_integrals - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.lens\_model module ----------------------------------------- - -.. automodule:: lenstronomy.LensModel.lens_model - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.lens\_model\_extensions module ----------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.lens_model_extensions - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.lens\_param module ----------------------------------------- - -.. automodule:: lenstronomy.LensModel.lens_param - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.profile\_integrals module ------------------------------------------------ - -.. automodule:: lenstronomy.LensModel.profile_integrals - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.profile\_list\_base module ------------------------------------------------- - -.. automodule:: lenstronomy.LensModel.profile_list_base - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LensModel.single\_plane module ------------------------------------------- - -.. automodule:: lenstronomy.LensModel.single_plane - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: lenstronomy.LensModel - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/lenstronomy.LightModel.Profiles.rst b/docs/lenstronomy.LightModel.Profiles.rst deleted file mode 100644 index 26ef771ce..000000000 --- a/docs/lenstronomy.LightModel.Profiles.rst +++ /dev/null @@ -1,141 +0,0 @@ -lenstronomy.LightModel.Profiles package -======================================= - -Submodules ----------- - -lenstronomy.LightModel.Profiles.chameleon module ------------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.chameleon - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.ellipsoid module ------------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.ellipsoid - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.gaussian module ------------------------------------------------ - -.. automodule:: lenstronomy.LightModel.Profiles.gaussian - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.hernquist module ------------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.hernquist - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.interpolation module ----------------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.interpolation - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.moffat module ---------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.moffat - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.nie module ------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.nie - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.p\_jaffe module ------------------------------------------------ - -.. automodule:: lenstronomy.LightModel.Profiles.p_jaffe - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.power\_law module -------------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.power_law - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.profile\_base module ----------------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.profile_base - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.sersic module ---------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.sersic - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.shapelets module ------------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.shapelets - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.shapelets\_polar module -------------------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.shapelets_polar - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.starlets module ------------------------------------------------ - -.. automodule:: lenstronomy.LightModel.Profiles.starlets - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.starlets\_util module ------------------------------------------------------ - -.. automodule:: lenstronomy.LightModel.Profiles.starlets_util - :members: - :undoc-members: - :show-inheritance: - -lenstronomy.LightModel.Profiles.uniform module ----------------------------------------------- - -.. automodule:: lenstronomy.LightModel.Profiles.uniform - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: lenstronomy.LightModel.Profiles - :members: - :undoc-members: - :show-inheritance: diff --git a/lenstronomy/LensModel/Microlensing/adaptive_boundary_mesh.py b/lenstronomy/LensModel/Microlensing/adaptive_boundary_mesh.py index b6b07c759..ebc0651f1 100644 --- a/lenstronomy/LensModel/Microlensing/adaptive_boundary_mesh.py +++ b/lenstronomy/LensModel/Microlensing/adaptive_boundary_mesh.py @@ -113,11 +113,11 @@ def adaptive_boundary_mesh( :type final_eta: float :param kwargs_lens: Keyword arguments for lens model :type kwargs_lens: dict - return: side_length: updated side length of square area in image plane + :return: side_length: updated side length of square area in image plane :rtype: side_length: nparray - return: total_number_of_rays_shot: total number of rays shot + :return: total_number_of_rays_shot: total number of rays shot :rtype: total_number_of_rays_shot: int - return: subset_image_centers_x, subset_image_centers_y: x and y coordinates of high resolution image-plane pixels that were mapped to within the radius β_s around the source position (β1, β2) in the source plane + :return: subset_image_centers_x, subset_image_centers_y: x and y coordinates of high resolution image-plane pixels that were mapped to within the radius β_s around the source position (β1, β2) in the source plane :rtype: subset_image_centers_x, subset_image_centers_y: nparray """ # default values diff --git a/lenstronomy/LensModel/Profiles/epl_multipole_m3m4.py b/lenstronomy/LensModel/Profiles/epl_multipole_m3m4.py index 1db82eaaf..bbf5e2168 100644 --- a/lenstronomy/LensModel/Profiles/epl_multipole_m3m4.py +++ b/lenstronomy/LensModel/Profiles/epl_multipole_m3m4.py @@ -25,12 +25,12 @@ class EPL_MULTIPOLE_M3M4(LensProfileBase): :param center_x: center of distortion :param center_y: center of distortion :param a3_a: Strength of the deviation from elliptical isodensity contours caused by the multipole term of order 3 - translated into the multipole strength from the MULTIPOLE class through a rescaling by theta_E / sqrt(q). The rescaling - preserves the shape of the isodensity contours such that a3_a produces the same shape regardless of theta_E or q. + translated into the multipole strength from the MULTIPOLE class through a rescaling by theta_E / sqrt(q). The rescaling + preserves the shape of the isodensity contours such that a3_a produces the same shape regardless of theta_E or q. :param delta_phi_m3: angle of the m=3 multipole profile relative to the position angle of the EPL profile :param a4_a: Strength of the deviation from elliptical isodensity contours caused by the multipole term of order 3 - translated into the multipole strength from the MULTIPOLE class through a rescaling by theta_E / sqrt(q). - Profile is disky when a4_a>0 and boxy when a4_a<0 for phi_m_a4a=0.0. + translated into the multipole strength from the MULTIPOLE class through a rescaling by theta_E / sqrt(q). + Profile is disky when a4_a>0 and boxy when a4_a<0 for phi_m_a4a=0.0. :param delta_phi_m4: angle of the m=4 multipole profile relative to the position angle of the EPL profile """ @@ -227,7 +227,7 @@ def derivatives( angle of the EPL profile :param center_x: center of the profile :param center_y: center of the profile: - return: alpha_x, alpha_y. + :return: alpha_x, alpha_y. """ kwargs_epl, kwargs_multipole3, kwargs_multipole4 = self._param_split( theta_E, diff --git a/lenstronomy/LensModel/Profiles/multi_gaussian_ellipse_kappa.py b/lenstronomy/LensModel/Profiles/multi_gaussian_ellipse_kappa.py index 16a9c24c8..a8b136b19 100644 --- a/lenstronomy/LensModel/Profiles/multi_gaussian_ellipse_kappa.py +++ b/lenstronomy/LensModel/Profiles/multi_gaussian_ellipse_kappa.py @@ -176,7 +176,7 @@ def hessian(self, x, y, amp, sigma, e1, e2, center_x=0, center_y=0, scale_factor :param center_y: y coordianate of centroid :type center_y: ``float`` :param scale_factor: Scaling factor for amplitude - scale_factor: ``float`` + scale_factor: ``float`` :return: Hessian :math:`\\partial^2f/\\partial x^2`, :math:`\\partial^2/\\partial x\\partial y`, :math:`\\partial^2/\\partial y\\partial x`, :math:`\\partial^2 f/\\partial y^2` for elliptical Gaussian convergence. :rtype: tuple ``(float, float, float)`` , or ``(numpy.array, numpy.array, numpy.array)`` diff --git a/lenstronomy/Workflow/psf_fitting.py b/lenstronomy/Workflow/psf_fitting.py index e16e64d7b..b9003a9d3 100644 --- a/lenstronomy/Workflow/psf_fitting.py +++ b/lenstronomy/Workflow/psf_fitting.py @@ -179,7 +179,7 @@ def update_psf( :param kwargs_psf: keyword arguments to construct the PSF() class :param kwargs_params: keyword arguments of the parameters of the model components (e.g. 'kwargs_lens' etc) :param stacking_method: 'median', 'mean'; the different estimates of the PSF are stacked and combined together. - Not used if use_starred is True. + Not used if use_starred is True. The choices are: 'mean': mean of pixel values as the estimator (not robust to outliers) 'median': median of pixel values as the estimator (outlier rejection robust but needs >2 point sources in the @@ -207,8 +207,8 @@ def update_psf( 2) creates a psf with no symmetry 3) adds the corner_symmetry psf (which has information at the corners) to the odd symmetry PSF, in the regions where the odd-symmetry PSF does not have information - :param use_starred: boolean, if True, uses the STARRED method to estimate the PSF (https://ui.adsabs.harvard.edu/abs/2023JOSS....8.5340M/abstract) - :param kwargs_starred: dictionary, keyword arguments for the starred.procedures.psf_routines.update_PSF() method. + :param use_starred: boolean, if True, uses the STARRED method to estimate the PSF (https://ui.adsabs.harvard.edu/abs/2023JOSS....8.5340M/abstract) + :param kwargs_starred: dictionary, keyword arguments for the starred.procedures.psf_routines.update_PSF() method. Example: kwargs_starred = {'lambda_scales':2., 'lambda_hf':2., 'lambda_positivity':0.} :return: kwargs_psf_new, logL_after, error_map