Startseite Erkunden Hilfe
Registrieren Anmelden
jarjonam
/
tidal_tails
1
0
Fork 0
Dateien
Struktur: cb05d543cf
Branches Tags
tidal_tails
/
docs
/
analysis
/
tailShapePlot.html

tailShapePlot.html 9.6 KB
Verlauf Originalformat

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154 
  1. <!doctype html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. <meta charset="utf-8">
    5. 

  5. <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
    6. 

  6. <meta name="generator" content="pdoc 0.5.2" />
    7. 

  7. <title>analysis.tailShapePlot API documentation</title>
    8. 

  8. <meta name="description" content="Make a plot of the shape of the tails as a function of
    9. 

  9. mass of the perturbing mass, time and ring size" />
    10. 

  10. <link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
    11. 

  11. <link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
    12. 

  12. <link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
    13. 

  13. <style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}#index .two-column{column-count:2}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.name small{font-weight:normal}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
    14. 

  14. <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
    15. 

  15. <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
    16. 

  16. </head>
    17. 

  17. <body>
    18. 

  18. <main>
    19. 

  19. <article id="content">
    20. 

  20. <header>
    21. 

  21. <h1 class="title"><code>analysis.tailShapePlot</code> module</h1>
    22. 

  22. </header>
    23. 

  23. <section id="section-intro">
    24. 

  24. <p>Make a plot of the shape of the tails as a function of
    25. 

  25. mass of the perturbing mass, time and ring size</p>
    26. 

  26. <details class="source">
    27. 

  27. <summary>Source code</summary>
    28. 

  28. <pre><code class="python">&#34;&#34;&#34;Make a plot of the shape of the tails as a function of
    29. 

  29. mass of the perturbing mass, time and ring size
    30. 

  30. &#34;&#34;&#34;
    31. 

  31. 

  32. import matplotlib.pyplot as plt
    33. 

  33. import numpy as np
    34. 

  34. 

  35. from analysis import utils
    36. 

  36. from analysis.segmentation import segmentEncounter
    37. 

  37. 

  38. def plotShape(ax, distances, angle, style, label):
    39. 

  39.     &#34;&#34;&#34;Plot the shape curves, normalized to maximum radius = 1
    40. 

  40. 

  41.     Parameters:
    42. 

  42.         ax: the matplotlib axis where the data should be plotted
    43. 

  43.         distances (arr): the distances of each point in the shape of the tail
    44. 

  44.         angle (arr): the angle of each point in the shape curve of the tail
    45. 

  45.         style (string): style (dotted, dashed...) for the line, passed to
    46. 

  46.             matplotlib.
    47. 

  47.         label (string): label of the encounter. Used for the legend.
    48. 

  48.     &#34;&#34;&#34;
    49. 

  49.     ax.plot(-angles+np.min(angles), distances/np.max(distances), 
    50. 

  50.         label=label, linestyle=style, c=&#39;k&#39;, alpha=0.7)
    51. 

  51. 

  52. 

  53. f, axs = plt.subplots(1, 3,  figsize=(12, 3), sharey=True)
    54. 

  54. 

  55. # Varying the mass of the encounter
    56. 

  56. for m, st in zip([50, 100, 200], [&#39;:&#39;, &#39;-&#39;,&#39;--&#39;]):
    57. 

  57.     data = utils.loadData(&#39;{}mass70radius&#39;.format(m), 14000)
    58. 

  58.     _, (distances, angles), _ = segmentEncounter(data, plot=False)
    59. 

  59.     plotShape(axs[0], distances, angles, st, m/100)
    60. 

  60.     axs[0].legend(title=r&#39;$m_{companion}$&#39;)
    61. 

  61. utils.setAxes(axs[0], x=r&#39;Angle / rad&#39;, y=r&#39;Radius / $r_{max}$&#39;, 
    62. 

  62.     ycoords=(-0.1,.7))
    63. 

  63. 

  64. # Varying the time since the start of the encounter
    65. 

  65. for t, st in zip([4400, 7400, 10400], [&#39;:&#39;, &#39;-&#39;,&#39;--&#39;]):
    66. 

  66.     data = utils.loadData(&#39;200mass70radius&#39;.format(200), t)
    67. 

  67.     _, (distances, angles), _ = segmentEncounter(data, plot=False)
    68. 

  68.     plotShape(axs[1], distances, angles, st, t)
    69. 

  69.     axs[1].legend(title=r&#39;$t$&#39;)
    70. 

  70. utils.setAxes(axs[1], x=r&#39;Angle / rad&#39;)
    71. 

  71. 

  72. # Varying the radius of the ring
    73. 

  73. for r, st in zip([50, 60, 70, 80, 90], [&#39;:&#39;, &#39;-.&#39;,&#39;-&#39;,&#39;--&#39;]):
    74. 

  74.     data = utils.loadData(&#39;200mass{}radius&#39;.format(r), 10000)
    75. 

  75.     _, (distances, angles), _ = segmentEncounter(data, plot=False)
    76. 

  76.     plotShape(axs[2], distances, angles, st, r)
    77. 

  77.     axs[2].legend(title=r&#39;Disk radius&#39;)
    78. 

  78. utils.setAxes(axs[2], x=r&#39;Angle / rad&#39;)
    79. 

  79. 

  80. # Some styling
    81. 

  81. utils.stylizePlot(axs)
    82. 

  82. f.subplots_adjust(hspace=0, wspace=0)
    83. 

  83. plt.show()</code></pre>
    84. 

  84. </details>
    85. 

  85. </section>
    86. 

  86. <section>
    87. 

  87. </section>
    88. 

  88. <section>
    89. 

  89. </section>
    90. 

  90. <section>
    91. 

  91. <h2 class="section-title" id="header-functions">Functions</h2>
    92. 

  92. <dl>
    93. 

  93. <dt id="analysis.tailShapePlot.plotShape"><code class="name flex">
    94. 

  94. <span>def <span class="ident">plotShape</span></span>(<span>ax, distances, angle, style, label)</span>
    95. 

  95. </code></dt>
    96. 

  96. <dd>
    97. 

  97. <section class="desc"><p>Plot the shape curves, normalized to maximum radius = 1</p>
    98. 

  98. <h2 id="parameters">Parameters</h2>
    99. 

  99. <dl>
    100. 

  100. <dt><strong><code>ax</code></strong></dt>
    101. 

  101. <dd>the matplotlib axis where the data should be plotted</dd>
    102. 

  102. <dt><strong><code>distances</code></strong> :&ensp;<code>arr</code></dt>
    103. 

  103. <dd>the distances of each point in the shape of the tail</dd>
    104. 

  104. <dt><strong><code>angle</code></strong> :&ensp;<code>arr</code></dt>
    105. 

  105. <dd>the angle of each point in the shape curve of the tail</dd>
    106. 

  106. <dt><strong><code>style</code></strong> :&ensp;<code>string</code></dt>
    107. 

  107. <dd>style (dotted, dashed&hellip;) for the line, passed to
    108. 

  108. matplotlib.</dd>
    109. 

  109. <dt><strong><code>label</code></strong> :&ensp;<code>string</code></dt>
    110. 

  110. <dd>label of the encounter. Used for the legend.</dd>
    111. 

  111. </dl></section>
    112. 

  112. <details class="source">
    113. 

  113. <summary>Source code</summary>
    114. 

  114. <pre><code class="python">def plotShape(ax, distances, angle, style, label):
    115. 

  115.     &#34;&#34;&#34;Plot the shape curves, normalized to maximum radius = 1
    116. 

  116. 

  117.     Parameters:
    118. 

  118.         ax: the matplotlib axis where the data should be plotted
    119. 

  119.         distances (arr): the distances of each point in the shape of the tail
    120. 

  120.         angle (arr): the angle of each point in the shape curve of the tail
    121. 

  121.         style (string): style (dotted, dashed...) for the line, passed to
    122. 

  122.             matplotlib.
    123. 

  123.         label (string): label of the encounter. Used for the legend.
    124. 

  124.     &#34;&#34;&#34;
    125. 

  125.     ax.plot(-angles+np.min(angles), distances/np.max(distances), 
    126. 

  126.         label=label, linestyle=style, c=&#39;k&#39;, alpha=0.7)</code></pre>
    127. 

  127. </details>
    128. 

  128. </dd>
    129. 

  129. </dl>
    130. 

  130. </section>
    131. 

  131. <section>
    132. 

  132. </section>
    133. 

  133. </article>
    134. 

  134. <nav id="sidebar">
    135. 

  135. <h1>Index</h1>
    136. 

  136. <div class="toc">
    137. 

  137. <ul></ul>
    138. 

  138. </div>
    139. 

  139. <ul id="index">
    140. 

  140. <li><h3><a href="#header-functions">Functions</a></h3>
    141. 

  141. <ul class="">
    142. 

  142. <li><code><a title="analysis.tailShapePlot.plotShape" href="#analysis.tailShapePlot.plotShape">plotShape</a></code></li>
    143. 

  143. </ul>
    144. 

  144. </li>
    145. 

  145. </ul>
    146. 

  146. </nav>
    147. 

  147. </main>
    148. 

  148. <footer id="footer">
    149. 

  149. <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.5.2</a>.</p>
    150. 

  150. </footer>
    151. 

  151. <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
    152. 

  152. <script>hljs.initHighlightingOnLoad()</script>
    153. 

  153. </body>
    154. 

  154. </html>
    155.