Merge pull request #44 from open-ephys/record-control-diagram

jsiegle · web-flow · commit e745ddad4630 · 2025-01-20T09:45:00.000-07:00
Add a diagram to illustrate Record Control plugin configuration
diff --git a/source/User-Manual/Plugins/Record-Control.rst b/source/User-Manual/Plugins/Record-Control.rst
@@ -34,6 +34,7 @@ Trigger modes
 
 * **Edge toggle**: Starts recording when the selected edge (rising or falling) is detected, and stops recording when the next edge of the same type is detected. Use this mode to toggle recording state using incoming events on a particular TTL line.
 
-|
+.. image:: ../../_static/images/plugins/recordcontrol/recordcontrol-02.png
+  :alt: Record Control trigger modes diagram
 
 
diff --git a/source/_static/images/plugins/recordcontrol/recordcontrol-02.png b/source/_static/images/plugins/recordcontrol/recordcontrol-02.png
diff --git a/source/_static/images/plugins/recordcontrol/recordcontrol-02.svg b/source/_static/images/plugins/recordcontrol/recordcontrol-02.svg
@@ -0,0 +1,204 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="210.64934mm"
+   height="79.072441mm"
+   viewBox="0 0 210.64933 79.072443"
+   version="1.1"
+   id="svg5"
+   inkscape:version="1.3.2 (091e20e, 2023-11-25, custom)"
+   sodipodi:docname="recordcontrol-02.svg"
+   inkscape:export-filename="Miniscope_acquisition.png"
+   inkscape:export-xdpi="96"
+   inkscape:export-ydpi="96"
+   xml:space="preserve"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg"><sodipodi:namedview
+     id="namedview7"
+     pagecolor="#ffffff"
+     bordercolor="#000000"
+     borderopacity="0.25"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:document-units="mm"
+     showgrid="false"
+     inkscape:zoom="2.1367163"
+     inkscape:cx="472.21992"
+     inkscape:cy="141.57237"
+     inkscape:window-width="2880"
+     inkscape:window-height="1586"
+     inkscape:window-x="2869"
+     inkscape:window-y="-11"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="layer1"
+     inkscape:export-bgcolor="#ffffffff"><inkscape:page
+       x="0"
+       y="0"
+       width="210.64934"
+       height="79.072441"
+       id="page2"
+       margin="0"
+       bleed="0"
+       inkscape:export-filename="recordcontrol-02.png"
+       inkscape:export-xdpi="330"
+       inkscape:export-ydpi="330" /></sodipodi:namedview><defs
+     id="defs2"><marker
+       style="overflow:visible"
+       id="marker15791-9-9-4-0-6"
+       refX="0"
+       refY="0"
+       orient="auto-start-reverse"
+       inkscape:stockid="Arrow4"
+       markerWidth="5"
+       markerHeight="6"
+       viewBox="0 0 5 6"
+       inkscape:isstock="true"
+       inkscape:collect="always"
+       preserveAspectRatio="xMidYMid"><path
+         style="fill:context-stroke;fill-rule:evenodd;stroke:none"
+         d="m 1,0 -3,3 h -2 l 3,-3 -3,-3 h 2 z"
+         id="path15789-0-9-1-1-7" /></marker></defs><g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-10.974967,-86.451048)"><path
+       style="fill:none;stroke:#000000;stroke-width:0.508899;stroke-linecap:round;stroke-linejoin:round"
+       d="m 17.389622,103.35667 22.135347,-0.0623 v -12.1311 h 76.007841 v 12.06919 l 13.80207,-0.0336"
+       id="path346"
+       sodipodi:nodetypes="cccccc" /><path
+       id="path3982"
+       style="fill:none;stroke:#000000;stroke-width:0.600934;stroke-linecap:round;stroke-linejoin:round"
+       d="m 147.0585,124.43743 h -21.78217 m -76.299891,0 66.556371,-0.12382 v -11.90803 h 9.48578 v 11.90802 m -107.310115,0.12383 h 21.782178 v -11.90802 h 9.485786 v 11.90802"
+       sodipodi:nodetypes="cccccccccccc" /><text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.93889px;font-family:'Arial ITC';-inkscape-font-specification:'Arial ITC';text-align:center;text-anchor:middle;fill:none;stroke:#000000;stroke-width:0.600001;stroke-linecap:round;stroke-linejoin:round"
+       x="184.95386"
+       y="119.8836"
+       id="text4282"><tspan
+         sodipodi:role="line"
+         id="tspan4280"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.93889px;font-family:Sans;-inkscape-font-specification:Sans;fill:#000000;stroke:none;stroke-width:0.6"
+         x="184.95386"
+         y="119.8836">Edge toggle (Rising)</tspan></text><text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.93889px;font-family:'Arial ITC';-inkscape-font-specification:'Arial ITC';text-align:center;text-anchor:middle;fill:none;stroke:#000000;stroke-width:0.600001;stroke-linecap:round;stroke-linejoin:round"
+       x="180.96817"
+       y="98.722069"
+       id="text4282-4"><tspan
+         sodipodi:role="line"
+         id="tspan4280-3"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.93889px;font-family:Sans;-inkscape-font-specification:Sans;fill:#000000;stroke:none;stroke-width:0.6"
+         x="180.96817"
+         y="98.722069">Edge set (Rising)</tspan></text><text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.93889px;font-family:'Arial ITC';-inkscape-font-specification:'Arial ITC';text-align:center;text-anchor:middle;fill:none;stroke:#000000;stroke-width:0.600001;stroke-linecap:round;stroke-linejoin:round"
+       x="187.24797"
+       y="136.69649"
+       id="text4282-4-6-1-2"><tspan
+         sodipodi:role="line"
+         id="tspan4280-3-4-5-4"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.93889px;font-family:Sans;-inkscape-font-specification:Sans;fill:#000000;stroke:none;stroke-width:0.6"
+         x="187.24797"
+         y="136.69649">Acquistion/Recording</tspan></text><text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.93889px;font-family:'Arial ITC';-inkscape-font-specification:'Arial ITC';text-align:center;text-anchor:middle;fill:none;stroke:#000000;stroke-width:0.600001;stroke-linecap:round;stroke-linejoin:round"
+       x="188.79138"
+       y="148.58177"
+       id="text4282-4-6-1-2-5"><tspan
+         sodipodi:role="line"
+         id="tspan4280-3-4-5-4-6"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.93889px;font-family:Sans;-inkscape-font-specification:Sans;fill:#000000;stroke:none;stroke-width:0.6"
+         x="188.79138"
+         y="148.58177">Equivalent GUI buttons</tspan></text><text
+       xml:space="preserve"
+       style="font-size:4.93889px;font-family:Miso;-inkscape-font-specification:Miso;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.416999;stroke-linejoin:round;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:0.556863"
+       x="114.32567"
+       y="160.78844"
+       id="text17605-9-4-4-5-0-1-3"><tspan
+         sodipodi:role="line"
+         id="tspan17603-24-6-7-2-4-7-1"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.93889px;font-family:Sans;-inkscape-font-specification:Sans;stroke-width:0.417"
+         x="114.32567"
+         y="160.78844">Time</tspan></text><path
+       style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:0.335;stroke-linejoin:round;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker-start:url(#marker15791-9-9-4-0-6)"
+       d="m 146.24914,158.99315 c -15.58549,0 -16.65809,0.011 -16.65809,0.011"
+       id="path19127-1-6-1-9-9"
+       sodipodi:nodetypes="cc" /><g
+       id="g1"
+       transform="translate(1.9478619,-0.61913712)"><g
+         id="g5"
+         transform="translate(0,-3.2386822)"><path
+           style="fill:none;stroke:#b4b4b4;stroke-width:1.80016;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:0.745098"
+           d="m 15.187311,139.11986 22.389796,-0.0553"
+           id="path1"
+           sodipodi:nodetypes="cc" /><path
+           style="fill:#666666;stroke:#b4b4b4;stroke-width:1.79135;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:0.745098"
+           d="m 113.58491,139.08771 31.69791,0.009"
+           id="path1-8"
+           sodipodi:nodetypes="cc" /><path
+           style="fill:none;stroke:#ff0000;stroke-width:1.88833;stroke-linejoin:round;stroke-dasharray:none"
+           d="M 37.577107,139.09221 H 113.58495"
+           id="path1-4" /></g></g><g
+       id="g4"
+       transform="translate(1.9478619,-0.61913712)"><path
+         sodipodi:type="star"
+         style="opacity:0.743697;fill:#b4b4b4;fill-opacity:1;stroke:none;stroke-width:0.391001;stroke-linecap:square;paint-order:stroke fill markers"
+         id="path3"
+         inkscape:flatsided="true"
+         sodipodi:sides="3"
+         sodipodi:cx="85.361748"
+         sodipodi:cy="209.81058"
+         sodipodi:r1="14.925182"
+         sodipodi:r2="7.4625912"
+         sodipodi:arg1="0"
+         sodipodi:arg2="1.0471976"
+         inkscape:rounded="0"
+         inkscape:randomized="0"
+         d="M 100.28693,209.81058 77.899157,222.73616 V 196.88499 Z"
+         transform="matrix(0.26800343,0,0,0.27078074,-5.6921532,90.920689)"
+         inkscape:transform-center-x="-0.99999968" /><path
+         style="opacity:0.743697;fill:#b4b4b4;fill-opacity:1;stroke:none;stroke-width:0.369565;stroke-linecap:square;paint-order:stroke fill markers"
+         id="path4"
+         sodipodi:type="arc"
+         sodipodi:cx="37.577106"
+         sodipodi:cy="147.73335"
+         sodipodi:rx="3"
+         sodipodi:ry="3"
+         sodipodi:start="0"
+         sodipodi:end="6.2779229"
+         sodipodi:open="true"
+         sodipodi:arc-type="arc"
+         d="m 40.577106,147.73335 a 3,3 0 0 1 -2.996053,3 3,3 0 0 1 -3.003936,-2.9921 3,3 0 0 1 2.988149,-3.00787 3,3 0 0 1 3.011799,2.98419" /><path
+         style="opacity:1;fill:#ffff00;fill-opacity:1;stroke:none;stroke-width:0.369565;stroke-linecap:square;paint-order:stroke fill markers"
+         id="path4-0"
+         sodipodi:type="arc"
+         sodipodi:cx="113.92616"
+         sodipodi:cy="147.73335"
+         sodipodi:rx="3"
+         sodipodi:ry="3"
+         sodipodi:start="0"
+         sodipodi:end="6.2779229"
+         sodipodi:open="true"
+         sodipodi:arc-type="arc"
+         d="m 116.92616,147.73335 a 3,3 0 0 1 -2.99605,3 3,3 0 0 1 -3.00394,-2.9921 3,3 0 0 1 2.98815,-3.00787 3,3 0 0 1 3.0118,2.98419" /><path
+         sodipodi:type="star"
+         style="opacity:1;fill:#ffff00;fill-opacity:1;stroke:none;stroke-width:0.391001;stroke-linecap:square;paint-order:stroke fill markers"
+         id="path3-5"
+         inkscape:flatsided="true"
+         sodipodi:sides="3"
+         sodipodi:cx="85.361748"
+         sodipodi:cy="209.81058"
+         sodipodi:r1="14.925182"
+         sodipodi:r2="7.4625912"
+         sodipodi:arg1="0"
+         sodipodi:arg2="1.0471976"
+         inkscape:rounded="0"
+         inkscape:randomized="0"
+         d="M 100.28693,209.81058 77.899157,222.73616 V 196.88499 Z"
+         transform="matrix(0.26800343,0,0,0.27078074,123.75904,90.920689)"
+         inkscape:transform-center-x="-0.99999968" /></g></g></svg>
