Skip to content

Collection

DragPointCollection

A collection of DragPoints used to implement complex interactive functions. All collections of DragPoints must inherit from DragPointCollection and implement the following methods:

  • function: f(x, *args) that returns a float.
  • update: updates DragPointCollection.poly with DragPointCollection.dragpoints positions.
  • get_args: returns arguments needed for function (*args). Must be derived from DragPointCollection.dragpoints positions.
Source code in itfit/utils/collection.py 
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
class DragPointCollection:
    """A collection of DragPoints used to implement complex interactive functions.
    All collections of DragPoints must inherit from DragPointCollection and implement the following methods:

    * function: `f(x, *args)` that returns a float.
    * update: updates `DragPointCollection.poly` with `DragPointCollection.dragpoints` positions.
    * get_args: returns arguments needed for function (`*args`). Must be derived from `DragPointCollection.dragpoints` positions.
    """

    @staticmethod
    def function(*args, **kargs): ... 
    @staticmethod
    def get_args_length():...
    def update(self, *args, **kargs):...
    def get_args(self):...

    # Common methods
    def __init__(self, dragpoints: list[DragPoint], blit_manager: BlitManager, *, linestyle='-', color='red'):
        """Collection of DragPoints. Used to implement more complicated DragObjects.

        Args:
            dragpoints (list[DragPoint]): collection vertices.
            blit_manager (BlitManager): used for automtic ploting.
        """

        self.dragpoints = dragpoints
        self.blit_manager = blit_manager

        self.ax = blit_manager.ax
        self.canvas = blit_manager.canvas

        self.poly = Line2D(
            self.get_xdata_display(),
            self.get_ydata_display(),
            linestyle=linestyle,
            color=color,
            transform=None
        )

        self.patch = self.blit_manager.ax.add_patch(self.poly)  

    def get_xy(self, *args):
        """Applies and returns correct transformation from display to data coordinates.

        Parameters:
            *args (List[float,float] | List[List[float,float],...]):
                Coordinates from display.
        Returns:
            (Tuple[float,float] | Tuple[Tuple[float,float],...]):
                Coordinates from data.
        """

        args  = args if len(args)==2 else args[0]
        return self.ax.transData.inverted().transform(args)

    def set_xy(self, *args):
        """Applies and returns correct transformation from data coordinates to display.

        Parameters:
            *args (List[float] | List[List[float,float]]):
                Coordinates from data.
        Returns:
            (Tuple[float] | Tuple[Tuple[float,float]]):
                Coordinates from display.
        """
        args  = args if len(args)==2 else args[0]
        return self.ax.transData.transform(args)

    def get_xdata_display(self):
        """Gets xdata from DragPoints in display coordinates.

        Returns:
            (Tuple[float]):
                x in display coordinates.
        """

        return [p.get_center()[0] for p in self.dragpoints]

    def get_ydata_display(self):
        """Gets ydata from DragPoints in display coordinates.

        Returns:
            (Tuple[float]):
                y in display coordinates.
        """
        return [p.get_center()[1] for p in self.dragpoints]

    def get_xdata(self):
        """Gets xdata from DragPoints in data coordinates.

        Returns:
            (Tuple[float]):
                x in data coordinates.
        """
        return [self.get_xy(*p.get_center())[0] for p in self.dragpoints]

    def get_ydata(self):
        """Gets ydata from DragPoints in data coordinates.

        Returns:
            (Tuple[float]):
                y in data coordinates.
        """
        return [self.get_xy(*p.get_center())[1] for p in self.dragpoints]

    def remove(self):
        """Removes the patch from the axes."""
        self.patch.remove()

__init__(dragpoints, blit_manager, *, linestyle='-', color='red')

Collection of DragPoints. Used to implement more complicated DragObjects.

Parameters:

Name Type Description Default
dragpoints list[DragPoint]

collection vertices.

 required
blit_manager BlitManager

used for automtic ploting.

 required
