pyafm/stack.tex: Add detail to the fig:pyafm:stack caption
authorW. Trevor King <wking@tremily.us>
Wed, 15 May 2013 21:00:36 +0000 (17:00 -0400)
committerW. Trevor King <wking@tremily.us>
Wed, 15 May 2013 21:00:36 +0000 (17:00 -0400)
We declare a new \tikzline command to make it easier to draw sample
lines in captions (which can't handle fragile commands).  Hopefully
the figure is intelligable to folks now :).

src/local_cmmds.tex
src/pyafm/stack.tex

index d7c9fc425f7d01d0c2cab4011ccd2f7a881d9f7c..0ebbb37ce14a66c0e3cc3515ad6733ed991b29fd 100644 (file)
 \newcommand{\stepper}{\citetalias{stepper}}
 \newcommand{\unfoldprotein}{\citetalias{unfold-protein}}
 
+% draw a line TikZ (useful for captions explaining figures)
+% usage: \tikzline{style}
+\DeclareRobustCommand{\tikzline}[1]{%
+  \protect\tikz \draw[#1] (0,0) -- (14pt,6pt);}
+
 % draw a thermometer in TikZ
 % usage: \thermometer{bulb-location}
 \newcommand{\thermometer}[1]{
index 69d2f75cfa62ff491dbd08744f2f05a98a3cbfd1..d020cde025a396f91dc16de694de9b6da49b8e49 100644 (file)
@@ -14,8 +14,20 @@ spectroscopy (\cref{fig:pyafm:stack}).
 
 \begin{figure}
   \tikzstack{}{black!20}
-  \caption{Dependency graph for my modular experiment control
-    stack.\label{fig:pyafm:stack}}
+  \caption{Dependency graph for my modular experiment control stack.
+    The dashed line (\tikzline{black!20,dashed}) separates the
+    software components (on the left) from their associated hardware
+    (on the right).  The data flow between components is shown with
+    arrows.  For example, the \stepper\ package calls \pycomedi, which
+    talks to the DAQ card, to write digital output that controls the
+    stepper motor (\tikzline{blue,->}, \cref{sec:pyafm:stepper}).  The
+    \pypiezo\ package, on the other hand, uses two-way communication
+    with the DAQ card (\tikzline{red,<->}), writing driving voltages
+    to position the piezo and recording photodiode voltages to monitor
+    the cantilever deflection (\cref{sec:pyafm:pypiezo}).  The
+    \pypid\ package measures the buffer temperature using a
+    thermocouple inserted in the fluid cell (\tikzline{purple,<-},
+    \cref{sec:pyafm:pypid}).\label{fig:pyafm:stack}}
 \end{figure}
 
 \subsection{Pycomedi}