Split AnalogIn into it's own module so that documentation makes a little more sese

Author: philipstarkey

docs/source/api/index.rst

@@ -9,6 +9,7 @@ API Reference
 
 	labscript.core
 	labscript.outputs
+	labscript.inputs
 	labscript.remote
 	labscript.constants
 	labscript.labscript

docs/source/connection_table.rst

@@ -9,7 +9,7 @@ Here we see two :py:class:`PseudoclockDevice <labscript.core.PseudoclockDevice>`
 
 Each :py:class:`PseudoclockDevice <labscript.core.PseudoclockDevice>` instance should have one or more :py:class:`Pseudoclock <labscript.core.Pseudoclock>` children. Some :py:class:`PseudoclockDevice <labscript.core.PseudoclockDevice>` instances may automatically create these children for you (check the device specific documentation). In turn, each :py:class:`Pseudoclock <labscript.core.Pseudoclock>` will have one of more :py:class:`ClockLine <labscript.core.ClockLine>` instances connected to it. These :py:class:`ClockLine <labscript.core.ClockLine>` instances generally refer to physical outputs of a device which will be used to clock another device. However, in some cases, one or more :py:class:`ClockLine <labscript.core.ClockLine>` instances may be internally created for you (check the device specific documentation).
 
-If a device is not a :py:class:`PseudoclockDevice <labscript.core.PseudoclockDevice>`, it must be connected to one via a clockline. such devices inherit from :py:class:`IntermediateDevice <labscript.core.IntermediateDevice>`. Inputs and outputs are then connected to these devices. For example, :py:class:`DigitalOut <labscript.outputs.DigitalOut>`, :py:class:`AnalogOut <labscript.outputs.AnalogOut>`, and :py:class:`DDS <labscript.outputs.DDS>`. See :py:mod:`labscript.outputs` for a complete list. Note that devices determine what types of inputs and outputs can be connected, see :doc:`labscript-devices <labscript-devices:index>` for device information.
+If a device is not a :py:class:`PseudoclockDevice <labscript.core.PseudoclockDevice>`, it must be connected to one via a clockline. such devices inherit from :py:class:`IntermediateDevice <labscript.core.IntermediateDevice>`. Inputs and outputs are then connected to these devices. For example, :py:class:`DigitalOut <labscript.outputs.DigitalOut>`, :py:class:`AnalogOut <labscript.outputs.AnalogOut>`, and :py:class:`DDS <labscript.outputs.DDS>`. See :py:mod:`labscript.outputs` and :py:mod:`labscript.inputs` for a complete list. Note that devices determine what types of inputs and outputs can be connected, see :doc:`labscript-devices <labscript-devices:index>` for device information.
 
 If a :py:class:`PseudoclockDevice <labscript.core.PseudoclockDevice>` also has outputs that are not used for a :py:class:`ClockLine <labscript.core.ClockLine>`, then an :py:class:`IntermediateDevice <labscript.core.IntermediateDevice>` is internally instantiated, and should be made available through the ``PseudoclockDevice.direct_outputs`` attribute (for example see the :py:class:`PulseBlaster <labscript_devices.PulseBlaster.PulseBlaster>` implementation).
 

labscript/inputs.py

