Made RMSF width calculations consistent throughout (#86).

CIRADA-Tools · Aug 4, 2023 · eb289f3 · eb289f3
1 parent 972a992
commit eb289f3
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 3 deletions.
diff --git a/RMtools_1D/do_RMsynth_1D.py b/RMtools_1D/do_RMsynth_1D.py
@@ -241,7 +241,7 @@ def run_rmsynth(data, polyOrd=2, phiMax_radm2=None, dPhi_radm2=None,
 
     # Set the Faraday depth range
     if not super_resolution:
-        fwhmRMSF_radm2 = 2.0 * m.sqrt(3.0) / lambdaSqRange_m2 #B&dB05 theoretical RMSF width
+        fwhmRMSF_radm2 = 3.8 / lambdaSqRange_m2 #Dickey+2019 theoretical RMSF width
     else: #If super resolution, use R&C23 theoretical width
         fwhmRMSF_radm2 = 2.0 / (np.nanmax(lambdaSqArr_m2) + np.nanmin(lambdaSqArr_m2))
     if dPhi_radm2 is None:

diff --git a/RMtools_3D/do_RMsynth_3D.py b/RMtools_3D/do_RMsynth_3D.py
@@ -118,7 +118,7 @@ def run_rmsynth(dataQ, dataU, freqArr_Hz, dataI=None, rmsArr=None,
 
     # Set the Faraday depth range
     if not super_resolution:
-        fwhmRMSF_radm2 = 2.0 * m.sqrt(3.0) / lambdaSqRange_m2 #B&dB05 theoretical RMSF width
+        fwhmRMSF_radm2 = 3.8 / lambdaSqRange_m2 #Dickey+2019 theoretical RMSF width
     else: #If super resolution, use R&C23 theoretical width
         fwhmRMSF_radm2 = 2.0 / (np.nanmax(lambdaSqArr_m2) + np.nanmin(lambdaSqArr_m2))
     if dPhi_radm2 is None:

diff --git a/VERSION_HISTORY.txt b/VERSION_HISTORY.txt
@@ -2,6 +2,16 @@
 
 Github main branch:
 
+
+1.3.1:
+-progress bars updated to use tdqm, which should make them faster.
+-Integrated super-resolution method of Cotton & Rudnick 2023, which creates
+  narrower RMSF shapes by setting lambda^2_0 = 0.
+-Added options to dofitIcube tool to save more outputs (coefficient maps, 
+  errors, etc).
+-Made RMSF theoretical width calculations consistent: Dickey et al. 2019
+  now used throughout.
+
 1.3.0:
 -merged in bwdepol branch. This does not change any core functionality in the
   existing RM-Tools programs, but adds two new command-line tools: rmtools_bwpredict

diff --git a/setup.py b/setup.py
@@ -12,7 +12,7 @@
 DESCRIPTION = 'RM-synthesis, RM-clean and QU-fitting on polarised radio spectra'
 URL = 'https://github.com/CIRADA-Tools/RM-Tools'
 REQUIRES_PYTHON = '>=3.7.0'
-VERSION = '1.3.0'
+VERSION = '1.3.1'
 DOWNLOAD_URL = 'https://github.com/CIRADA-Tools/RM-Tools/archive/v'+VERSION+'.tar.gz'
 
 REQUIRED = [