KaptureControlGui/KCG/Documentation/source/Dev/code/widgets/timingWidget.rst

.. This is a autogemerated documentation from python docstrings. It was generated using DStrings2Doc.


.. module:: timingWidget


.. _timingWidget:



Module timingWidget
===================


This Module Is the Timingsettings subWindow.  

.. py:class:: timingPlotWidget(kcgw.KCGWidgets)

    The Timescan result plot subwindow.  

    .. py:method:: __init__(self, unique_id, board_id, parent=None)

        Initialises the timing plot window  

        :param unique_id: the id for this window  
        :param parent: parent object  

    .. py:method:: switch(self)

        Switch Plot types  


    .. py:method:: colour_plot(self)

        Initialize Color Plot  


    .. py:method:: remove_colour_plot(self)

        Remove the color plot elements  


    .. py:method:: line_plot_axis_strings(self, values, scale, spacing)

        Plot to format the strings for the line plot  
        This is used to override the default tickStrings method of pyqtgraph.AxisItem  

        :param values: See pyqtgraph.AxisItem.tickStrings  
        :param scale: See pyqtgraph.AxisItem.tickStrings  
        :param spacing: See pyqtgraph.AxisItem.tickStrings  
        :return: See pyqtgraph.AxisItem.tickStrings  

    .. py:method:: spacing(self, minVal, maxVal, size)

        Calculate spacing between ticks  
        This is used to override the default tickSpacing method of pyqtgraph.AxisItem  

        :param minVal: See pyqtgraph.AxisItem.tickSpacing  
        :param maxVal: See pyqtgraph.AxisItem.tickSpacing  
        :param size: See pyqtgraph.AxisItem.tickSpacing  
        :return: See pyqtgraph.AxisItem.tickSpacing  

    .. py:method:: y_axis_strings(self, values, scale, spacing)

        Sets the strings for the y axis  

        :param values:  
        :param scale:  
        :param spacing:  

    .. py:method:: line_plot(self)

        Initialise the Line Plot  


    .. py:method:: setInputs(self, coarse_input, fine_inputs)

        Register the Inputfields for timing in the timingsettings window  

        :param coarse_input: (QSpinBox) Spinbox for coarse timing settings  
        :param fine_inputs: (list) List of (QSpinBox)es for fine timing settings  

    .. py:method:: click(self, adc, event)

        Handler for the click event in color plots  

        :param adc: (str) The ADC plot that was clicked on  
        :param event: (QEvent) the event  

    .. py:method:: plot(self, data=None, levels=None, newTitle=None, maxima=None)

        Plot Data  

        :param data: (numpy 4d array) data to plot  
        :param levels: (tuple) Min and Max Values for color plot  
        :param newTitle: (str) The title for the window  
        :param maxima: (list) Maximum for each adc  

    .. py:method:: closeEvent(self, event)

        Event handler for closing this window  

.. py:class:: timingPart(kcgw.KCGWidgets)

    The actual timing settings window  

    .. py:method:: __init__(self, board_id, parent=None)

        Initialise the timing settings window  

        :param unique_id:  
        :param parent:  

    .. py:method:: toggleAdc1IndividualDelay(self)

        Toggle to use an individual delay for adc1 or not  


    .. py:method:: showTimeScan(self)

        Show the time scan part of this window  


    .. py:method:: time_scan(self)

        Toggle timescan and create timingPlotWidget if it doesn't exist  


    .. py:method:: setValueSilent(self, element, value)

        Set Values to inputs without notifying observers  

        :param element: the input  
        :param value: the value  

    .. py:method:: setValues(self)

        Set Values to inputs (initially)  


    .. py:method:: closeEvent(self, event)

        Event handler when this window is closed  

    .. py:method:: on_adc_delay_changed(self)

        Handler that gets called when an adc delay gets changed  

.. py:class:: timingWidget(kcgw.KCGWidgets)

    This is the container that holds the tab widget which contains the timing widgets for each board  

    .. py:method:: __init__(self, unique_id, parent=None)


    .. py:method:: adjustSizeForTimeScan(self)

        Adjust the size of the widget to accomodate the time_scan part  


    .. py:method:: closeEvent(self, event)


.. py:method:: addTimingWidget()

    Add this widget to the gui.  
    This function will actually open the subwindow.