@@ -0,0 +1,60 @@
+"""Classes for device channels that are inputs"""
+
+from .base import Device
+from .utils import set_passed_properties
+
+
+class AnalogIn(Device):
+    """Analog Input for use with all devices that have an analog input."""
+    description = "Analog Input"
+
+    @set_passed_properties(property_names={})
+    def __init__(
+        self, name, parent_device, connection, scale_factor=1.0, units="Volts", **kwargs
+    ):
+        """Instantiates an Analog Input.
+
+        Args:
+            name (str): python variable to assign this input to.
+            parent_device (:obj:`IntermediateDevice`): Device input is connected to.
+            scale_factor (float, optional): Factor to scale the recorded values by.
+            units (str, optional): Units of the input.
+            **kwargs: Keyword arguments passed to :func:`Device.__init__`.
+        """
+        self.acquisitions = []
+        self.scale_factor = scale_factor
+        self.units=units
+        Device.__init__(self, name, parent_device, connection, **kwargs)
+
+    def acquire(
+        self, label, start_time, end_time, wait_label="", scale_factor=None, units=None
+    ):
+        """Command an acquisition for this input.
+
+        Args:
+            label (str): Unique label for the acquisition. Used to identify the saved trace.
+            start_time (float): Time, in seconds, when the acquisition should start.
+            end_time (float): Time, in seconds, when the acquisition should end.
+            wait_label (str, optional): 
+            scale_factor (float): Factor to scale the saved values by.
+            units: Units of the input, consistent with the unit conversion class.
+
+        Returns:
+            float: Duration of the acquistion, equivalent to `end_time - start_time`.
+        """
+        if scale_factor is None:
+            scale_factor = self.scale_factor
+        if units is None:
+            units = self.units
+        self.acquisitions.append(
+            {
+                "start_time": start_time,
+                "end_time": end_time,
+                "label": label,
+                "wait_label": wait_label,
+                "scale_factor": scale_factor,
+                "units": units,
+            }
+        )
+        return end_time - start_time
+

labscript/labscript.py

@@ -62,9 +62,9 @@
     PseudoclockDevice,
     TriggerableDevice,
 )
+from .inputs import AnalogIn
 from .outputs import (
     Output,
-    AnalogIn,
     AnalogOut,
     AnalogQuantity,
     DDS,

labscript/outputs.py

@@ -1,3 +1,5 @@
+"""Classes for devices channels that out outputs"""
+
 import sys
 
 import numpy as np
@@ -1492,61 +1494,6 @@ class StaticDigitalOut(StaticDigitalQuantity):
     description = "static digital output"
 
 
-class AnalogIn(Device):
-    """Analog Input for use with all devices that have an analog input."""
-    description = "Analog Input"
-
-    @set_passed_properties(property_names={})
-    def __init__(
-        self, name, parent_device, connection, scale_factor=1.0, units="Volts", **kwargs
-    ):
-        """Instantiates an Analog Input.
-
-        Args:
-            name (str): python variable to assign this input to.
-            parent_device (:obj:`IntermediateDevice`): Device input is connected to.
-            scale_factor (float, optional): Factor to scale the recorded values by.
-            units (str, optional): Units of the input.
-            **kwargs: Keyword arguments passed to :func:`Device.__init__`.
-        """
-        self.acquisitions = []
-        self.scale_factor = scale_factor
-        self.units=units
-        Device.__init__(self, name, parent_device, connection, **kwargs)
-
-    def acquire(
-        self, label, start_time, end_time, wait_label="", scale_factor=None, units=None
-    ):
-        """Command an acquisition for this input.
-
-        Args:
-            label (str): Unique label for the acquisition. Used to identify the saved trace.
-            start_time (float): Time, in seconds, when the acquisition should start.
-            end_time (float): Time, in seconds, when the acquisition should end.
-            wait_label (str, optional): 
-            scale_factor (float): Factor to scale the saved values by.
-            units: Units of the input, consistent with the unit conversion class.
-
-        Returns:
-            float: Duration of the acquistion, equivalent to `end_time - start_time`.
-        """
-        if scale_factor is None:
-            scale_factor = self.scale_factor
-        if units is None:
-            units = self.units
-        self.acquisitions.append(
-            {
-                "start_time": start_time,
-                "end_time": end_time,
-                "label": label,
-                "wait_label": wait_label,
-                "scale_factor": scale_factor,
-                "units": units,
-            }
-        )
-        return end_time - start_time
-
-
 class Shutter(DigitalOut):
     """Customized version of :obj:`DigitalOut` that accounts for the open/close
     delay of a shutter automatically.