SpiralMap 0.0.22__tar.gz → 0.16__tar.gz

{spiralmap-0.0.22 → spiralmap-0.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SpiralMap
-Version: 0.0.22
+Version: 0.16
 Summary: Python Library of Milky Way's Spiral Arms
 Project-URL: Homepage, https://github.com/Abhaypru/SpiralMap
 Project-URL: Issues, https://github.com/Abhaypru/SpiralMap/issues
@@ -10,6 +10,13 @@ License-File: LICENSE.md
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.9
+Requires-Dist: astropy
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: scipy
+Requires-Dist: tabulate
+Requires-Dist: update-checker
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == 'docs'
 Requires-Dist: sphinx-rtd-theme; extra == 'docs'
@@ -24,16 +31,18 @@ A Python library of the Milky Way's spiral arms.
 
 The detailed documentation is hosted on [Read the docs](https://spiralmap.readthedocs.io/en/latest/#api-docs).
 
-For a quickstart please refer to the accompanying [Jupyter notebook](https://github.com/Abhaypru/SpiralMap/blob/main/demo_spiralmap.ipynb)
+For a quickstart please refer to the accompanying [Jupyter notebook](https://github.com/Abhaypru/SpiralMap/blob/main/demo_spiralmap.ipynb).
 
+Read the preprint at [arxiv](https://www.arxiv.org/abs/2506.11383).
 ## Features
-+ Access 8 independent spiral arm models from literature. We are open to requests for including other spiral arm models. 
++ Access 9 independent spiral arm models from literature. We are open to requests for including other spiral arm models. 
 + Extract the 2D trace of individual or all spiral arms from a particular model.
 + Directly overplot spiral arms with choice of Cartesian or Polar coordinates, and in Heliocentric or Galactocentric frames.
 
-![image info](src/SpiralMap/movie_.gif).
-
-Shown above is a gallery of the spiral models & maps included in the current version. 
+## Updates
++ Missing Local arm (logarithmic) added to Hou-Han 2014 model.
++ Vallee 1995 model included. 
++ Dependencies included
 
 Installation
 -------------

{spiralmap-0.0.22 → spiralmap-0.16}/README.md

@@ -6,16 +6,18 @@ A Python library of the Milky Way's spiral arms.
 
 The detailed documentation is hosted on [Read the docs](https://spiralmap.readthedocs.io/en/latest/#api-docs).
 
-For a quickstart please refer to the accompanying [Jupyter notebook](https://github.com/Abhaypru/SpiralMap/blob/main/demo_spiralmap.ipynb)
+For a quickstart please refer to the accompanying [Jupyter notebook](https://github.com/Abhaypru/SpiralMap/blob/main/demo_spiralmap.ipynb).
 
+Read the preprint at [arxiv](https://www.arxiv.org/abs/2506.11383).
 ## Features
-+ Access 8 independent spiral arm models from literature. We are open to requests for including other spiral arm models. 
++ Access 9 independent spiral arm models from literature. We are open to requests for including other spiral arm models. 
 + Extract the 2D trace of individual or all spiral arms from a particular model.
 + Directly overplot spiral arms with choice of Cartesian or Polar coordinates, and in Heliocentric or Galactocentric frames.
 
-![image info](src/SpiralMap/movie_.gif).
-
-Shown above is a gallery of the spiral models & maps included in the current version. 
+## Updates
++ Missing Local arm (logarithmic) added to Hou-Han 2014 model.
++ Vallee 1995 model included. 
++ Dependencies included
 
 Installation
 -------------

{spiralmap-0.0.22 → spiralmap-0.16}/docs/source/citation.rst

@@ -1,7 +1,7 @@
 How to Cite
 ===========
 
-If you use **SpiralMap**, please cite the accompanying paper (link). 
+If you use **SpiralMap**, please cite the accompanying paper `Prusty & Khanna <https://arxiv.org/abs/2506.11383>`_. 
 
 Pleae also cite the particular models used, we provide below the references in BibTeX format.
 

spiralmap-0.0.22/docs/build/html/_sources/index.rst.txt → spiralmap-0.16/docs/source/index.rst

@@ -12,7 +12,7 @@ We present a Python library of the Milky Way's major spiral arm models and maps.
 Most users are interested in simply extracting the trace or overplotting the spiral arms on another plot of interest, for example while comparing substructure in the velocity field to the location of spiral arms. 
 To this end, with `SpiralMap` one can:
 
-+ Access 8 independent spiral arm models from literature. List of the available models is :doc:`here </models_available>`.
++ Access 9 independent spiral arm models from literature. List of the available models is :doc:`here </models_available>`.
 + Extract the trace of individual or all spiral arms from a particular model.
 + Directly overplot spiral arms with choice of Cartesian or Polar coordinates, and in Heliocentric or Galactocentric frames.
 

{spiralmap-0.0.22 → spiralmap-0.16}/docs/source/models_available.rst

@@ -9,6 +9,8 @@ The following table provides a summary of the spiral arm models included in **Sp
 +========================+==============================================+
 | Taylor_Cordes_1992     | Model based on HII regions                   |
 +------------------------+----------------------------------------------+
+| Vallee_1995            | Based on Galactic magnetic field/Dust/stars  |
++------------------------+----------------------------------------------+
 | Drimmel_NIR_2000       | Based on Galactic plane emission in N        |
 +------------------------+----------------------------------------------+
 | Levine_2006            | Based on HI (21 cm) data                     |
@@ -33,6 +35,13 @@ The following table provides a summary of the spiral arm models included in **Sp
 	* We use the model parameters presented in their Table 1.	
 	* There are four arms in this model (Arm1, Arm2, Arm3, Arm4).
 
+`Vallee_1995`
+-----------------
+	* Class implementing the model from `Vallee 1995 <https://ui.adsabs.harvard.edu/abs/1995ApJ...454..119V/abstract>`_ 
+ 	  which is based on Galactic magnetic field data, HI, HII, CO, and Dust. 	  
+	* We use their best model as depicted in their figure 3.	
+	* There are four arms in this model (Sagittarius, Scutum, Norma, Perseus).
+
 `Drimmel_NIR_2000`
 -----------------
 	* Class implementing the model from `Drimmel 2000 <https://iopscience.iop.org/article/10.1086/321556>`_, which is based on Galactic plane emission profiles in the K band using COBE data. 
@@ -50,7 +59,8 @@ The following table provides a summary of the spiral arm models included in **Sp
 	* Class built upon the polynomial-logarithmic formulation introduced by `Hou et al. 2014 <https://ui.adsabs.harvard.edu/abs/2014A%26A...569A.125H/abstract>`_, based on a combination of 
 	  H II, giant molecular clouds, and methanol MASER catalogs. 	
 	* Model publicly available.
-	* There are six arms in this model (Norma, Scutum-Centaurus, Sagittarius-Carina, Perseus, Local, Outer).
+	* There are six arms in this model (Arm1, Arm2, Arm3, Arm4, Arm5, Arm6).
+	* Additionally their local arm is included as a regular logarithmic spiral.
 
 `Reid_2019`
 ---------

{spiralmap-0.0.22 → spiralmap-0.16}/paper/paper.bib

@@ -246,3 +246,19 @@ archivePrefix = {arXiv},
       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
 }
 
+@ARTICLE{khanna2024,
+       author = {{Khanna}, Shourya and {Yu}, Jie and {Drimmel}, Ronald and {Poggio}, Eloisa and {Cantat-Gaudin}, Tristan and {Castro-Ginard}, Alfred and {Kurbatov}, Evgeny and {Belokurov}, Vasily and {Brown}, Anthony and {Fouesneau}, Morgan and {Casey}, Andrew and {Rix}, Hans-Walter},
+        title = "{GaiaUnlimited: The old stellar disc of the Milky Way as traced by the Red Clump}",
+      journal = {arXiv e-prints},
+     keywords = {Astrophysics - Astrophysics of Galaxies},
+         year = 2024,
+        month = oct,
+          eid = {arXiv:2410.22036},
+        pages = {arXiv:2410.22036},
+          doi = {10.48550/arXiv.2410.22036},
+archivePrefix = {arXiv},
+       eprint = {2410.22036},
+ primaryClass = {astro-ph.GA},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2024arXiv241022036K},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}

{spiralmap-0.0.22 → spiralmap-0.16}/paper/paper.md

@@ -55,6 +55,39 @@ a) Documentation: [`readthedocs`](https://spiralmap.readthedocs.io/en/latest/),
 ![Polar projections of multiple models plotted together. We show the `Taylor_Cordes_1992` & `Poggio_2021` models in HC (a) and GC (b) frames, and similarly the tiple models plotted together with a polar grid in the background and similarly, the `Drimmel_NIR_2000` & `Poggio_2021` models in HC (c) and GC (d) frames.\label{multiple_models_polar}](figures/multiple_models_polar.png)
 
 
+# Example Scientific application
+As an example of a science case, we reproduce figures from @khanna2024 (hereafter K24) where `SpiralMap` was used. 
+In particular, K24 constructed a model for the stellar density distribution in Red Clump stars in the Milky Way, and then compared the residuals of their best-fit models
+ with the locations of non-axisymmetric structures such as spiral arms. The figures below show two of their residual plots overlaid with spiral models
+ ( `Drimmel_NIR_2000`, `Drimmel_Ceph_2024`, & `Reid_2019`) using `SpiralMap`.
+
+
+![An example science case where `SpiralMap` can be useful. Here we show two figures reproduced from K24 (with permission), comparing the residuals between a best-fit model and data, and the locations of spiral arm models in the Milky Way. This figure shows the `Drimmel_NIR_2000`, `Drimmel_Ceph_2024`, & `Reid_2019` overplotted together, shown in polar projection.\label{example_science_a}](figures/residuals_polar_3.png)
+
+
+![Same as above, but showing only the `Drimmel_NIR_2000` model.\label{example_science_b}](figures/residuals_polar_0.png)
+
+
+A very basic example of using `SpiralMap` is shown below, where we access all information about one particular arm ( `Sag-Car`) in one particular model `Drimmel_Ceph_2024`,
+
+
+	##################################################
+	##### Readout a single arm from a single model ###
+	##################################################
+	import SpiralMap as sp
+	from SpiralMap import polar_style
+	
+	Rsun=8.277
+	spirals = sp.main_(Rsun=Rsun)	
+	use_model = `Drimmel_Ceph_2024'
+	spirals.getinfo(model=use_model)
+	plotattrs = {`plot':False}
+	spirals.readout(plotattrs,model=use_model,arm=`Sag-Car')    
+	
+	##################################################
+	
+More common examples are shown in the accompanying [`Jupyter notebook`](https://github.com/Abhaypru/SpiralMap/blob/main/demo_spiralmap.ipynb). 
+
 
 # Availability
 

{spiralmap-0.0.22 → spiralmap-0.16}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "SpiralMap"
-version = "0.0.22"
+version = "0.16"  
 authors = [
   { name="Prusty & Khanna", email="shourya.khanna@inaf.it" },
 ]
@@ -18,9 +18,20 @@ classifiers = [
 license = "MIT"
 license-files = ["LICEN[CS]E*"]
 
+# This MUST be inside the [project] section
+dependencies = [
+    "astropy",
+    "matplotlib",
+    "numpy",
+    "scipy",
+    "tabulate",
+    "update-checker",	
+    "pandas",
+]
+
 [project.optional-dependencies]
 docs = ["sphinx","sphinx_rtd_theme", "sphinxcontrib-bibtex"]
 
 [project.urls]
 Homepage = "https://github.com/Abhaypru/SpiralMap"
-Issues = "https://github.com/Abhaypru/SpiralMap/issues"
+Issues = "https://github.com/Abhaypru/SpiralMap/issues"

{spiralmap-0.0.22 → spiralmap-0.16}/src/SpiralMap/models_.py

@@ -2,17 +2,23 @@
 # SpiralMap: a library of the Milky Way's spiral arms
 # History:  	
 # May 2025: Prusty (IISER Kolkata) & Shourya Khanna (INAF Torino)
+# Feb 2026: Following updates:
+			# 1) Missing Local arm (logarithmic) added to Hou-Han 2014 model.
+			# 2) Vallee 1995 model included. 
+			# 3) added dependencies to .toml
 #######################################################################
 
 
 #--------------------------------------------
 # import utilities package / set root 
 import os
+import version 
 from os.path import dirname
+from update_checker import update_check
 root_ = dirname(__file__)
 dataloc = root_+'/datafiles'
 exec(open(root_+"/mytools.py").read())
-
+update_check('spiralmap', version.__version__)	
 #--------------------------------------------       
 
 
@@ -59,6 +65,7 @@ class spiral_poggio_maps(object):
 		func_ = lambda s: 'yval' in s
 		yval_file = list(filter(func_,flist1))[0]
 		
+		
 		# # read overdensity contours
 		xvalues_overdens=np.load(self.loc+'/'+xval_file)
 		yvalues_overdens=np.load(self.loc+'/'+yval_file)
@@ -67,6 +74,8 @@ class spiral_poggio_maps(object):
 		Rvalues_dens=sqrtsum(ds=[xvalues_overdens, yvalues_overdens])
 		Rgcvalues_dens=sqrtsum(ds=[xvalues_overdens+xsun, yvalues_overdens])
 		
+		self.over_dens_grid = over_dens_grid
+		
 		fl = pickleread(self.loc+'/'+self.model_+'_pproj_contours.pkl')
 		self.dout = {'xhc':xvalues_overdens,'yhc':yvalues_overdens,'xgc':xvalues_overdens+xsun,'ygc':yvalues_overdens}
 		self.dout['phi4'] =fl['phi4'].copy()	
@@ -105,6 +114,177 @@ class spiral_poggio_maps(object):
 			plotattrs['linestyle'] = '.'
 			_polarproj(self,plotattrs)	
 				
+
+class spiral_vallee(object):
+	"""	
+	Vallee et al (1995) logarithmic spiral arm model for the Milky Way.
+	Based on multi-tracer analysis including magnetic fields, dust, gas, and stars.
+	"""	
+
+	def __init__(self):   
+		self.getarmlist()		
+	
+	def getarmlist(self):	
+		"""Set arm names """					
+		self.arms = np.array(['Sagittarius', 'Scutum', '3-kpc', 'Perseus'])
+		self.armcolour = {
+			'Sagittarius': 'red', # red
+			'Perseus': 'orange',  # orange
+			'Scutum': 'purple', # 
+			'3-kpc': 'green' # brown
+		}
+				
+		self.getparams()
+		self.armcolours = [self.armcolour[ky] for ky in self.arms]
+		
+	def info(self):
+		d = {'Arm list': self.arms, 'Colour': self.armcolours}
+		dfmodlist = pd.DataFrame(d)			
+		print(tabulate(dfmodlist, headers='keys', tablefmt='psql'))
+	
+	def getparams(self):
+		"""		
+		Return parameters for each arm.
+		
+		Parameters from Vallee 1995:
+		- Pitch angle: 12° ± 1° (inward, absolute value used here)
+		- Number of arms: 4
+		- Arm start radius: 2.5 kpc
+		- Solar position: 8 kpc from Galactic center
+		- Arm separation: ~3 kpc near Sun
+		
+		Note: phi0 is set to produce 4 equally spaced arms starting at 2.5 kpc
+		"""
+		
+		self.arms_model = {
+			'Scutum': {'pitch': 12.5, 'phi0': 0, 'r0': 2.5},
+			'3-kpc': {'pitch': 12.5, 'phi0': 90, 'r0': 2.5},
+			'Perseus': {'pitch': 12.5, 'phi0': 180, 'r0': 2.5},
+			'Sagittarius': {'pitch': 12.5, 'phi0': 270, 'r0': 2.5}
+		}
+	 
+	def model_(self, arm_name, R_max=13, n_points=1000):
+		"""Generate logarithmic spiral coordinates for specified arm.
+		
+		Parameters
+		----------
+		arm_name : str
+			Name of arm to model
+		R_max : float, optional
+			Maximum galactocentric radius to model (kpc), default=13
+			(Vallee 1995 limits to r_gal < 13 kpc)
+		n_points : int, optional
+			Number of points to sample along the spiral, default=1000
+	
+		Returns
+		-------
+		tuple
+			(x_hc, y_hc, x_gc, y_gc) coordinate arrays where:
+			- x_hc, y_hc: Heliocentric coordinates (kpc)
+			- x_gc, y_gc: Galactocentric coordinates (kpc)
+	
+		Model limited to 3 kpc < r_gal < 13 kpc per Vallee 1995 constraints
+		"""
+		self.R0 = -self.xsun  # 8.0 kpc
+		params = self.arms_model[arm_name]
+		pitch_rad = np.radians(params['pitch'])
+		phi0_rad = np.radians(params['phi0'])
+		r0 = params['r0']
+		
+		# Calculate maximum phi to reach R_max, starting from r0
+		phi_max = phi0_rad + (np.log(R_max/r0) / np.tan(pitch_rad))
+		
+		# Generate angular range starting from phi0
+		phi = np.linspace(phi0_rad, phi_max, n_points)
+		
+		# Logarithmic spiral equation (Vallee 1995 eq. 5a)
+		R = r0 * np.exp((phi - phi0_rad) * np.tan(pitch_rad))
+		
+		# Apply Vallee 1995 constraints: exclude r_gal < 3 kpc
+		mask = R >= 3.0
+		R = R[mask]
+		phi = phi[mask]
+		
+		# Convert to Cartesian coordinates (Galactocentric)
+		x_gc = R * np.cos(phi)
+		y_gc = R * np.sin(phi)
+
+		# Convert to Heliocentric coordinates (Sun at x=8, y=0 in galactocentric)
+		# In heliocentric: x_hc = x_gc - (-8) = x_gc + 8, y_hc = y_gc - 0 = y_gc
+		x_hc = x_gc + self.R0  
+		y_hc = y_gc  # Sun at y=0 in galactocentric, so y_hc = y_gc
+	
+		return x_hc, y_hc, x_gc, y_gc
+		
+	def output_(self, arm):		
+		"""Get arm coordinates
+		
+		Parameters
+		----------
+		arm : str
+			Arm identifier (e.g., 'Sagittarius')
+		
+		Returns
+		-------
+		dict
+			Dictionary with keys:
+			- 'xhc': Heliocentric x coordinates
+			- 'yhc': Heliocentric y coordinates
+			- 'xgc': Galactocentric x coordinates
+			- 'ygc': Galactocentric y coordinates
+		"""		
+		
+		xhc, yhc, xgc, ygc = self.model_(arm)   
+		self.dout = {
+			'xhc': xhc,
+			'yhc': yhc,
+			'xgc': xgc,
+			'ygc': ygc
+		
+		}
+		return self.dout
+
+	def df_plot(self, coord='GC', R_max=13):
+		rows = []
+
+		for arm in self.arms:
+			x_hc, y_hc, x_gc, y_gc = self.model_(arm, R_max)
+
+			if coord.upper() == 'GC':
+				x, y = x_gc, y_gc
+			else:
+				x, y = x_hc, y_hc
+
+			for xi, yi in zip(x, y):
+				rows.append([arm, xi, yi])
+
+		return pd.DataFrame(rows, columns=['arm', 'x', 'y'])
+
+	def plot(self, coord='GC', R_max=13):
+		df = self.df_plot(coord, R_max)
+
+		plt.figure(figsize=(6, 6))
+
+		for arm in self.arms:
+			d = df[df['arm'] == arm]
+			plt.plot(d['x'], d['y'], color=self.armcolour[arm], label=arm)
+
+		if coord.upper() == 'GC':
+			plt.plot(0, 0, 'r*', ms=12, label='GC')
+			plt.plot(-self.R0, 0, 'o', color='orange', label='Sun')
+			plt.xlabel('X_gc [kpc]')
+			plt.ylabel('Y_gc [kpc]')
+		else:
+			plt.plot(0, 0, 'o', color='orange', label='Sun')
+			plt.xlabel('X_hc [kpc]')
+			plt.ylabel('Y_hc [kpc]')
+
+		plt.axhline(0, ls='--', lw=0.5)
+		plt.axvline(0, ls='--', lw=0.5)
+		plt.axis('equal')
+		plt.legend()
+		plt.tight_layout()
+		plt.show()
 			
 class TaylorCordesSpiral(object):		
 	"""	
@@ -203,13 +383,15 @@ class spiral_houhan(object):
 	Implements the Milky Way spiral structure model from:
 	"The spiral structure of the Milky Way from classical Cepheids" (Hou & Han 2014)
 	using polynomial-logarithmic spiral functions. Provides 6 major arm segments.	
+	Additionally, the local arm is implemented as a logarithmic spiral.
 	"""	
 	def __init__(self):			
 		self.getarmlist()	
 	def getarmlist(self):
-		"""Set arm names and colours"""
-		self.arms = np.array(['Norma','Scutum-Centaurus','Sagittarius-Carina','Perseus','Local','Outer'])
-		self.armcolour = {'Norma':'black','Scutum-Centaurus':'red','Sagittarius-Carina':'green','Perseus':'blue','Local':'purple','Outer':'gold'}
+		"""Set arm names and colours"""		
+		self.arms = np.array(['Arm1','Arm2','Arm3','Arm4','Arm5','Arm6','local'])
+		self.armcolour = {'Arm1':'black','Arm2':'red','Arm3':'green','Arm4':'blue','Arm5':'purple','Arm6':'gold','local':'cyan'}
+		
 		self.armcolours= [self.armcolour[ky]  for ky in self.arms  ]	
 	def info(self):		
 		d = {'Arm list': self.arms, 'Colour': self.armcolours}
@@ -218,25 +400,30 @@ class spiral_houhan(object):
 		
 	def getparams(self):						
 		"""			
-		   Load spiral parameters from Hou & Han (2014) Table 4 (vcirc=239, Z =0.16), all tracers.
-		   
+		   Load spiral parameters from Hou & Han (2014) Table 4 (vcirc=239, Z =0.17), all tracers.
+		   		   
 		   :return: params ( Nested dictionary containing for each arm).
 		   
 	   				a, b, c, d: Polynomial coefficients.
 	   				
 					θ_start: Start angle in degrees (Galactic longitude).
 					
-					θ_end: End angle in degrees.		   		   
+					θ_end: End angle in degrees.		
+					
+					ri,thetai,psi,ymin,ymax: logarithmic spiral (local arm only)   		   
 		   :rtype: dict 
 		"""			
 		params = {
-			'Norma': {'a': 1.1320, 'b': 0.1233, 'c': 0.003488, 'd': 0.0, 'θ_start': 40, 'θ_end': 250},
-			'Scutum-Centaurus': {'a': 5.8243, 'b': -1.8196, 'c': 0.2350, 'd': -0.009011, 'θ_start': 275, 'θ_end': 620},
-			'Sagittarius-Carina': {'a': 4.2767, 'b': -1.1507, 'c': 0.1570, 'd': -0.006078, 'θ_start': 275, 'θ_end': 575},
-			'Perseus': {'a': 1.1280, 'b': 0.1282, 'c': 0.002617, 'd': 0.0, 'θ_start': 280, 'θ_end': 500},
-			'Local': {'a': 1.7978, 'b': -0.04738, 'c': 0.01684, 'd': 0.0, 'θ_start': 280, 'θ_end': 500},
-			'Outer': {'a': 2.4225, 'b': -0.1636, 'c': 0.02494, 'd': 0.0, 'θ_start': 280, 'θ_end': 405}
+			'Arm1': {'a': 1.1320, 'b': 0.1233, 'c': 0.003488, 'd': 0.0, 'θ_start': 40, 'θ_end': 250},
+			'Arm2': {'a': 5.8243, 'b': -1.8196, 'c': 0.2350, 'd': -0.009011, 'θ_start': 275, 'θ_end': 620},
+			'Arm3': {'a': 4.2767, 'b': -1.1507, 'c': 0.1570, 'd': -0.006078, 'θ_start': 275, 'θ_end': 575},
+			'Arm4': {'a': 1.1280, 'b': 0.1282, 'c': 0.002617, 'd': 0.0, 'θ_start': 280, 'θ_end': 500},
+			'Arm5': {'a': 1.7978, 'b': -0.04738, 'c': 0.01684, 'd': 0.0, 'θ_start': 280, 'θ_end': 500},
+			'Arm6': {'a': 2.4225, 'b': -0.1636, 'c': 0.02494, 'd': 0.0, 'θ_start': 280, 'θ_end': 405},			
+			'local': {'ri': 8.17, 'thetai': 57.8, 'psi':2.84,'ymin':-4.,'ymax':7.5}			
 		}	
+		
+		
 		return params		
 	def polynomial_log_spiral(self, θ, a, b, c, d):		
 		"""Calculate radius using polynomial-logarithmic spiral equation.
@@ -264,19 +451,31 @@ class spiral_houhan(object):
 	def model_(self, arm_name, n_points=500):
 		
 		params_ = self.getparams()
-		params = params_[arm_name]
-		
-		
-		θ = np.linspace(params['θ_start'], params['θ_end'], n_points)
-		R = self.polynomial_log_spiral(θ, params['a'], params['b'], params['c'], params['d'])
-				
+		params = params_[arm_name]	
+		
+		if arm_name == 'local':
+			θ = np.linspace(0., 180., n_points)
+			tmp1 = np.radians(θ - params['thetai'])
+			tmp2 = np.tan(np.radians(params['psi']))
+			R = params['ri']*np.exp( tmp1*tmp2 )
+		else:						
+			θ = np.linspace(params['θ_start'], params['θ_end'], n_points)
+			R = self.polynomial_log_spiral(θ, params['a'], params['b'], params['c'], params['d'])
+					
 		# Convert to Cartesian coordinates (Galactocentric)
 		y_gc = R*np.cos(np.radians(θ))
 		x_gc = -R * np.sin(np.radians(θ))
 		
 		# Convert to Heliocentric coordinates
 		x_hc = (x_gc + self.R0)
-	
+		
+		if arm_name == 'local':
+			ind_mask = np.where((y_gc < params['ymin'])|(y_gc > params['ymax']))[0]
+			y_gc[ind_mask] = np.nan	
+			x_gc[ind_mask] = np.nan	
+			x_hc[ind_mask] = np.nan	
+			
+			
 		return x_hc, y_gc, x_gc, y_gc
 	
 	def output_(self, arm):			
@@ -311,9 +510,9 @@ class spiral_houhan_HII(object):
 	def __init__(self):			
 		self.getarmlist()	
 	def getarmlist(self):
-		"""Set arm names and colours"""
-		self.arms = np.array(['Norma','Scutum-Centaurus','Sagittarius-Carina','Perseus','Local','Outer'])
-		self.armcolour = {'Norma':'black','Scutum-Centaurus':'red','Sagittarius-Carina':'green','Perseus':'blue','Local':'purple','Outer':'gold'}
+		"""Set arm names and colours"""		
+		self.arms = np.array(['Arm1','Arm2','Arm3','Arm4','Arm5','Arm6'])
+		self.armcolour = {'Arm1':'black','Arm2':'red','Arm3':'green','Arm4':'blue','Arm5':'purple','Arm6':'gold'}					
 		self.armcolours= [self.armcolour[ky]  for ky in self.arms  ]	
 	def info(self):		
 		d = {'Arm list': self.arms, 'Colour': self.armcolours}
@@ -335,12 +534,12 @@ class spiral_houhan_HII(object):
 		"""			
 
 		params = {
-			'Norma': {'a': 1.1668, 'b': 0.1198, 'c': 0.002557, 'd': 0.0, 'θ_start': 40, 'θ_end': 250},
-			'Scutum-Centaurus': {'a': 5.8002, 'b': -1.8188, 'c': 0.2352, 'd': -0.008999, 'θ_start': 275, 'θ_end': 620},
-			'Sagittarius-Carina': {'a': 4.2300, 'b': -1.1505, 'c': 0.1561, 'd': -0.005898, 'θ_start': 275, 'θ_end': 570},
-			'Perseus': {'a': 0.9744, 'b': 0.1405, 'c': 0.003995, 'd': 0.0, 'θ_start': 280, 'θ_end': 500},
-			'Local': {'a': 0.9887, 'b': 0.1714, 'c': 0.004358, 'd': 0.0, 'θ_start': 280, 'θ_end': 475},
-			'Outer': {'a': 3.3846, 'b': -0.6554, 'c': 0.08170, 'd': 0.0, 'θ_start': 280, 'θ_end': 355}
+			'Arm1': {'a': 1.1668, 'b': 0.1198, 'c': 0.002557, 'd': 0.0, 'θ_start': 40, 'θ_end': 250},
+			'Arm2': {'a': 5.8002, 'b': -1.8188, 'c': 0.2352, 'd': -0.008999, 'θ_start': 275, 'θ_end': 620},
+			'Arm3': {'a': 4.2300, 'b': -1.1505, 'c': 0.1561, 'd': -0.005898, 'θ_start': 275, 'θ_end': 570},
+			'Arm4': {'a': 0.9744, 'b': 0.1405, 'c': 0.003995, 'd': 0.0, 'θ_start': 280, 'θ_end': 500},
+			'Arm5': {'a': 0.9887, 'b': 0.1714, 'c': 0.004358, 'd': 0.0, 'θ_start': 280, 'θ_end': 475},
+			'Arm6': {'a': 3.3846, 'b': -0.6554, 'c': 0.08170, 'd': 0.0, 'θ_start': 280, 'θ_end': 355}
 		}	
 
 		return params		
@@ -925,7 +1124,7 @@ class main_(object):
 		   	Constructs dictionaries to initialise individual model classes
 		"""	
 		   		
-		self.models = ['Taylor_Cordes_1992','Drimmel_NIR_2000',
+		self.models = ['Taylor_Cordes_1992','Vallee_1995','Drimmel_NIR_2000',
 					   'Levine_2006','Hou_Han_2014','Hou_Han_HII_2014','Reid_2019',
 					   'Poggio_cont_2021','GaiaPVP_cont_2022','Drimmel_Ceph_2024']        
 		self.models_class = {'Reid_2019':reid_spiral(),
@@ -936,9 +1135,10 @@ class main_(object):
 							 'Taylor_Cordes_1992':TaylorCordesSpiral(),
 							 'Hou_Han_2014':spiral_houhan(),
 							 'Hou_Han_HII_2014':spiral_houhan_HII(),
+							 'Vallee_1995':spiral_vallee(),
 							 'Drimmel_Ceph_2024':spiral_drimmel_cepheids()}
 							 
-		self.models_desc = 	['HII','NIR emission',
+		self.models_desc = 	['HII','Bfield/Dust/gas','NIR emission',
 					   'HI','HII/GMC/Masers','HII','MASER parallax',
 					   'Upper main sequence (map)','OB stars (map)','Cepheids']  			 							 
 	def getinfo(self,model='',print_=True):	
@@ -997,11 +1197,11 @@ class main_(object):
 		if plotattrs_['plot'] and plotattrs_['polarproj']==False :							
 			plt.plot(spimod.dout['x'+plotattrs_['coordsys'].lower()],
 			         spimod.dout['y'+plotattrs_['coordsys'].lower()],
-			         plotattrs_['linestyle'],color=plotattrs_['armcolour'])			
+			         plotattrs_['linestyle'],linewidth=plotattrs_['linewidth'],color=plotattrs_['armcolour'])			
 			if 'xhc_ex' in 	spimod.dout.keys():
 				plt.plot(spimod.dout['x'+plotattrs_['coordsys'].lower()+'_ex'],
 				         spimod.dout['y'+plotattrs_['coordsys'].lower()+'_ex'],
-				         '--',color=plotattrs_['armcolour'])	
+				         '--',linewidth=plotattrs_['linewidth'],color=plotattrs_['armcolour'])	
 				                							
 			plt.xlabel('X$_{'+plotattrs_['coordsys']+'}$ [Kpc]')
 			plt.ylabel('Y$_{'+plotattrs_['coordsys']+'}$ [Kpc]')	 
@@ -1234,4 +1434,4 @@ class _make_supportfiles(object):
 	
 
 
-# # _make_supportfiles()
+# _make_supportfiles()

{spiralmap-0.0.22 → spiralmap-0.16}/src/SpiralMap/mytools.py

@@ -221,3 +221,4 @@ def polar_style(ax,title='',rticks=[3., 6.,9.,12,15.,20.]):
 
 
 
+