Skip to content

Commit

Permalink
deploy: cd0cc2f
Browse files Browse the repository at this point in the history
  • Loading branch information
@jo-mueller
jo-mueller committed Jul 22, 2024
1 parent 3dd349d commit ed9838d
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion _static/js/hoverxref.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ function reLoadSphinxTabs() {
function getEmbedURL(url) {
var params = {
'doctool': 'sphinx',
'doctoolversion': '7.4.6',
'doctoolversion': '7.4.7',
'url': url,
}
console.debug('Data: ' + JSON.stringify(params));
Expand Down
4 changes: 3 additions & 1 deletion artists_api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -546,7 +546,7 @@ <h1>Artists<a class="headerlink" href="#artists" title="Link to this heading">#<

<dl class="py class">
<dt class="sig sig-object py" id="biaplotter.artists.Scatter">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">biaplotter.artists.</span></span><span class="sig-name descname"><span class="pre">Scatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ax:</span> <span class="pre">~matplotlib.axes._axes.Axes</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~numpy.ndarray</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">categorical_colormap:</span> <span class="pre">~matplotlib.colors.Colormap</span> <span class="pre">=</span> <span class="pre">&lt;matplotlib.colors.LinearSegmentedColormap</span> <span class="pre">object&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color_indices:</span> <span class="pre">~numpy.ndarray</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#biaplotter.artists.Scatter" title="Link to this definition">#</a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">biaplotter.artists.</span></span><span class="sig-name descname"><span class="pre">Scatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ax:</span> <span class="pre">~matplotlib.axes._axes.Axes</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data:</span> <span class="pre">~numpy.ndarray</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">categorical_colormap:</span> <span class="pre">~matplotlib.colors.Colormap</span> <span class="pre">=</span> <span class="pre">&lt;matplotlib.colors.LinearSegmentedColormap</span> <span class="pre">object&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color_indices:</span> <span class="pre">~numpy.ndarray</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha:</span> <span class="pre">~numpy.ndarray</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#biaplotter.artists.Scatter" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#biaplotter.artists.Artist" title="biaplotter.artists.Artist"><code class="xref py py-class docutils literal notranslate"><span class="pre">Artist</span></code></a></p>
<p>Scatter plot artist for the BiAPlotter.</p>
<p>Inherits all parameters and attributes from abstract Artist.
Expand All @@ -558,6 +558,7 @@ <h1>Artists<a class="headerlink" href="#artists" title="Link to this heading">#<
<li><p><strong>data</strong> (<em>(</em><em>N</em><em>, </em><em>2</em><em>) </em><em>np.ndarray</em>) – data to be plotted</p></li>
<li><p><strong>categorical_colormap</strong> (<em>Colormap</em><em>, </em><em>optional</em>) – a colormap to use for the artist, by default cat10_mod_cmap from nap-plot-tools</p></li>
<li><p><strong>color_indices</strong> (<em>(</em><em>N</em><em>,</em><em>) </em><em>np.ndarray</em><em>[</em><em>int</em><em>] or </em><em>int</em><em>, </em><em>optional</em>) – array of indices to map to the colormap, by default None</p></li>
<li><p><strong>alpha</strong> (<em>(</em><em>N</em><em>,</em><em>) </em><em>np.ndarray</em><em>[</em><em>float</em><em>] or </em><em>float</em><em>, </em><em>optional</em>) – array of alpha values for the scatter points, by default 1.0</p></li>
</ul>
</dd>
</dl>
Expand All @@ -579,6 +580,7 @@ <h1>Artists<a class="headerlink" href="#artists" title="Link to this heading">#<
<span class="gp">&gt;&gt;&gt; </span><span class="n">scatter</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">data</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">scatter</span><span class="o">.</span><span class="n">visible</span> <span class="o">=</span> <span class="kc">True</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">scatter</span><span class="o">.</span><span class="n">color_indices</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">stop</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">num</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">endpoint</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">int</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">scatter</span><span class="o">.</span><span class="n">alpha</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="n">start</span><span class="o">=</span><span class="mf">0.1</span><span class="p">,</span> <span class="n">stop</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">num</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
Expand Down
Loading

0 comments on commit ed9838d

Please sign in to comment.