Command/Inst refactor: Acquire (and Kernel, Discriminator)

qiskit/pulse/__init__.py

@@ -133,14 +133,14 @@
 from .channels import (DriveChannel, MeasureChannel, AcquireChannel,
                        ControlChannel, RegisterSlot, MemorySlot)
 from .cmd_def import CmdDef
-from .commands import (Acquire, AcquireInstruction, FrameChange,
-                       PersistentValue, SamplePulse, Snapshot, Kernel,
-                       Discriminator, Delay, ParametricPulse,
+from .commands import (AcquireInstruction, FrameChange,
+                       PersistentValue, SamplePulse, Snapshot,
+                       Delay, ParametricPulse,
                        ParametricInstruction, Gaussian,
                        GaussianSquare, Drag, ConstantPulse, functional_pulse)
-from .configuration import LoConfig, LoRange
+from .configuration import LoConfig, LoRange, Kernel, Discriminator
 from .exceptions import PulseError
 from .instruction_schedule_map import InstructionScheduleMap
-from .instructions import Instruction
+from .instructions import Acquire, Instruction
 from .interfaces import ScheduleComponent
 from .schedule import Schedule

qiskit/pulse/commands/acquire.py

@@ -12,102 +12,22 @@
 # copyright notice, and modified files need to carry a notice indicating
 # that they have been altered from the originals.
 
-"""
-Acquire.
-"""
+"""Acquire. Deprecated path."""
 import warnings
+
 from typing import Optional, Union, List
 
-from qiskit.pulse.exceptions import PulseError
 from ..channels import MemorySlot, RegisterSlot, AcquireChannel
-from ..instructions import Instruction
-from .meas_opts import Discriminator, Kernel
-from .command import Command
-
-
-class Acquire(Command):
-    """Acquire."""
-
-    ALIAS = 'acquire'
-    prefix = 'acq'
-
-    def __init__(self, duration: int, kernel: Optional[Kernel] = None,
-                 discriminator: Optional[Discriminator] = None,
-                 name: Optional[str] = None):
-        """Create new acquire command.
-
-        Args:
-            duration: Duration of acquisition
-            kernel: The data structures defining the measurement kernels
-                to be used (from the list of available kernels) and set of parameters
-                (if applicable) if the measurement level is 1 or 2.
-            discriminator: Discriminators to be used (from the list of available discriminator)
-                if the measurement level is 2
-            name: Name of this command.
+from ..exceptions import PulseError
 
-        Raises:
-            PulseError: when invalid discriminator or kernel object is input.
-        """
-        super().__init__(duration=duration)
+# pylint: disable=unused-import
 
-        self._name = Acquire.create_name(name)
-
-        if kernel and not isinstance(kernel, Kernel):
-            raise PulseError('Invalid kernel object is specified.')
-        self._kernel = kernel
-
-        if discriminator and not isinstance(discriminator, Discriminator):
-            raise PulseError('Invalid discriminator object is specified.')
-        self._discriminator = discriminator
-
-    @property
-    def kernel(self):
-        """Return kernel settings."""
-        return self._kernel
-
-    @property
-    def discriminator(self):
-        """Return discrimination settings."""
-        return self._discriminator
-
-    def __eq__(self, other: 'Acquire'):
-        """Two Acquires are the same if they are of the same type
-        and have the same kernel and discriminator.
-
-        Args:
-            other: Other Acquire
-
-        Returns:
-            bool: are self and other equal.
-        """
-        return (super().__eq__(other) and
-                self.kernel == other.kernel and
-                self.discriminator == other.discriminator)
-
-    def __hash__(self):
-        return hash((super().__hash__(), self.kernel, self.discriminator))
-
-    def __repr__(self):
-        return '%s(duration=%d, kernel=%s, discriminator=%s, name="%s")' % \
-               (self.__class__.__name__, self.duration, self.name,
-                self.kernel, self.discriminator)
-
-    # pylint: disable=arguments-differ
-    def to_instruction(self,
-                       qubit: Union[AcquireChannel, List[AcquireChannel]],
-                       mem_slot: Optional[Union[MemorySlot, List[MemorySlot]]] = None,
-                       reg_slots: Optional[Union[RegisterSlot, List[RegisterSlot]]] = None,
-                       mem_slots: Optional[Union[List[MemorySlot]]] = None,
-                       reg_slot: Optional[RegisterSlot] = None,
-                       name: Optional[str] = None) -> 'AcquireInstruction':
-
-        return AcquireInstruction(self, qubit, mem_slot=mem_slot, reg_slot=reg_slot,
-                                  mem_slots=mem_slots, reg_slots=reg_slots, name=name)
-    # pylint: enable=arguments-differ
+from ..instructions import Acquire
+from ..instructions import Instruction
 
 
 class AcquireInstruction(Instruction):
-    """Pulse to acquire measurement result."""
+    """Deprecated."""
 
     def __init__(self,
                  command: Acquire,
@@ -118,6 +38,12 @@ def __init__(self,
                  reg_slot: Optional[RegisterSlot] = None,
                  name: Optional[str] = None):
 
+        warnings.warn("The ``AcquireInstruction`` has been deprecated. Please use Acquire with "
+                      "channels instead. For example, AcquireInstruction(Acquire(duration), "
+                      "AcquireChannel(0), MemorySlot(0)) becomes Acquire(duration, "
+                      "AcquireChannel(0), MemorySlot(0)).",
+                      DeprecationWarning)
+
         if isinstance(acquire, list) or isinstance(mem_slot, list) or reg_slots:
             warnings.warn('The AcquireInstruction on multiple qubits, multiple '
                           'memory slots and multiple reg slots is deprecated. The '

qiskit/pulse/commands/meas_opts.py

@@ -12,77 +12,9 @@
 # copyright notice, and modified files need to carry a notice indicating
 # that they have been altered from the originals.
 
-# pylint: disable=missing-param-doc,useless-super-delegation
+"""Measurement options. Deprecated path."""
 
-"""
-Measurement options.
-"""
+# pylint: disable=unused-import
 
-from typing import Optional
 
-
-class MeasOpts:
-    """Measurement options."""
-
-    def __init__(self, name: Optional[str] = None, **params):
-        """Create new measurement options.
-
-        Parameters:
-            name: Name of measurement option to be used.
-        """
-        self._name = name
-        self._params = params
-
-    @property
-    def name(self):
-        """Return parameter name."""
-        return self._name
-
-    @property
-    def params(self):
-        """Return parameter dict."""
-        return self._params
-
-    def __eq__(self, other: 'MeasOpts'):
-        """Two measurement options are the same if they are of the same type
-        and have the same name and params.
-
-        Args:
-            other: Other Discriminator/Kernel
-
-        Returns:
-            bool: are self and other equal
-        """
-        return (type(self) is type(other) and
-                self.name == other.name and
-                self.params == other.params)
-
-    def __hash__(self):
-        return hash((super().__hash__(), self.name, self.params))
-
-    def __repr__(self):
-        return '%s(%s)' % (self.__class__.__name__, self.name)
-
-
-class Discriminator(MeasOpts):
-    """Discriminator."""
-
-    def __init__(self, name: Optional[str] = None, **params):
-        """Create new discriminator.
-
-        Parameters:
-            name: Name of discriminator to be used
-        """
-        super().__init__(name, **params)
-
-
-class Kernel(MeasOpts):
-    """Kernel."""
-
-    def __init__(self, name: Optional[str] = None, **params):
-        """Create new kernel.
-
-        Parameters:
-            name: Name of kernel to be used
-        """
-        super().__init__(name, **params)
+from qiskit.pulse.configuration import Kernel, Discriminator

qiskit/pulse/configuration.py

@@ -21,6 +21,46 @@
 from .exceptions import PulseError
 
 
+class Kernel:
+    """Settings for this Kernel, which is responsible for integrating time series (raw) data
+    into IQ points.
+    """
+
+    def __init__(self, name: Optional[str] = None, **params):
+        """Create new kernel.
+
+        Args:
+            name: Name of kernel to be used
+            params: Any settings for kerneling.
+        """
+        self.name = name
+        self.params = params['params']
+
+    def __repr__(self):
+        return "{}({}{})".format(self.__class__.__name__,
+                                 "'" + self.name + "', " or "",
+                                 self.params)
+
+
+class Discriminator:
+    """Setting for this Discriminator, which is responsible for classifying kerneled IQ points
+    into 0/1 state results.
+    """
+
+    def __init__(self, name: Optional[str] = None, **params):
+        """Create new discriminator.
+
+        Args:
+            name: Name of discriminator to be used
+            params: Any settings for discrimination.
+        """
+        self.name = name
+        self.params = params['params']
+
+    def __repr__(self):
+        return "{}({}{})".format(self.__class__.__name__,
+                                 "'" + self.name + "', " or "",
+                                 self.params)
 class LoRange:
     """Range of LO frequency."""
 

qiskit/pulse/instructions/__init__.py

@@ -21,4 +21,5 @@
 An instruction can be added to a :py:class:`~qiskit.pulse.Schedule`, which is a
 sequence of scheduled Pulse ``Instruction`` s over many channels.
 """
+from .acquire import Acquire
 from .instruction import Instruction