jarjonam
/
tidal_tails


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
							<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.5.2" />
<title>analysis.inclination API documentation</title>
<meta name="description" content="Plot a survey of the inclination angle" />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<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>
<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>
<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>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title"><code>analysis.inclination</code> module</h1>
</header>
<section id="section-intro">
<p>Plot a survey of the inclination angle</p>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">&#34;&#34;&#34;Plot a survey of the inclination angle&#34;&#34;&#34;

import matplotlib.pyplot as plt
import numpy as np

from analysis import utils

def plotEdgeView(data, ax, axisOn):
    &#34;&#34;&#34;Plot the encounter as viewed from the edge of the galaxy

    Parameters:
        ax: the matplotlib axis where the data should be plotted
        data: a data dictionary in the format saved by the simulation
        axisOn (bool): whether to include the y axis in this subplot.
            It can be omitted when it is shared among subplots.
    &#34;&#34;&#34;
    r_vec = data[&#39;r_vec&#39;]
    theta, phi = data[&#39;CONFIG&#39;][&#39;galaxy1&#39;][&#39;orientation&#39;]

    # Obtain the edge view, rotate 90º around y axis
    spin = np.array([np.sin(theta)*np.cos(phi), 
            np.sin(theta)*np.sin(phi), 
            np.cos(theta)])
    phi = np.pi/2
    M = np.array([[np.cos(-phi), 0,np.sin(-phi)], 
        [0, 1, 0], 
        [-np.sin(-phi), 0, np.cos(-phi)]])
    r_vec = np.einsum(&#39;ai,ij-&gt;aj&#39;, r_vec, M)
    spin = np.einsum(&#39;i,ij-&gt;j&#39;, spin, M)
    data[&#39;tracks&#39;] = np.einsum(&#39;abi,ij-&gt;abj&#39;, data[&#39;tracks&#39;], M)
    data[&#39;tracks&#39;] -= r_vec[0,:] #Relative to center of galaxy
    r_vec[:,:] -= r_vec[0,:] 

    # Flip y to be consistent with Toomre and Toomre
    r_vec[:,1] = -r_vec[:,1]
    data[&#39;tracks&#39;][:,:,1] *= -1

    # Plotting
    utils.plotCenterMasses(ax, {&#39;r_vec&#39;: r_vec, &#39;type&#39;:data[&#39;type&#39;]})
    ax.plot(data[&#39;tracks&#39;][1,:,0], data[&#39;tracks&#39;][1,:,1], 
        c=&#39;black&#39;, alpha=1.0, linewidth=1)
    ax.scatter(r_vec[:,0], r_vec[:,1], s=0.01, marker=&#39;.&#39;, 
        c=&#39;#c40f4c&#39;, alpha=.6)
    utils.setSize(ax, x=(-1.5, 1.5), y=(-1.5,3.5), mode=&#39;square&#39;)
    utils.stylizePlot([ax])
    utils.setAxes(ax, x=r&#39;x / $r_{min}$&#39;, y=r&#39;y / $r_{min}$&#39;, 
        ycoords=(-0.2, .8), mode=(&#39;bottomleft&#39; if axisOn else &#39;bottom&#39;))
    
def plotFrontalView(data, ax, axisOn):
    &#34;&#34;&#34;Plot the encounter as viewed normal to the galactic plane

    Parameters:
        ax: the matplotlib axis where the data should be plotted
        data: a data dictionary in the format saved by the simulation
        axisOn (bool): whether to include the y axis in this subplot.
            It can be omitted when it is shared among subplots.
    &#34;&#34;&#34;
    r_vec = data[&#39;r_vec&#39;]
    theta, phi = data[&#39;CONFIG&#39;][&#39;galaxy1&#39;][&#39;orientation&#39;]
    
    # Rotate the position vectors into the appropiate view
    M2 = np.array([[np.cos(-phi), np.sin(-phi), 0],
        [-np.sin(-phi), np.cos(-phi), 0],
        [0, 0, 1]])
    M1 = np.array([[1, 0, 0],
        [0, np.cos(-theta), np.sin(-theta)],
        [0, -np.sin(-theta), np.cos(-theta)]])
    r_vec = np.einsum(&#39;ai,ij-&gt;aj&#39;, np.einsum(&#39;ai,ij-&gt;aj&#39;, r_vec, M2), M1)
    data[&#39;tracks&#39;] = np.einsum(&#39;abi,ij-&gt;abj&#39;, data[&#39;tracks&#39;], M2)
    data[&#39;tracks&#39;] = np.einsum(&#39;abi,ij-&gt;abj&#39;, data[&#39;tracks&#39;], M1)
    data[&#39;tracks&#39;] -= data[&#39;tracks&#39;][0]
    r_vec[:,:] -= r_vec[0,:]

    #Plotting
    utils.plotCenterMasses(ax, {&#39;r_vec&#39;: r_vec, &#39;type&#39;:data[&#39;type&#39;]})
    utils.plotTracks(ax, data[&#39;tracks&#39;])
    ax.scatter(r_vec[:,0], r_vec[:,1], c=&#39;#c40f4c&#39;, s=0.01, marker=&#39;.&#39;)
    utils.setSize(ax, x=(-3, 2), y=(-1.5, 1.5), mode=&#39;square&#39;)
    utils.stylizePlot([ax])
    utils.setAxes(ax, x=r&#39;x / $r_{min}$&#39;, y=r&#39;y / $r_{min}$&#39;, 
        ycoords=(-0.2, .8), mode=(&#39;bottomleft&#39; if axisOn else &#39;bottom&#39;))

#########################################################

# Select the inclinations
inclinations = [15, 45, 60, 90, 135]
f, axs = plt.subplots(2, len(inclinations),  figsize=(11, 6), 
    sharey=False, sharex=False, gridspec_kw = {&#39;height_ratios&#39;:[5/3, 1]})
t = 5000 # time of plots

# Plot both views for each encounter
for i in range(len(inclinations)):
    data = utils.loadData(&#39;i{}&#39;.format(inclinations[i]), t)
    plotEdgeView(data, ax=axs[0,i], axisOn=True if i==0 else False)
    data = utils.loadData(&#39;i{}&#39;.format(inclinations[i]), t)
    plotFrontalView(data, ax=axs[1,i], axisOn=True if i==0 else False)
    
f.subplots_adjust(hspace=0, wspace=0)
plt.tight_layout()
plt.show()</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="analysis.inclination.plotEdgeView"><code class="name flex">
<span>def <span class="ident">plotEdgeView</span></span>(<span>data, ax, axisOn)</span>
</code></dt>
<dd>
<section class="desc"><p>Plot the encounter as viewed from the edge of the galaxy</p>
<h2 id="parameters">Parameters</h2>
<dl>
<dt><strong><code>ax</code></strong></dt>
<dd>the matplotlib axis where the data should be plotted</dd>
<dt><strong><code>data</code></strong></dt>
<dd>a data dictionary in the format saved by the simulation</dd>
<dt><strong><code>axisOn</code></strong> :&ensp;<code>bool</code></dt>
<dd>whether to include the y axis in this subplot.
It can be omitted when it is shared among subplots.</dd>
</dl></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def plotEdgeView(data, ax, axisOn):
    &#34;&#34;&#34;Plot the encounter as viewed from the edge of the galaxy

    Parameters:
        ax: the matplotlib axis where the data should be plotted
        data: a data dictionary in the format saved by the simulation
        axisOn (bool): whether to include the y axis in this subplot.
            It can be omitted when it is shared among subplots.
    &#34;&#34;&#34;
    r_vec = data[&#39;r_vec&#39;]
    theta, phi = data[&#39;CONFIG&#39;][&#39;galaxy1&#39;][&#39;orientation&#39;]

    # Obtain the edge view, rotate 90º around y axis
    spin = np.array([np.sin(theta)*np.cos(phi), 
            np.sin(theta)*np.sin(phi), 
            np.cos(theta)])
    phi = np.pi/2
    M = np.array([[np.cos(-phi), 0,np.sin(-phi)], 
        [0, 1, 0], 
        [-np.sin(-phi), 0, np.cos(-phi)]])
    r_vec = np.einsum(&#39;ai,ij-&gt;aj&#39;, r_vec, M)
    spin = np.einsum(&#39;i,ij-&gt;j&#39;, spin, M)
    data[&#39;tracks&#39;] = np.einsum(&#39;abi,ij-&gt;abj&#39;, data[&#39;tracks&#39;], M)
    data[&#39;tracks&#39;] -= r_vec[0,:] #Relative to center of galaxy
    r_vec[:,:] -= r_vec[0,:] 

    # Flip y to be consistent with Toomre and Toomre
    r_vec[:,1] = -r_vec[:,1]
    data[&#39;tracks&#39;][:,:,1] *= -1

    # Plotting
    utils.plotCenterMasses(ax, {&#39;r_vec&#39;: r_vec, &#39;type&#39;:data[&#39;type&#39;]})
    ax.plot(data[&#39;tracks&#39;][1,:,0], data[&#39;tracks&#39;][1,:,1], 
        c=&#39;black&#39;, alpha=1.0, linewidth=1)
    ax.scatter(r_vec[:,0], r_vec[:,1], s=0.01, marker=&#39;.&#39;, 
        c=&#39;#c40f4c&#39;, alpha=.6)
    utils.setSize(ax, x=(-1.5, 1.5), y=(-1.5,3.5), mode=&#39;square&#39;)
    utils.stylizePlot([ax])
    utils.setAxes(ax, x=r&#39;x / $r_{min}$&#39;, y=r&#39;y / $r_{min}$&#39;, 
        ycoords=(-0.2, .8), mode=(&#39;bottomleft&#39; if axisOn else &#39;bottom&#39;))</code></pre>
</details>
</dd>
<dt id="analysis.inclination.plotFrontalView"><code class="name flex">
<span>def <span class="ident">plotFrontalView</span></span>(<span>data, ax, axisOn)</span>
</code></dt>
<dd>
<section class="desc"><p>Plot the encounter as viewed normal to the galactic plane</p>
<h2 id="parameters">Parameters</h2>
<dl>
<dt><strong><code>ax</code></strong></dt>
<dd>the matplotlib axis where the data should be plotted</dd>
<dt><strong><code>data</code></strong></dt>
<dd>a data dictionary in the format saved by the simulation</dd>
<dt><strong><code>axisOn</code></strong> :&ensp;<code>bool</code></dt>
<dd>whether to include the y axis in this subplot.
It can be omitted when it is shared among subplots.</dd>
</dl></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def plotFrontalView(data, ax, axisOn):
    &#34;&#34;&#34;Plot the encounter as viewed normal to the galactic plane

    Parameters:
        ax: the matplotlib axis where the data should be plotted
        data: a data dictionary in the format saved by the simulation
        axisOn (bool): whether to include the y axis in this subplot.
            It can be omitted when it is shared among subplots.
    &#34;&#34;&#34;
    r_vec = data[&#39;r_vec&#39;]
    theta, phi = data[&#39;CONFIG&#39;][&#39;galaxy1&#39;][&#39;orientation&#39;]
    
    # Rotate the position vectors into the appropiate view
    M2 = np.array([[np.cos(-phi), np.sin(-phi), 0],
        [-np.sin(-phi), np.cos(-phi), 0],
        [0, 0, 1]])
    M1 = np.array([[1, 0, 0],
        [0, np.cos(-theta), np.sin(-theta)],
        [0, -np.sin(-theta), np.cos(-theta)]])
    r_vec = np.einsum(&#39;ai,ij-&gt;aj&#39;, np.einsum(&#39;ai,ij-&gt;aj&#39;, r_vec, M2), M1)
    data[&#39;tracks&#39;] = np.einsum(&#39;abi,ij-&gt;abj&#39;, data[&#39;tracks&#39;], M2)
    data[&#39;tracks&#39;] = np.einsum(&#39;abi,ij-&gt;abj&#39;, data[&#39;tracks&#39;], M1)
    data[&#39;tracks&#39;] -= data[&#39;tracks&#39;][0]
    r_vec[:,:] -= r_vec[0,:]

    #Plotting
    utils.plotCenterMasses(ax, {&#39;r_vec&#39;: r_vec, &#39;type&#39;:data[&#39;type&#39;]})
    utils.plotTracks(ax, data[&#39;tracks&#39;])
    ax.scatter(r_vec[:,0], r_vec[:,1], c=&#39;#c40f4c&#39;, s=0.01, marker=&#39;.&#39;)
    utils.setSize(ax, x=(-3, 2), y=(-1.5, 1.5), mode=&#39;square&#39;)
    utils.stylizePlot([ax])
    utils.setAxes(ax, x=r&#39;x / $r_{min}$&#39;, y=r&#39;y / $r_{min}$&#39;, 
        ycoords=(-0.2, .8), mode=(&#39;bottomleft&#39; if axisOn else &#39;bottom&#39;))</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="analysis.inclination.plotEdgeView" href="#analysis.inclination.plotEdgeView">plotEdgeView</a></code></li>
<li><code><a title="analysis.inclination.plotFrontalView" href="#analysis.inclination.plotFrontalView">plotFrontalView</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.5.2</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>