SpiralMap 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

SpiralMap/datafiles/spiral.bib

@@ -1,39 +1,73 @@
-@ARTICLE{Drimmel:2024,
-       author = {{Drimmel}, Ronald and {Khanna}, Shourya and {Poggio}, Eloisa and {Skowron}, Dorota M.},
-        title = "{The Milky Way as Seen by Classical Cepheids II: Spiral Structure}",
-      journal = {arXiv e-prints},
-     keywords = {Astrophysics - Astrophysics of Galaxies},
-         year = 2024,
+@ARTICLE{Taylor_Cordes_1992,
+       author = {{Taylor}, J.~H. and {Cordes}, J.~M.},
+        title = "{Pulsar Distances and the Galactic Distribution of Free Electrons}",
+      journal = {\apj},
+     keywords = {Astrometry, Electron Density (Concentration), Free Electrons, Galactic Structure, H Ii Regions, Pulsars, Astronomical Models, Extragalactic Radio Sources, Interstellar Matter, Milky Way Galaxy, Astrophysics, GALAXY: STRUCTURE, ISM: GENERAL, STARS: PULSARS: GENERAL, STARS: DISTANCES},
+         year = 1993,
+        month = jul,
+       volume = {411},
+        pages = {674},
+          doi = {10.1086/172870},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/1993ApJ...411..674T},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}
+
+@ARTICLE{Drimmel_NIR_2000,
+       author = {{Drimmel}, R.},
+        title = "{Evidence for a two-armed spiral in the Milky Way}",
+      journal = {\aap},
+     keywords = {GALAXY: STRUCTURE, INFRARED: GALAXIES, Astrophysics},
+         year = 2000,
         month = jun,
-          eid = {arXiv:2406.09127},
-        pages = {arXiv:2406.09127},
-          doi = {10.48550/arXiv.2406.09127},
+       volume = {358},
+        pages = {L13-L16},
+          doi = {10.48550/arXiv.astro-ph/0005241},
 archivePrefix = {arXiv},
-       eprint = {2406.09127},
- primaryClass = {astro-ph.GA},
-       adsurl = {https://ui.adsabs.harvard.edu/abs/2024arXiv240609127D},
+       eprint = {astro-ph/0005241},
+ primaryClass = {astro-ph},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2000A&A...358L..13D},
       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
 }
 
