-
Notifications
You must be signed in to change notification settings - Fork 0
/
software_napari_polcam.html
133 lines (110 loc) · 6.46 KB
/
software_napari_polcam.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<!DOCTYPE html>
<!-- specify language (british english) and reading direction (left to right) -->
<html lang="en-gb" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- descriptive sentence that shows up in google search results -->
<meta name="description" content="Documentation on hardware, software and experimental implementation of molecular orientation fluorescence microscopy using polarisation cameras.">
<!-- title of the page (e.g. shown in tab or when bookmarked) -->
<title>napari-polcam | POLCAM</title>
<!-- favicon -->
<link rel="apple-touch-icon" sizes="180x180" href="images/favicon_io/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="images/favicon_io/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="images/favicon_io/favicon-16x16.png">
<link rel="manifest" href="images/favicon_io/site.webmanifest">
<!-- main stylesheet -->
<link rel="stylesheet" href="stylesheets/styles.css">
</head>
<body>
<div class="wrapper">
<header>
<div class="navigationbar">
<!-- logo on top left of navigation bar -->
<div class="logo_navigationbar">
<a href="index.html">
<img alt="logo" src="./images/logo_polcam.svg" width="170px">
</a>
</div>
<!-- 'Contact' link on top right of navigation bar -->
<a href="contact.html">Contact</a>
<a href="protocols.html">Protocols</a>
<!-- 'Software' dropdown on top right of navigation bar -->
<div class="dropdown">
<button class="dropbtn">Software
<i class="fa fa-caret-down"></i>
</button>
<div class="dropdown-content">
<a href="software_polcam_sr.html">POLCAM-SR</a>
<a href="software_polcam_live.html">POLCAM-Live</a>
<a href="software_napari_polcam.html">napari-polcam</a>
</div>
</div>
<!-- 'Hardware' and 'Home' link on top right of navigation bar -->
<a href="hardware.html">Hardware</a>
<a href="index.html">Home</a>
</div>
</header>
<div class="sidebar">
<p class="sidebar_title">CONTENT</p>
<ol>
<li><a href="#system_requirements" target="_self">System requirements</a></li>
<li><a href="#installation_guide" target="_self">Installation guide</a></li>
<li><a href="#demo" target="_self">Demo</a></li>
<li><a href="#help" target="_self">Help</a></li>
</ol>
</div>
<main>
<section>
<h1>Software: napari-polcam</h1>
<strong>napari-polcam</strong> is a <a href="https://napari.org/stable/">napari</a> plugin for processing and rendering multi-dimensional polarisation camera image data.
<p>Download the latest version of the source code here: <a href="https://github.com/ezrabru/napari-polcam/archive/refs/heads/main.zip">Download source code</a></p>
<!-- System requirements chapter -->
<h2 id="system_requirements">System requirements</h2>
<ul>
<li>A working installation of napari</li>
<li>The software has been tested on Mac (macOS Monterey Version 12.6) and Windows (Windows 11 Pro Version 22H2) computers, using Python version 3.9.13 and napari version 0.4.17.</li>
</ul>
<!-- Installation guide chapter -->
<h2 id="installation_guide">Installation guide</h2>
<ol>
<li>
<p>Download the latest version of the source code (<a href="https://github.com/ezrabru/napari-polcam/archive/refs/heads/main.zip">download source code</a>) and unzip the folder.</p>
</li>
<li>
<p>If napari is not already installed, follow the installation instruction on the <a href="https://napari.org/stable/">napari webiste</a>.</p>
</li>
<li>
<p>Open a terminal in the virtual environment in which napari has been installed.</p>
</li>
<li>
<p>In the terminal, navigate to the folder 'napari-polcam-main' (the folder that contains the file MANIFEST.in, setup.cfg, etc.).</p>
</li>
<li>
<p>In the terminal, write: pip install .</p>
</li>
<li>
<p>If successful, you should now be able to access napari-polcam as a plugin in napari under 'Plugins > main (napari-polcam)'. In the future, we would like to make napari-polcam available from the <a href="https://www.napari-hub.org/">napari hub</a>.</p>
</li>
</ol>
<p>
The typical install time on a standard desktop computer takes a few minutes. If you encounter any issues during installation, please email us at <a href="mailto:[email protected]?subject=napari-polcam question">[email protected]</a> or <a href="https://github.com/ezrabru/POLCAM-SR/issues">report an issue</a> on the github repository.
</p>
<!-- Demo chapter -->
<h2 id="demo">Demo</h2>
<p>Using napari-polcam is very straightforward. Load the tif stack by dragging it into the napari gui. Select the dataset in the layer list. In the settings panel in napari-polcam, pick a polariser unit option, an interpolation method (cubic spline interpolation is recommended) and set a background (e.g. the minimum intensity value in the dataset). To convert the dataset to different formats, click any of the buttons in the basic processing panel or colourmap rendering panel. An example of a HSVmap rendering of a test dataset (a z-stack of a silica microsphere coated with a DPPC + 40% cholesterol lipid bilayer, labeled with Nile red):</p>
<p><img src="images/software/napari_polcam/gui_testdata.png" alt="Screenshot of the napari-polcam gui with test data."></p>
<!-- Help chapter -->
<h2 id="help">Help</h2>
If you encounter any issues during installation or use of the software, please email us at <a href="mailto:[email protected]?subject=napari-polcam question">[email protected]</a> or <a href="https://github.com/ezrabru/napari-polcam/issues">report an issue</a> on the github repository.
<br></br><br></br>
</section>
</main>
</div>
</body>
<!--
<footer>
<p>Contact: [email protected]</p>
</footer>
-->
</html>