Version 0.5.6.

vrodgom · Apr 13, 2024 · cdab010 · cdab010
1 parent f36ca2f
commit cdab010
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -22,7 +22,7 @@
 author = 'Vicente Rodriguez-Gomez'
 
 # The full version, including alpha/beta/rc tags
-release = '0.5.5'
+release = '0.5.6'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/notebooks/tutorial.ipynb b/docs/notebooks/tutorial.ipynb
@@ -287,7 +287,7 @@
    "source": [
     "Note that the fitted Sersic model is in very good agreement with the \"true\" Sersic model that we originally defined (n = 2.5, rhalf = 20, etc.) and that the reduced chi-squared statistic (sersic_chi2_dof) is close to 1, indicating a good fit without overfitting. However, such good agreement tends to deteriorate somewhat at higher noise levels, and one has to keep in mind that not all galaxies are well described by Sersic profiles.\n",
     "\n",
-    "Other morphological measurements that are more general and robust to noise, which are also calculated by statmorph, include the Gini-M20 (Lotz et al. 2004), CAS (Conselice 2003) and MID (Freeman et al. 2013) statistics, as well as the outer asymmetry (Wen et al. 2014) and shape asymmetry (Pawlik et al. 2016).\n",
+    "Other morphological measurements that are more general and robust to noise, which are also calculated by statmorph, include the Gini-M20 (Lotz et al. 2004), CAS (Conselice 2003) and MID (Freeman et al. 2013) statistics, as well as the RMS asymmetry (Sazonova et al. 2024), outer asymmetry (Wen et al. 2014), and shape asymmetry (Pawlik et al. 2016).\n",
     "\n",
     "Also note that statmorph returns two quality flags:\n",
     "\n",

diff --git a/docs/overview.rst b/docs/overview.rst
@@ -11,7 +11,7 @@ morphological statistics for each source:
   (Bershady et al. 2000; Conselice 2003; Lotz et al. 2004)
 - Multimode, Intensity and Deviation (MID) statistics (Freeman et al. 2013;
   Peth et al. 2016)
-- Outer asymmetry and shape asymmetry (Wen et al. 2014; Pawlik et al. 2016)
+- RMS asymmetry (Sazonova et al. 2024), outer asymmetry (Wen et al. 2014) and shape asymmetry (Pawlik et al. 2016)
 - Single and double Sérsic indices (Sérsic 1968)
 - Several shape and size measurements associated to the above statistics
   (ellipticity, Petrosian radius, half-light radius, etc.)

diff --git a/setup.py b/setup.py
@@ -11,7 +11,7 @@
 
 setup(
     name='statmorph',
-    version='0.5.5',
+    version='0.5.6',
     description='Non-parametric morphological diagnostics of galaxy images',
     long_description=long_description,
     url='https://github.com/vrodgom/statmorph',

diff --git a/statmorph/statmorph.py b/statmorph/statmorph.py
@@ -32,7 +32,7 @@
     '__version__',
 ]
 
-__version__ = '0.5.5'
+__version__ = '0.5.6'
 
 # A list of the quantities calculated by SourceMorphology,
 # excluding the double Sersic parameters:
@@ -1857,7 +1857,8 @@ def asymmetry(self):
     @lazyproperty
     def rms_asymmetry(self):
         """
-        Calculate RMS asymmetry as described in Sazonova et al. (2024).
+        Calculate the RMS asymmetry as in eq. 27 of Sazonova et al. (2024).
+        Note that this actually corresponds to the *square* of A_rms.
         """
         image = self._cutout_stamp_maskzeroed
         asym = self._asymmetry_function(self._asymmetry_center,