docs/build/html/_generated/deepof.visuals.html
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>deepof.visuals — deepof 0.6.2 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/jupyter-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/thebelab.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<link rel="shortcut icon" href="../_static/deepof.ico"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/thebelab-helper.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html">
<img src="../_static/deepof_sidebar.ico" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">deepof.visuals</a></li>
</ul>
</div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">deepof</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">deepof.visuals</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/_generated/deepof.visuals.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<style>
/* CSS overrides for sphinx_rtd_theme */
/* 24px margin */
.nbinput.nblast.container,
.nboutput.nblast.container {
margin-bottom: 19px; /* padding has already 5px */
}
/* ... except between code cells! */
.nblast.container + .nbinput.container {
margin-top: -19px;
}
.admonition > p:before {
margin-right: 4px; /* make room for the exclamation icon */
}
/* Fix math alignment, see https://github.com/rtfd/sphinx_rtd_theme/pull/686 */
.math {
text-align: unset;
}
</style>
<section id="module-deepof.visuals">
<span id="deepof-visuals"></span><h1>deepof.visuals<a class="headerlink" href="#module-deepof.visuals" title="Permalink to this heading"></a></h1>
<p>General plotting functions for the deepof package.</p>
<p class="rubric">Functions</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="deepof.visuals.animate_skeleton.html#deepof.visuals.animate_skeleton" title="deepof.visuals.animate_skeleton"><code class="xref py py-obj docutils literal notranslate"><span class="pre">animate_skeleton</span></code></a>(coordinates, experiment_id)</p></td>
<td><p>Render a FuncAnimation object with embeddings and/or motion trajectories over time.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="deepof.visuals.annotate_video.html#deepof.visuals.annotate_video" title="deepof.visuals.annotate_video"><code class="xref py py-obj docutils literal notranslate"><span class="pre">annotate_video</span></code></a>(coordinates, tag_dict, vid_index)</p></td>
<td><p>Render a version of the input video with all supervised taggings in place.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="deepof.visuals.export_annotated_video.html#deepof.visuals.export_annotated_video" title="deepof.visuals.export_annotated_video"><code class="xref py py-obj docutils literal notranslate"><span class="pre">export_annotated_video</span></code></a>(coordinates[, ...])</p></td>
<td><p>Export annotated videos from both supervised and unsupervised pipelines.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="deepof.visuals.heatmap.html#deepof.visuals.heatmap" title="deepof.visuals.heatmap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">heatmap</span></code></a>(dframe, bodyparts[, xlim, ylim, ...])</p></td>
<td><p>Return a heatmap of the movement of a specific bodypart in the arena.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="deepof.visuals.output_cluster_video.html#deepof.visuals.output_cluster_video" title="deepof.visuals.output_cluster_video"><code class="xref py py-obj docutils literal notranslate"><span class="pre">output_cluster_video</span></code></a>(cap, out, frame_mask, ...)</p></td>
<td><p>Output a video with the frames corresponding to the cluster.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="deepof.visuals.output_unsupervised_annotated_video.html#deepof.visuals.output_unsupervised_annotated_video" title="deepof.visuals.output_unsupervised_annotated_video"><code class="xref py py-obj docutils literal notranslate"><span class="pre">output_unsupervised_annotated_video</span></code></a>(...[, ...])</p></td>
<td><p>Given a video, and soft_counts per frame, outputs a video with the frames annotated with the cluster they belong to.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="deepof.visuals.output_videos_per_cluster.html#deepof.visuals.output_videos_per_cluster" title="deepof.visuals.output_videos_per_cluster"><code class="xref py py-obj docutils literal notranslate"><span class="pre">output_videos_per_cluster</span></code></a>(video_paths, ...)</p></td>
<td><p>Given a list of videos, and a list of soft counts per video, outputs a video for each cluster.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="deepof.visuals.plot_arena.html#deepof.visuals.plot_arena" title="deepof.visuals.plot_arena"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_arena</span></code></a>(coordinates, center, color, ax, i)</p></td>
<td><p>Plot the arena in the given canvas.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="deepof.visuals.plot_cluster_detection_performance.html#deepof.visuals.plot_cluster_detection_performance" title="deepof.visuals.plot_cluster_detection_performance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_cluster_detection_performance</span></code></a>(...[, ...])</p></td>
<td><p>Plot either a confusion matrix or a bar chart with balanced accuracy for cluster detection cross validated models.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="deepof.visuals.plot_distance_between_conditions.html#deepof.visuals.plot_distance_between_conditions" title="deepof.visuals.plot_distance_between_conditions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_distance_between_conditions</span></code></a>(...[, ...])</p></td>
<td><p>Plot the distance between conditions across a growing time window.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="deepof.visuals.plot_embeddings.html#deepof.visuals.plot_embeddings" title="deepof.visuals.plot_embeddings"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_embeddings</span></code></a>(coordinates[, embeddings, ...])</p></td>
<td><p>Return a scatter plot of the passed projection.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="deepof.visuals.plot_enrichment.html#deepof.visuals.plot_enrichment" title="deepof.visuals.plot_enrichment"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_enrichment</span></code></a>(coordinates[, embeddings, ...])</p></td>
<td><p>Violin plots per cluster per condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="deepof.visuals.plot_gantt.html#deepof.visuals.plot_gantt" title="deepof.visuals.plot_gantt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_gantt</span></code></a>(coordinates, experiment_id[, ...])</p></td>
<td><p>Return a scatter plot of the passed projection.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="deepof.visuals.plot_heatmaps.html#deepof.visuals.plot_heatmaps" title="deepof.visuals.plot_heatmaps"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_heatmaps</span></code></a>(coordinates, bodyparts[, ...])</p></td>
<td><p>Plot heatmaps of the specified body parts (bodyparts) of the specified animal (i).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="deepof.visuals.plot_normative_log_likelihood.html#deepof.visuals.plot_normative_log_likelihood" title="deepof.visuals.plot_normative_log_likelihood"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_normative_log_likelihood</span></code></a>(embeddings, ...)</p></td>
<td><p>Plot a bar chart with normative log likelihoods per experimental condition, and compute statistics.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="deepof.visuals.plot_shap_swarm_per_cluster.html#deepof.visuals.plot_shap_swarm_per_cluster" title="deepof.visuals.plot_shap_swarm_per_cluster"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_shap_swarm_per_cluster</span></code></a>(coordinates, ...)</p></td>
<td><p>Plot a swarm plot of the SHAP values for a given cluster.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="deepof.visuals.plot_stationary_entropy.html#deepof.visuals.plot_stationary_entropy" title="deepof.visuals.plot_stationary_entropy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_stationary_entropy</span></code></a>(coordinates, ...[, ...])</p></td>
<td><p>Compute and plots transition stationary distribution entropy per condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="deepof.visuals.plot_transitions.html#deepof.visuals.plot_transitions" title="deepof.visuals.plot_transitions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_transitions</span></code></a>(coordinates, embeddings, ...)</p></td>
<td><p>Compute and plots transition matrices for all data or per condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="deepof.visuals.tag_annotated_frames.html#deepof.visuals.tag_annotated_frames" title="deepof.visuals.tag_annotated_frames"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tag_annotated_frames</span></code></a>(frame, font, ...)</p></td>
<td><p>Annotate a given frame with on-screen information about the recognised patterns.</p></td>
</tr>
</tbody>
</table>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, Lucas Miranda.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>