Cursor
======

.. py:module:: Nets
    :noindex:

.. py:class:: Cursor

    Position cursors on oscilloscope and take cursor measurements.

    .. py:method:: hide()

        Hide cursors from screen

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            v33_net.cursor.hide()

    .. py:method:: set_a(x=None, y=None)

        Set position of cursor a to (x,y)

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            v33_net.cursor.set_a(x=1, y=2)

        :param float x: x coordinate of cursor a
        :param float y: y coordinate of cursor a

    .. py:method:: set_b(x=None, y=None)

        Set position of cursor b to (x,y)

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            v33_net.cursor.set_b(x=1, y=2)

        :param float x: x coordinate of cursor b
        :param float y: y coordinate of cursor b  

    .. py:method:: get_a()

        Get (x,y) coordinates of cursor a

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            (x,y) = v33_net.cursor.get_a()
            print(f"{x},{y}")

        :return: (x,y) coordinate
        :rtype: float 

    .. py:method:: get_b()

        Get (x,y) coordinates of cursor b

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            (x,y) = v33_net.cursor.get_b()
            print(f"{x},{y}")

        :return: (x,y) coordinate
        :rtype: float                       

    .. py:method:: move_a(x_del=None, y_del=None)

        Move a cursor by delta x and delta y

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            v33_net.cursor.move_a(x_dex=10, y_del=2)

        :param float x_del: move x by delta
        :param float y_del: move y by delta

    .. py:method:: move_b(x_del=None, y_del=None)

        Move b cursor by delta x and delta y

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            v33_net.cursor.move_b(x_dex=10, y_del=2)

        :param float x_del: move cursor a by delta x
        :param float y_del: move cursor a by delta y

    .. py:method:: x_delta()

        Get difference between a_x and b_x

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            delta_x = v33_net.cursor.x_delta()
            print(delta_x)

        :return: difference between a_x and b_x
        :rtype: float 

    .. py:method:: y_delta()

        Get difference between a_y and b_y

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            delta_y = v33_net.cursor.y_delta()
            print(delta_y)

        :return: difference between a_y and b_y
        :rtype: float 

    .. py:method:: inverse_x_delta()

        Get difference between invers of a_x and b_x

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            inv_del_x = v33_net.cursor.inverse_x_delta()
            print(inv_del_x)

        :return: difference between inverse of a_x and b_x
        :rtype: float        

    .. py:method:: a_x()

        Get x position of cursor a

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            a_x = v33_net.cursor.a_x()
            print(a_x)

        :return: x position of cursor a
        :rtype: float 

    .. py:method:: a_y()

        Get y position of cursor a

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            a_y = v33_net.cursor.a_y()
            print(a_y)

        :return: y position of cursor a
        :rtype: float         

    .. py:method:: b_x()

        Get x position of cursor b

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            b_x = v33_net.cursor.b_x()
            print(b_x)

        :return: x position of cursor b
        :rtype: float 

    .. py:method:: b_y()

        Get y position of cursor b

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            b_y = v33_net.cursor.b_y()
            print(b_y)

        :return: y position of cursor b
        :rtype: float