-#
-
-@ARTICLE{Skowron:2024,
-       author = {{Skowron}, Dorota M. and {Drimmel}, Ronald and {Khanna}, Shourya and {Spagna}, Alessandro and {Poggio}, Eloisa and {Ramos}, Pau},
-        title = "{The Milky Way as seen by Classical Cepheids I: distances based on mid-infrared photometry}",
-      journal = {arXiv e-prints},
-     keywords = {Astrophysics - Astrophysics of Galaxies, Astrophysics - Solar and Stellar Astrophysics},
-         year = 2024,
+@ARTICLE{Levine_2006,
+       author = {{Levine}, E.~S. and {Blitz}, Leo and {Heiles}, Carl},
+        title = "{The Spiral Structure of the Outer Milky Way in Hydrogen}",
+      journal = {Science},
+     keywords = {ASTRONOMY, Astrophysics},
+         year = 2006,
         month = jun,
-          eid = {arXiv:2406.09113},
-        pages = {arXiv:2406.09113},
-          doi = {10.48550/arXiv.2406.09113},
+       volume = {312},
+       number = {5781},
+        pages = {1773-1777},
+          doi = {10.1126/science.1128455},
 archivePrefix = {arXiv},
-       eprint = {2406.09113},
+       eprint = {astro-ph/0605728},
+ primaryClass = {astro-ph},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2006Sci...312.1773L},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+} 
+ 
+
+
+@ARTICLE{Hou:2014,
+       author = {{Hou}, L.~G. and {Han}, J.~L.},
+        title = "{The observed spiral structure of the Milky Way}",
+      journal = {\aap},
+     keywords = {Galaxy: disk, Galaxy: structure, Galaxy: kinematics and dynamics, HII regions, ISM: clouds, Astrophysics - Astrophysics of Galaxies},
+         year = 2014,
+        month = sep,
+       volume = {569},
+          eid = {A125},
+        pages = {A125},
+          doi = {10.1051/0004-6361/201424039},
+archivePrefix = {arXiv},
+       eprint = {1407.7331},
  primaryClass = {astro-ph.GA},
-       adsurl = {https://ui.adsabs.harvard.edu/abs/2024arXiv240609113S},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2014A&A...569A.125H},
       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
 }
 
+
 @ARTICLE{Reid:2019,
        author = {{Reid}, M.~J. and {Menten}, K.~M. and {Brunthaler}, A. and {Zheng}, X.~W. and {Dame}, T.~M. and {Xu}, Y. and {Li}, J. and {Sakai}, N. and {Wu}, Y. and {Immer}, K. and {Zhang}, B. and {Sanna}, A. and {Moscadelli}, L. and {Rygl}, K.~L.~J. and {Bartkiewicz}, A. and {Hu}, B. and {Quiroga-Nu{\~n}ez}, L.~H. and {van Langevelde}, H.~J.},
         title = "{Trigonometric Parallaxes of High-mass Star-forming Regions: Our View of the Milky Way}",
@@ -53,7 +87,8 @@ archivePrefix = {arXiv},
       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
 }
 
-@ARTICLE{Poggio:2021,
+
+@ARTICLE{Poggio_2021,
        author = {{Poggio}, E. and {Drimmel}, R. and {Cantat-Gaudin}, T. and {Ramos}, P. and {Ripepi}, V. and {Zari}, E. and {Andrae}, R. and {Blomme}, R. and {Chemin}, L. and {Clementini}, G. and {Figueras}, F. and {Fouesneau}, M. and {Fr{\'e}mat}, Y. and {Lobel}, A. and {Marshall}, D.~J. and {Muraveva}, T. and {Romero-G{\'o}mez}, M.},
         title = "{Galactic spiral structure revealed by Gaia EDR3}",
       journal = {\aap},
@@ -71,66 +106,34 @@ archivePrefix = {arXiv},
       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
 }
 
-@ARTICLE{Levine:2006,
-       author = {{Levine}, E.~S. and {Blitz}, Leo and {Heiles}, Carl},
-        title = "{The Spiral Structure of the Outer Milky Way in Hydrogen}",
-      journal = {Science},
-     keywords = {ASTRONOMY, Astrophysics},
-         year = 2006,
-        month = jun,
-       volume = {312},
-       number = {5781},
-        pages = {1773-1777},
-          doi = {10.1126/science.1128455},
-archivePrefix = {arXiv},
-       eprint = {astro-ph/0605728},
- primaryClass = {astro-ph},
-       adsurl = {https://ui.adsabs.harvard.edu/abs/2006Sci...312.1773L},
-      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
-}
 
-@ARTICLE{Hou:2009,
-       author = {{Hou}, L.~G. and {Han}, J.~L. and {Shi}, W.~B.},
-        title = "{The spiral structure of our Milky Way Galaxy}",
-      journal = {\aap},
-     keywords = {Galaxy: structure, Galaxy: kinematics and dynamics, ISM: HII regions, Astrophysics - Astrophysics of Galaxies},
-         year = 2009,
-        month = may,
-       volume = {499},
-       number = {2},
-        pages = {473-482},
-          doi = {10.1051/0004-6361/200809692},
+@ARTICLE{Drimmel_Ceph_2024,
+       author = {{Drimmel}, Ronald and {Khanna}, Shourya and {Poggio}, Eloisa and {Skowron}, Dorota M.},
+        title = "{The Milky Way as Seen by Classical Cepheids II: Spiral Structure}",
+     journal = {arXiv e-prints},
+     keywords = {Astrophysics - Astrophysics of Galaxies},
+         year = 2024,
+        month = jun,
+          eid = {arXiv:2406.09127},
+        pages = {arXiv:2406.09127},
+          doi = {10.48550/arXiv.2406.09127},
 archivePrefix = {arXiv},
-       eprint = {0903.0721},
+       eprint = {2406.09127},
  primaryClass = {astro-ph.GA},
-       adsurl = {https://ui.adsabs.harvard.edu/abs/2009A&A...499..473H},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2024arXiv240609127D},
       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
-}
+}	
 
-@ARTICLE{Georgelin:1976,
-       author = {{Georgelin}, Y.~M. and {Georgelin}, Y.~P.},
-        title = "{The spiral structure of our Galaxy determined from H II regions.}",
-      journal = {\aap},
-     keywords = {Astronomical Models, Galactic Rotation, Galactic Structure, H Alpha Line, H Ii Regions, Milky Way Galaxy, Astronomical Maps, Hydrogen Ions, Kinematics, Radial Velocity, Radio Astronomy, Tables (Data), Visual Observation, Astrophysics},
-         year = 1976,
-        month = may,
-       volume = {49},
-        pages = {57-79},
-       adsurl = {https://ui.adsabs.harvard.edu/abs/1976A&A....49...57G},
-      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
-}
 
-@ARTICLE{Taylor:1993,
-       author = {{Taylor}, J.~H. and {Cordes}, J.~M.},
-        title = "{Pulsar Distances and the Galactic Distribution of Free Electrons}",
-      journal = {\apj},
-     keywords = {Astrometry, Electron Density (Concentration), Free Electrons, Galactic Structure, H Ii Regions, Pulsars, Astronomical Models, Extragalactic Radio Sources, Interstellar Matter, Milky Way Galaxy, Astrophysics, GALAXY: STRUCTURE, ISM: GENERAL, STARS: PULSARS: GENERAL, STARS: DISTANCES},
-         year = 1993,
-        month = jul,
-       volume = {411},
-        pages = {674},
-          doi = {10.1086/172870},
-       adsurl = {https://ui.adsabs.harvard.edu/abs/1993ApJ...411..674T},
-      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
-}
 
+@article{Gaia_2022,
+   title={Gaia Data Release 3: Mapping the asymmetric disc of the Milky Way},
+   volume={674},
+   ISSN={1432-0746},
+   url={http://dx.doi.org/10.1051/0004-6361/202243797},
+   DOI={10.1051/0004-6361/202243797},
+   journal={Astronomy & Astrophysics},
+   publisher={EDP Sciences},
+   author={Drimmel, R. and Romero-Gómez, M. and Chemin, L. and Ramos, P. and Poggio, E. and Ripepi, V. and Andrae, R. and Blomme, R. and Cantat-Gaudin, T. and Castro-Ginard, A. and Clementini, G. and Figueras, F. and Fouesneau, M. and Frémat, Y. and Jardine, K. and Khanna, S. and Lobel, A. and Marshall, D. J. and Muraveva, T. and Brown, A. G. A. and Vallenari, A. and Prusti, T. and de Bruijne, J. H. J. and Arenou, F. and Babusiaux, C. and Biermann, M. and Creevey, O. L. and Ducourant, C. and Evans, D. W. and Eyer, L. and Guerra, R. and Hutton, A. and Jordi, C. and Klioner, S. A. and Lammers, U. L. and Lindegren, L. and Luri, X. and Mignard, F. and Panem, C. and Pourbaix, D. and Randich, S. and Sartoretti, P. and Soubiran, C. and Tanga, P. and Walton, N. A. and Bailer-Jones, C. A. L. and Bastian, U. and Jansen, F. and Katz, D. and Lattanzi, M. G. and van Leeuwen, F. and Bakker, J. and Cacciari, C. and Castañeda, J. and De Angeli, F. and Fabricius, C. and Galluccio, L. and Guerrier, A. and Heiter, U. and Masana, E. and Messineo, R. and Mowlavi, N. and Nicolas, C. and Nienartowicz, K. and Pailler, F. and Panuzzo, P. and Riclet, F. and Roux, W. and Seabroke, G. M. and Sordo, R. and Thévenin, F. and Gracia-Abril, G. and Portell, J. and Teyssier, D. and Altmann, M. and Audard, M. and Bellas-Velidis, I. and Benson, K. and Berthier, J. and Burgess, P. W. and Busonero, D. and Busso, G. and Cánovas, H. and Carry, B. and Cellino, A. and Cheek, N. and Damerdji, Y. and Davidson, M. and de Teodoro, P. and Nuñez Campos, M. and Delchambre, L. and Dell’Oro, A. and Esquej, P. and Fernández-Hernández, J. and Fraile, E. and Garabato, D. and García-Lario, P. and Gosset, E. and Haigron, R. and Halbwachs, J.-L. and Hambly, N. C. and Harrison, D. L. and Hernández, J. and Hestroffer, D. and Hodgkin, S. T. and Holl, B. and Janßen, K. and Jevardat de Fombelle, G. and Jordan, S. and Krone-Martins, A. and Lanzafame, A. C. and Löffler, W. and Marchal, O. and Marrese, P. M. and Moitinho, A. and Muinonen, K. and Osborne, P. and Pancino, E. and Pauwels, T. and Recio-Blanco, A. and Reylé, C. and Riello, M. and Rimoldini, L. and Roegiers, T. and Rybizki, J. and Sarro, L. M. and Siopis, C. and Smith, M. and Sozzetti, A. and Utrilla, E. and van Leeuwen, M. and Abbas, U. and Ábrahám, P. and Abreu Aramburu, A. and Aerts, C. and Aguado, J. J. and Ajaj, M. and Aldea-Montero, F. and Altavilla, G. and Álvarez, M. A. and Alves, J. and Anders, F. and Anderson, R. I. and Anglada Varela, E. and Antoja, T. and Baines, D. and Baker, S. G. and Balaguer-Núñez, L. and Balbinot, E. and Balog, Z. and Barache, C. and Barbato, D. and Barros, M. and Barstow, M. A. and Bartolomé, S. and Bassilana, J.-L. and Bauchet, N. and Becciani, U. and Bellazzini, M. and Berihuete, A. and Bernet, M. and Bertone, S. and Bianchi, L. and Binnenfeld, A. and Blanco-Cuaresma, S. and Boch, T. and Bombrun, A. and Bossini, D. and Bouquillon, S. and Bragaglia, A. and Bramante, L. and Breedt, E. and Bressan, A. and Brouillet, N. and Brugaletta, E. and Bucciarelli, B. and Burlacu, A. and Butkevich, A. G. and Buzzi, R. and Caffau, E. and Cancelliere, R. and Carballo, R. and Carlucci, T. and Carnerero, M. I. and Carrasco, J. M. and Casamiquela, L. and Castellani, M. and Chaoul, L. and Charlot, P. and Chiaramida, V. and Chiavassa, A. and Chornay, N. and Comoretto, G. and Contursi, G. and Cooper, W. J. and Cornez, T. and Cowell, S. and Crifo, F. and Cropper, M. and Crosta, M. and Crowley, C. and Dafonte, C. and Dapergolas, A. and David, P. and de Laverny, P. and De Luise, F. and De March, R. and De Ridder, J. and de Souza, R. and de Torres, A. and del Peloso, E. F. and del Pozo, E. and Delbo, M. and Delgado, A. and Delisle, J.-B. and Demouchy, C. and Dharmawardena, T. E. and Di Matteo, P. and Diakite, S. and Diener, C. and Distefano, E. and Dolding, C. and Enke, H. and Fabre, C. and Fabrizio, M. and Faigler, S. and Fedorets, G. and Fernique, P. and Fournier, Y. and Fouron, C. and Fragkoudi, F. and Gai, M. and Garcia-Gutierrez, A. and Garcia-Reinaldos, M. and García-Torres, M. and Garofalo, A. and Gavel, A. and Gavras, P. and Gerlach, E. and Geyer, R. and Giacobbe, P. and Gilmore, G. and Girona, S. and Giuffrida, G. and Gomel, R. and Gomez, A. and González-Núñez, J. and González-Santamaría, I. and González-Vidal, J. J. and Granvik, M. and Guillout, P. and Guiraud, J. and Gutiérrez-Sánchez, R. and Guy, L. P. and Hatzidimitriou, D. and Hauser, M. and Haywood, M. and Helmer, A. and Helmi, A. and Sarmiento, M. H. and Hidalgo, S. L. and Hładczuk, N. and Hobbs, D. and Holland, G. and Huckle, H. E. and Jasniewicz, G. and Jean-Antoine Piccolo, A. and Jiménez-Arranz, Ó. and Juaristi Campillo, J. and Julbe, F. and Karbevska, L. and Kervella, P. and Kordopatis, G. and Korn, A. J. and Kóspál, Á and Kostrzewa-Rutkowska, Z. and Kruszyńska, K. and Kun, M. and Laizeau, P. and Lambert, S. and Lanza, A. F. and Lasne, Y. and Le Campion, J.-F. and Lebreton, Y. and Lebzelter, T. and Leccia, S. and Leclerc, N. and Lecoeur-Taibi, I. and Liao, S. and Licata, E. L. and Lindstrøm, H. E. P. and Lister, T. A. and Livanou, E. and Lorca, A. and Loup, C. and Madrero Pardo, P. and Magdaleno Romeo, A. and Managau, S. and Mann, R. G. and Manteiga, M. and Marchant, J. M. and Marconi, M. and Marcos, J. and Marcos Santos, M. M. S. and Marín Pina, D. and Marinoni, S. and Marocco, F. and Martin Polo, L. and Martín-Fleitas, J. M. and Marton, G. and Mary, N. and Masip, A. and Massari, D. and Mastrobuono-Battisti, A. and Mazeh, T. and McMillan, P. J. and Messina, S. and Michalik, D. and Millar, N. R. and Mints, A. and Molina, D. and Molinaro, R. and Molnár, L. and Monari, G. and Monguió, M. and Montegriffo, P. and Montero, A. and Mor, R. and Mora, A. and Morbidelli, R. and Morel, T. and Morris, D. and Murphy, C. P. and Musella, I. and Nagy, Z. and Noval, L. and Ocaña, F. and Ogden, A. and Ordenovic, C. and Osinde, J. O. and Pagani, C. and Pagano, I. and Palaversa, L. and Palicio, P. A. and Pallas-Quintela, L. and Panahi, A. and Payne-Wardenaar, S. and Peñalosa Esteller, X. and Penttilä, A. and Pichon, B. and Piersimoni, A. M. and Pineau, F.-X. and Plachy, E. and Plum, G. and Prša, A. and Pulone, L. and Racero, E. and Ragaini, S. and Rainer, M. and Raiteri, C. M. and Ramos-Lerate, M. and Re Fiorentin, P. and Regibo, S. and Richards, P. J. and Rios Diaz, C. and Riva, A. and Rix, H.-W. and Rixon, G. and Robichon, N. and Robin, A. C. and Robin, C. and Roelens, M. and Rogues, H. R. O. and Rohrbasser, L. and Rowell, N. and Royer, F. and Ruz Mieres, D. and Rybicki, K. A. and Sadowski, G. and Sáez Núñez, A. and Sagristà Sellés, A. and Sahlmann, J. and Salguero, E. and Samaras, N. and Sanchez Gimenez, V. and Sanna, N. and Santoveña, R. and Sarasso, M. and Schultheis, M. S. and Sciacca, E. and Segol, M. and Segovia, J. C. and Ségransan, D. and Semeux, D. and Shahaf, S. and Siddiqui, H. I. and Siebert, A. and Siltala, L. and Silvelo, A. and Slezak, E. and Slezak, I. and Smart, R. L. and Snaith, O. N. and Solano, E. and Solitro, F. and Souami, D. and Souchay, J. and Spagna, A. and Spina, L. and Spoto, F. and Steele, I. A. and Steidelmüller, H. and Stephenson, C. A. and Süveges, M. and Surdej, J. and Szabados, L. and Szegedi-Elek, E. and Taris, F. and Taylor, M. B. and Teixeira, R. and Tolomei, L. and Tonello, N. and Torra, F. and Torra, J. and Torralba Elipe, G. and Trabucchi, M. and Tsounis, A. T. and Turon, C. and Ulla, A. and Unger, N. and Vaillant, M. V. and van Dillen, E. and van Reeven, W. and Vanel, O. and Vecchiato, A. and Viala, Y. and Vicente, D. and Voutsinas, S. and Weiler, M. and Wevers, T. and Wyrzykowski, Ł. and Yoldas, A. and Yvard, P. and Zhao, H. and Zorec, J. and Zucker, S. and Zwitter, T.},
+   year={2023},
+   month=jun, pages={A37} }

SpiralMap/models_.py

@@ -198,7 +198,7 @@ class TaylorCordesSpiral(object):
 
 
 class spiral_houhan(object):	
-	"""Hou & Han (2014) polynomial-logarithmic spiral arm model
+	"""Hou & Han (2014) polynomial-logarithmic spiral arm model, all tracers
 	
 	Implements the Milky Way spiral structure model from:
 	"The spiral structure of the Milky Way from classical Cepheids" (Hou & Han 2014)
@@ -218,7 +218,7 @@ class spiral_houhan(object):
 		
 	def getparams(self):						
 		"""			
-		   Load spiral parameters from Hou & Han (2014) Table 4.
+		   Load spiral parameters from Hou & Han (2014) Table 4 (vcirc=239, Z =0.16), all tracers.
 		   
 		   :return: params ( Nested dictionary containing for each arm).
 		   
@@ -228,7 +228,112 @@ class spiral_houhan(object):
 					
 					θ_end: End angle in degrees.		   		   
 		   :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}
+		}	
+		return params		
+	def polynomial_log_spiral(self, θ, a, b, c, d):		
+		"""Calculate radius using polynomial-logarithmic spiral equation.
+		
+		Parameters
+		----------
+		θ : float or ndarray
+			Galactic longitude angle in degrees
+		a,b,c,d : float
+			Polynomial coefficients from Hou & Han Table 4
+			
+		Returns
+		-------
+		float or ndarray
+			Galactocentric radius in kiloparsecs
+			
+		Notes
+		-----
+		Implements equation:
+		R(θ) = exp(a + bθ_rad + cθ_rad² + dθ_rad³)
+		where θ_rad = np.radians(θ)
+		"""	
+		return np.exp(a + b*np.radians(θ) + c*np.radians(θ)**2 + d*np.radians(θ)**3)
+	
+	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'])
+				
+		# 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)
+	
+		return x_hc, y_gc, x_gc, y_gc
+	
+	def output_(self, arm):			
+		"""			
+		   Get arm coordinates in structured format.
+		
+		   :param arm: Arm identifier (e.g., 'Arm1')		
+		   :type arm: String 
+		   :return: self.dout = {'xhc':xhc,'yhc':yhc,'xgc':xgc,'ygc':ygc}
+		   :rtype: dict 
+		"""				
+		
+		xsun = self.xsun
+		self.R0 = -xsun  # Solar Galactocentric radius (kpc)	
+		# Generate spiral arm coordinates
+		xhc, yhc, xgc, ygc = self.model_(arm)	
+		self.dout = {
+			'xhc': xhc,
+			'yhc': yhc,
+			'xgc': xgc,
+			'ygc': ygc
+		}
+
+
+class spiral_houhan_HII(object):	
+	"""Hou & Han (2014) polynomial-logarithmic spiral arm model, HII regions only.
+	
+	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.	
+	"""	
+	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'}
+		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):						
+		"""			
+		   Load spiral parameters from Hou & Han (2014) Table 4 (vcirc=239, Z =0.16), HII regions only.
+		   
+		   :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.		   		   
+		   :rtype: dict 
+		"""			
+
 		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},
@@ -237,6 +342,7 @@ class spiral_houhan(object):
 			'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}
 		}	
+
 		return params		
 	def polynomial_log_spiral(self, θ, a, b, c, d):		
 		"""Calculate radius using polynomial-logarithmic spiral equation.
@@ -271,8 +377,8 @@ class spiral_houhan(object):
 		R = self.polynomial_log_spiral(θ, params['a'], params['b'], params['c'], params['d'])
 		
 		# Convert to Cartesian coordinates (Galactocentric)
-		x_gc = R*np.cos(np.radians(θ))
-		y_gc = R * np.sin(np.radians(θ))
+		y_gc = R*np.cos(np.radians(θ))
+		x_gc = -R * np.sin(np.radians(θ))
 		
 		# Convert to Heliocentric coordinates
 		x_hc = (x_gc + self.R0)
@@ -301,6 +407,8 @@ class spiral_houhan(object):
 		}
 
 
+
+
 class spiral_levine(object):		
 	"""	
 	Levine et al (2006) logarithmic spiral arm model for the Milky Way.  				
@@ -818,7 +926,7 @@ class main_(object):
 		"""	
 		   		
 		self.models = ['Taylor_Cordes_1992','Drimmel_NIR_2000',
-					   'Levine_2006','Hou_Han_2014','Reid_2019',
+					   '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(),
 							 'Levine_2006':spiral_levine(),
@@ -827,10 +935,11 @@ class main_(object):
 							 'Drimmel_NIR_2000':spiral_drimmel_nir(),
 							 'Taylor_Cordes_1992':TaylorCordesSpiral(),
 							 'Hou_Han_2014':spiral_houhan(),
+							 'Hou_Han_HII_2014':spiral_houhan_HII(),
 							 'Drimmel_Ceph_2024':spiral_drimmel_cepheids()}
 							 
 		self.models_desc = 	['HII','NIR emission',
-					   'HI','HII/GMC/Masers','MASER parallax',
+					   'HI','HII/GMC/Masers','HII','MASER parallax',
 					   'Upper main sequence (map)','OB stars (map)','Cepheids']  			 							 
 	def getinfo(self,model='',print_=True):	
 		"""			
@@ -973,7 +1082,7 @@ class _make_supportfiles(object):
 	
 	def __init__(self):
 					
-		self.xsun = -8.277	
+		self.Rsun = 8.277	
 	
 		# self.prep_poggio_polar()
 		self.savelims_all()
@@ -991,7 +1100,7 @@ class _make_supportfiles(object):
 			plt.close('all')
 			plotattrs = {'plot':True,'coordsys': 'HC','markersize':15,'linewidth':1,'polarproj':False,'armcolour':'black'}	
 			sp = spiral_poggio_maps(model_=usemodel)
-			sp.xsun = xsun
+			sp.Rsun = Rsun
 			cset1,cset2 = sp.output_(plotattrs)
 			
 			# # check xy projection
@@ -1043,11 +1152,11 @@ class _make_supportfiles(object):
 	def savelims_all(self):		
 	
 		print('saving plot limits for all models')
-		xsun=self.xsun
+		Rsun=self.Rsun
 	
 		mylims = {}
 		
-		spirals = main_(xsun=xsun)
+		spirals = main_(Rsun=Rsun)
 		for inum,use_model in enumerate(spirals.models):				
 			
 			plt.close('all')
@@ -1080,11 +1189,11 @@ class _make_supportfiles(object):
 	def savelims(self):		
 	
 		print('saving plot limits for all models')
-		xsun=self.xsun
+		Rsun=self.Rsun
 	
 		mylims = {}
 		
-		spirals = main_(xsun=xsun)
+		spirals = main_(Rsun=Rsun)
 		
 		for inum,use_model in enumerate(spirals.models):	
 						
@@ -1125,3 +1234,4 @@ class _make_supportfiles(object):
 	
 
 
+# # _make_supportfiles()

SpiralMap/test.py

@@ -195,7 +195,7 @@ if single_model_polar_hou:
 	plt.savefig(figdir_primer+'/polar_proj_single_model.png')
 
 
-multiple_models_polar = True
+multiple_models_polar = False
 if multiple_models_polar:
 
 	Rsun=8.277
@@ -254,6 +254,43 @@ if multiple_models_polar:
 	plt.savefig(figdir_primer+'/polar_proj_multiple_models2.png')
 
 
+hou_han_test = False
+if hou_han_test:
+
+	Rsun=8.277
+	spirals = sp.main_(Rsun=Rsun)
+	use_model = 'Hou_Han_2014'
+	use_model3 = 'Hou_Han__HII_2014'
+	use_arm = 'all'
+	use_model2 = 'Poggio_cont_2021'
+
+		
+	spirals.getinfo(model=use_model)				
+	
+	plt.close('all')
+	
+	fig = plt.figure(figsize=(10,10.))
+	
+	ax = plt.subplot(121, projection='polar')		
+
+	plotattrs = {'plot':True,'coordsys':'GC','markersize':15,'markSunGC':True,'polarproj':True,'linewidth':5}
+	spirals.readout(plotattrs,model=use_model,arm=use_arm)	
+	plotattrs = {'plot':True,'coordsys':'GC','markersize':3,'polarproj':True}	
+	spirals.readout(plotattrs,model=use_model2,arm='all')	
+	polar_style(ax,title=use_model+' (GC)')
+	
+	ax = plt.subplot(122, projection='polar')		
+
+	plotattrs = {'plot':True,'coordsys':'GC','markersize':15,'markSunGC':True,'polarproj':True,'linewidth':5}
+	spirals.readout(plotattrs,model=use_model3,arm=use_arm)	
+	plotattrs = {'plot':True,'coordsys':'GC','markersize':3,'polarproj':True}	
+	spirals.readout(plotattrs,model=use_model2,arm='all')	
+	polar_style(ax,title=use_model3+' (GC)')
+	
+	
+	plt.tight_layout()
+
+	plt.savefig(figdir_primer+'/test_houhan.png')
 
 makegif = False
 if makegif:
@@ -286,7 +323,7 @@ if makegif:
 
 	import mytools
 	curdir = os.getcwd()
-	mytools.png2movie(figdir_primer,curdir,flname='movie_',duration=2.5,fmt='gif')
+	mytools.png2movie(figdir_primer,curdir,flname='movie_',duration=3.5,fmt='gif')
 	
 	
 	

{spiralmap-0.0.1.dist-info → spiralmap-0.0.3.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: SpiralMap
-Version: 0.0.1
-Summary: A small example package
+Version: 0.0.3
+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
 Author-email: Prusty & Khanna <shourya.khanna@inaf.it>
@@ -19,18 +19,18 @@ Description-Content-Type: text/markdown
 # SpiralMap 
 A Python library of the Milky Way's spiral arms. 
 
-[![pypi status](https://img.shields.io/pypi/v/gaiaunlimited.svg)](https://test.pypi.org/project/SpiralMap/)
-
-The package can be used to extract and/or plot the 2D trace of the major spiral arm models & maps in literature. The current release includes 8 independent models and we are open to requests for including other spiral arm models. 
+[![pypi status](https://img.shields.io/pypi/v/spiralmap.svg?logo=pypi&logoColor=white&label=PyPI)](https://pypi.org/project/SpiralMap/)
+[![Documentation Status](https://app.readthedocs.org/projects/spiralmap/badge/?version=latest)](https://spiralmap.readthedocs.io/en/latest/?badge=latest)
 
 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)
 
+## Features
++ Access 8 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. 
 
 Installation
 -------------
@@ -41,11 +41,10 @@ Install the latest released version using ``pip``:
    pip install SpiralMap
 ```
 
-
 Acknowledging ``SpiralMap``
 ---------------------------------------
-If you make use of our package, please cite the accompanying JOSS paper (link). 
+If you make use of our package, please cite the accompanying paper. 
 
-Additionally, please also cite the individual spiral model used. To facilitate this, we provide a BibTex file with the relevant citations in 'datafiles/spiral.bib' (here on GitHub),
+Additionally, please also cite the individual spiral model used. To facilitate this, we provide a BibTex file with the relevant citations in 'datafiles/spiral.bib' (on GitHub),
 or alternatively these are also available on [Read the docs](https://spiralmap.readthedocs.io/en/latest/#api-docs).
 

{spiralmap-0.0.1.dist-info → spiralmap-0.0.3.dist-info}/RECORD

@@ -1,12 +1,12 @@
 SpiralMap/__init__.py,sha256=7F5e52HrtZpHq8kNmLG8e1jtNlf6jkufCDgoIKlKZGs,100
-SpiralMap/models_.py,sha256=aHSZh4XpdbewJsLltG-ETo0OwCQgJhXLhsESGpeC5X0,36681
-SpiralMap/movie_.gif,sha256=9cjZHcbIwXVWyCzX3rETQWBNamF409iojpyVBX0Ec5M,190718
+SpiralMap/models_.py,sha256=_1_l1AUv39EkEE7rF2-twOBDajvfO4k7LWdUY1DaqTE,40387
+SpiralMap/movie_.gif,sha256=famzvY320Jz8xjKjB0FndkXdGPZ4P8pJGlVKEHQuoto,125026
 SpiralMap/mytools.py,sha256=rmUT9Wsg3NhRHTlV-RvoZ3TWvYSEs5epX3zydEonnHM,7237
-SpiralMap/test.py,sha256=owAKSAyvCevvyKHptYf9S-i4p_8XMheRG0HO4Tkw4PI,8848
+SpiralMap/test.py,sha256=C7h_h-P1FFJlVv9CHGxO_2x_Zud12j1Xf-tUmmh0tdc,9987
 SpiralMap/version.py,sha256=G_9nHD5j8EWxdjfiRE8uUrh0l_FRWN5WAnCM9wjLIJw,78
-SpiralMap/datafiles/flim.pkl,sha256=_UJxKjAjAjD6IlgmedN61NiCSA19qFjWWJOuu_HbHzo,9560
-SpiralMap/datafiles/flim_all.pkl,sha256=G4mad8eZQ_cuow_N6ZkyuK2yWAd4i-jhOwvRXzX8Tkc,2129
-SpiralMap/datafiles/spiral.bib,sha256=F9e7jMTLehTPB9DRmsdH_VtR66-jJ7dAunStEq9WDUY,6361
+SpiralMap/datafiles/flim.pkl,sha256=VmwuaFXQbAc0P3ey2sPrZa3BgpXk4KSlwZrb3aoKYzU,11235
+SpiralMap/datafiles/flim_all.pkl,sha256=HWjuVpmOfdtLqsZK6eMajoGGXTdUfF9nXodRMjKYHbU,2112
+SpiralMap/datafiles/spiral.bib,sha256=tOAgtQcbd4uFfcf-8twiEjpZGXjdV_ZE7VvlMLDn_jk,13614
 SpiralMap/datafiles/Drimmel2024_cepheids/ArmAttributes_dyoungW1_bw025.pkl,sha256=F4pUfUSEg7_BBC9jpMjFeuWFHj4dYKszrpMt8wKW0ds,6571
 SpiralMap/datafiles/Drimmel_NIR/Drimmel2armspiral.fits,sha256=jJ2k0yddyIUbMxGRGszD6cwlleUrGMtkrMByc_hU5bA,14400
 SpiralMap/datafiles/Drimmel_NIR/Readme_spiral_m2_147.txt,sha256=h2aA4V9T8RQRBlG_GYDJRfLswnqrK6AmdCleFR-NLSE,395
@@ -27,8 +27,14 @@ SpiralMap/datafiles/Poggio_cont_2021/Poggio_cont_2021_pproj_contours.pkl,sha256=
 SpiralMap/datafiles/Poggio_cont_2021/overdens_grid_locscale03.npy,sha256=peM4jyLQsE8X4bMTCCe-7UD3Hayi2qmRcOQzCudBfHM,117256
 SpiralMap/datafiles/Poggio_cont_2021/xvalues.npy,sha256=uhY3STTfBhTer8pWNAkLezyu4o94VmNZgft0RZPFcTk,1096
 SpiralMap/datafiles/Poggio_cont_2021/yvalues.npy,sha256=uhY3STTfBhTer8pWNAkLezyu4o94VmNZgft0RZPFcTk,1096
-SpiralMap/figdir_primer/polar_proj_multiple_models2.png,sha256=Wpyp8A1rjzMZHCdBbMJW56ZOwitRMAmDRaWZkk5Y_Lg,129119
-spiralmap-0.0.1.dist-info/METADATA,sha256=a7uxG0PkbXjGYCyglDHRJB3iWU7LrbjYrIUGNWKdGuw,1990
-spiralmap-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-spiralmap-0.0.1.dist-info/licenses/LICENSE.md,sha256=5w1L9A7eVMqU0wNIsBTTZA8K2JBIK0KKbqMSaQ1z9m0,1076
-spiralmap-0.0.1.dist-info/RECORD,,
+SpiralMap/figdir_primer/map_0png.png,sha256=OMkJAkxqk9a9rvwphY6cvboY7RmYylApkKXINLiQtUs,75636
+SpiralMap/figdir_primer/map_1png.png,sha256=tA2OgSICQlC0N7VxypEZDucHvCKq3HsFStgo0eq95rM,83668
+SpiralMap/figdir_primer/map_2png.png,sha256=kBvhJb4KZJ5We6wnLo0YdnWQHmys1BF-kaXweQCYto8,71296
+SpiralMap/figdir_primer/map_3png.png,sha256=J8MUzu100rOaWxd1LGvhNItXJdtvQpt_cecgebSDxOI,86123
+SpiralMap/figdir_primer/map_4png.png,sha256=IBBJYP7boTzGUhIDdOnjsjK549YWeoEQgZABB7Lu7FA,84457
+SpiralMap/figdir_primer/map_5png.png,sha256=DzqQO-CBwKpq1wW75yqi4msLA5hslsUs8f3qfI-jkY4,71955
+SpiralMap/figdir_primer/map_8png.png,sha256=YNKex-pu4Vo8ULBuGKNhWXuuvNOEd6Xl_2KXtPcfAUw,74856
+spiralmap-0.0.3.dist-info/METADATA,sha256=u7EJTmI8ZPmmgNUTQk8_Jlq1ToKCVlh2LLAxGRpl3AA,2151
+spiralmap-0.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+spiralmap-0.0.3.dist-info/licenses/LICENSE.md,sha256=5w1L9A7eVMqU0wNIsBTTZA8K2JBIK0KKbqMSaQ1z9m0,1076
+spiralmap-0.0.3.dist-info/RECORD,,