Source code in itfit/utils/collection.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def __init__(self, dragpoints: list[DragPoint], blit_manager: BlitManager, *, linestyle='-', color='red'):
    """Collection of DragPoints. Used to implement more complicated DragObjects.

    Args:
        dragpoints (list[DragPoint]): collection vertices.
        blit_manager (BlitManager): used for automtic ploting.
    """

    self.dragpoints = dragpoints
    self.blit_manager = blit_manager

    self.ax = blit_manager.ax
    self.canvas = blit_manager.canvas

    self.poly = Line2D(
        self.get_xdata_display(),
        self.get_ydata_display(),
        linestyle=linestyle,
        color=color,
        transform=None
    )

    self.patch = self.blit_manager.ax.add_patch(self.poly)

get_xdata()

Gets xdata from DragPoints in data coordinates.

Returns:

Type Description
Tuple[float]

x in data coordinates.
Source code in itfit/utils/collection.py 
106
107
108
109
110
111
112
113
def get_xdata(self):
    """Gets xdata from DragPoints in data coordinates.

    Returns:
        (Tuple[float]):
            x in data coordinates.
    """
    return [self.get_xy(*p.get_center())[0] for p in self.dragpoints]

get_xdata_display()

Gets xdata from DragPoints in display coordinates.

Returns:

Type Description
Tuple[float]

x in display coordinates.
Source code in itfit/utils/collection.py 
87
88
89
90
91
92
93
94
95
def get_xdata_display(self):
    """Gets xdata from DragPoints in display coordinates.

    Returns:
        (Tuple[float]):
            x in display coordinates.
    """

    return [p.get_center()[0] for p in self.dragpoints]

get_xy(*args)

Applies and returns correct transformation from display to data coordinates.

Parameters:

Name Type Description Default
*args List[float, float] | List[List[float, float], ...]

Coordinates from display.

 ()

Returns:

Type Description
Tuple[float, float] | Tuple[Tuple[float, float], ...]

Coordinates from data.
Source code in itfit/utils/collection.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
def get_xy(self, *args):
    """Applies and returns correct transformation from display to data coordinates.

    Parameters:
        *args (List[float,float] | List[List[float,float],...]):
            Coordinates from display.
    Returns:
        (Tuple[float,float] | Tuple[Tuple[float,float],...]):
            Coordinates from data.
    """

    args  = args if len(args)==2 else args[0]
    return self.ax.transData.inverted().transform(args)

get_ydata()

Gets ydata from DragPoints in data coordinates.

Returns:

Type Description
Tuple[float]

y in data coordinates.
Source code in itfit/utils/collection.py 
115
116
117
118
119
120
121
122
def get_ydata(self):
    """Gets ydata from DragPoints in data coordinates.

    Returns:
        (Tuple[float]):
            y in data coordinates.
    """
    return [self.get_xy(*p.get_center())[1] for p in self.dragpoints]

get_ydata_display()

Gets ydata from DragPoints in display coordinates.

Returns:

Type Description
Tuple[float]

y in display coordinates.
Source code in itfit/utils/collection.py 
 97
 98
 99
100
101
102
103
104
def get_ydata_display(self):
    """Gets ydata from DragPoints in display coordinates.

    Returns:
        (Tuple[float]):
            y in display coordinates.
    """
    return [p.get_center()[1] for p in self.dragpoints]

remove()

Removes the patch from the axes.

Source code in itfit/utils/collection.py 
124
125
126
def remove(self):
    """Removes the patch from the axes."""
    self.patch.remove()

set_xy(*args)

Applies and returns correct transformation from data coordinates to display.

Parameters:

Name Type Description Default
*args List[float] | List[List[float, float]]

Coordinates from data.

 ()

Returns:

Type Description
Tuple[float] | Tuple[Tuple[float, float]]

Coordinates from display.
Source code in itfit/utils/collection.py 
74
75
76
77
78
79
80
81
82
83
84
85
def set_xy(self, *args):
    """Applies and returns correct transformation from data coordinates to display.

    Parameters:
        *args (List[float] | List[List[float,float]]):
            Coordinates from data.
    Returns:
        (Tuple[float] | Tuple[Tuple[float,float]]):
            Coordinates from display.
    """
    args  = args if len(args)==2 else args[0]
    return self.ax.transData.transform(args)