gB%dZddlmZddlmZddlmZddlmZddl Z ddl m Z ddl mZdd lmZGd d eZGd d eZGddeZGddeZdS)av Drawing objects for pulse drawer. Drawing objects play two important roles: - Allowing unittests of visualization module. Usually it is hard for image files to be tested. - Removing program parser from each plotter interface. We can easily add new plotter. This module is based on the structure of matplotlib as it is the primary plotter of the pulse drawer. However this interface is agnostic to the actual plotter. Design concept ~~~~~~~~~~~~~~ When we think about dynamically updating drawings, it will be most efficient to update only the changed properties of drawings rather than regenerating entirely from scratch. Thus the core :py:class:`qiskit.visualization.pulse_v2.core.DrawerCanvas` generates all possible drawings in the beginning and then the canvas instance manages visibility of each drawing according to the end-user request. Data key ~~~~~~~~ In the abstract class ``ElementaryData`` common attributes to represent a drawing are specified. In addition, drawings have the `data_key` property that returns an unique hash of the object for comparison. This key is generated from a data type and the location of the drawing in the canvas. See py:mod:`qiskit.visualization.pulse_v2.types` for detail on the data type. If a data key cannot distinguish two independent objects, you need to add a new data type. The data key may be used in the plotter interface to identify the object. Drawing objects ~~~~~~~~~~~~~~~ To support not only `matplotlib` but also multiple plotters, those drawings should be universal and designed without strong dependency on modules in `matplotlib`. This means drawings that represent primitive geometries are preferred. It should be noted that there will be no unittest for each plotter API, which takes drawings and outputs image data, we should avoid adding a complicated geometry that has a context of the pulse program. For example, a pulse envelope is complex valued number array and may be represented by two lines with different colors associated with the real and the imaginary component. We can use two line-type objects rather than defining a new drawing that takes complex value. As many plotters don't support an API that visualizes complex-valued data arrays, if we introduced such a drawing and wrote a custom wrapper function on top of the existing API, it could be difficult to prevent bugs with the CI tools due to lack of the effective unittest. ) annotations)ABC)Enum)AnyN)Channel)types)VisualizationErrorcJeZdZdZdZ dddZedZdZdZ dS)ElementaryDataz0Base class of the pulse visualization interface.NF data_type str | Enumxvals np.ndarrayyvalschannelsChannel | list[Channel] | Nonemetadict[str, Any] | Noneignore_scalingboolstylesc^|rt|tr|g}t|tr|j}t ||_t j|t|_ t j|t|_ |pg|_ |pi|_ ||_ |pi|_dS)a Create new drawing. Args: data_type: String representation of this drawing. xvals: Series of horizontal coordinate that the object is drawn. yvals: Series of vertical coordinate that the object is drawn. channels: Pulse channel object bound to this drawing. meta: Meta data dictionary of the object. ignore_scaling: Set ``True`` to disable scaling. styles: Style keyword args of the object. This conforms to `matplotlib`. )dtypeN) isinstancerrvaluestrr nparrayobjectrrrrrr)selfr rrrrrrs \/granary/edev/quantum/lib/python3.11/site-packages/qiskit/visualization/pulse_v2/drawings.py__init__zElementaryData.__init__Ls*  " 8W55 " zH i & & (!IYXe6222 Xe6222 '/~2 JB ,l c tt|jj|jt |jt |jfS)z"Return unique hash of this object.)rhash __class____name__r tuplerrr s r!data_keyzElementaryData.data_keyosG $.)4>5;L;LeTXT^N_N_` a a   r#c@|jjd|jd|jdS)Nz(type=z, key=))r&r'r r*r)s r!__repr__zElementaryData.__repr__vs*.)WWWWt}WWWWr#cLt||jo|j|jkS)N)rr&r*)r others r!__eq__zElementaryData.__eq__ys"%00TT]en5TTr#NNFN)r r rrrrrrrrrrrr) r' __module__ __qualname____doc____hash__r"propertyr*r-r0r#r!r r Gs::H48&*$(,!#!#!#!#!#F  X XXXUUUUUr#r c0eZdZdZ ddfd ZxZS)LineDataztDrawing object to represent object appears as a line. This is the counterpart of `matplotlib.pyplot.plot`. FNr r r#np.ndarray | list[types.Coordinate]rfillrrrrrrrc f||_t|||||||dS)aHCreate new drawing. Args: data_type: String representation of this drawing. channels: Pulse channel object bound to this drawing. xvals: Series of horizontal coordinate that the object is drawn. yvals: Series of vertical coordinate that the object is drawn. fill: Set ``True`` to fill the area under curve. meta: Meta data dictionary of the object. ignore_scaling: Set ``True`` to disable scaling. styles: Style keyword args of the object. This conforms to `matplotlib`. r rrrrrrN)r;superr") r r rrr;rrrrr&s r!r"zLineData.__init__sL.  )      r#)FNNFN)r r rr:rr:r;rrrrrrrrrr'r2r3r4r" __classcell__r&s@r!r9r9}s]37&*$(,! ! ! ! ! ! ! ! ! ! ! r#r9c0eZdZdZ ddfd ZxZS)TextDataztDrawing object to represent object appears as a text. This is the counterpart of `matplotlib.pyplot.text`. NFr r rr:rtextrlatex str | Nonerrrrrrrc x||_|pd|_t||||||| dS)aCreate new drawing. Args: data_type: String representation of this drawing. channels: Pulse channel object bound to this drawing. xvals: Series of horizontal coordinate that the object is drawn. yvals: Series of vertical coordinate that the object is drawn. text: String to show in the canvas. latex: Latex representation of the text (if backend supports latex drawing). meta: Meta data dictionary of the object. ignore_scaling: Set ``True`` to disable scaling. styles: Style keyword args of the object. This conforms to `matplotlib`. r=N)rDrEr>r") r r rrrDrErrrrr&s r!r"zTextData.__init__sW2 [b  )      r#)NNNFN)r r rr:rr:rDrrErFrrrrrrrrr?rAs@r!rCrCs]!37&*$(,$ $ $ $ $ $ $ $ $ $ $ r#rCc.eZdZdZ ddfd ZxZS)BoxDataznDrawing object that represents box shape. This is the counterpart of `matplotlib.patches.Rectangle`. NFr r rr:rrrrrrrrc t|dkst|dkrtdt|||||||dS)a^Create new box. Args: data_type: String representation of this drawing. xvals: Left and right coordinate that the object is drawn. yvals: Top and bottom coordinate that the object is drawn. channels: Pulse channel object bound to this drawing. meta: Meta data dictionary of the object. ignore_scaling: Set ``True`` to disable scaling. styles: Style keyword args of the object. This conforms to `matplotlib`. Raises: VisualizationError: When number of data points are not equals to 2. z*Length of data points are not equals to 2.r=N)lenr r>r") r r rrrrrrr&s r!r"zBoxData.__init__sq0 u::??c%jjAoo$%QRR R )      r#r1)r r rr:rr:rrrrrrrrr?rAs@r!rJrJsZ48&*$(,# # # # # # # # # # # r#rJ)r4 __future__rabcrenumrtypingrnumpyrqiskit.pulse.channelsrqiskit.visualization.pulse_v2rqiskit.visualization.exceptionsr r r9rCrJr7r#r!rVsY,,Z#"""""))))))//////>>>>>>3U3U3U3U3US3U3U3Ul' ' ' ' ' ~' ' ' T* * * * * ~* * * Z) ) ) ) ) n) ) ) ) ) r#