Skip to content

Data classes

DataContainer

Container for data.

Source code in itfit/data/data_classes.py 
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
class DataContainer:
    """Container for data.
    """
    def __init__(self, xdata: list, ydata: list, yerr: list|None=None, xerr: list|None=None):
        """Creates a DataContainer.

        Parameters:
            xdata (list[float]):
                x data.
            ydata (list[float]):
                y data.
            yerr (list | None, optional): 
                Error en y data. Defaults to None.
            xerr (list | None, optional): 
                Error in x data. Defaults to None.
        """
        self.xdata = np.array(xdata).copy()
        self.ydata = np.array(ydata).copy()
        self.xerr  = np.array(xerr).copy() if xerr is not None else None
        self.yerr  = np.array(yerr).copy() if yerr is not None else None

    def length(self):
        """Returns lenght of data.

        Returns:
            (int):
                lenght of data.
        """
        return self.xdata.size

    def get_data(self):
        """Returns data. As list of tuples: `lenght x 2`.

        Returns:
            (tuple[tuple[float, float]]):
                Data stored.
        """
        return np.array((self.xdata, self.ydata)).T

    def get_errors(self):
        """Returns data errors. A list of tuples: `lenght x2`.

        Returns:
            (tuple[tuple[float,float]]): 
                Errors in data stored.
        """
        return np.array((self.xerr, self.yerr), dtype=object).T

__init__(xdata, ydata, yerr=None, xerr=None)

Creates a DataContainer.

Parameters:

Name Type Description Default
xdata list[float]

x data.

 required
ydata list[float]

y data.

 required
yerr list | None

Error en y data. Defaults to None.

 None
xerr list | None

Error in x data. Defaults to None.

 None
Source code in itfit/data/data_classes.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
def __init__(self, xdata: list, ydata: list, yerr: list|None=None, xerr: list|None=None):
    """Creates a DataContainer.

    Parameters:
        xdata (list[float]):
            x data.
        ydata (list[float]):
            y data.
        yerr (list | None, optional): 
            Error en y data. Defaults to None.
        xerr (list | None, optional): 
            Error in x data. Defaults to None.
    """
    self.xdata = np.array(xdata).copy()
    self.ydata = np.array(ydata).copy()
    self.xerr  = np.array(xerr).copy() if xerr is not None else None
    self.yerr  = np.array(yerr).copy() if yerr is not None else None

get_data()

Returns data. As list of tuples: lenght x 2.

Returns:

Type Description
tuple[tuple[float, float]]

Data stored.
Source code in itfit/data/data_classes.py 
51
52
53
54
55
56
57
58
def get_data(self):
    """Returns data. As list of tuples: `lenght x 2`.

    Returns:
        (tuple[tuple[float, float]]):
            Data stored.
    """
    return np.array((self.xdata, self.ydata)).T

get_errors()

Returns data errors. A list of tuples: lenght x2.

Returns:

Type Description
tuple[tuple[float, float]]

Errors in data stored.
Source code in itfit/data/data_classes.py 
60
61
62
63
64
65
66
67
def get_errors(self):
    """Returns data errors. A list of tuples: `lenght x2`.

    Returns:
        (tuple[tuple[float,float]]): 
            Errors in data stored.
    """
    return np.array((self.xerr, self.yerr), dtype=object).T

length()

Returns lenght of data.

Returns:

Type Description
int

lenght of data.
Source code in itfit/data/data_classes.py 
42
43
44
45
46
47
48
49
def length(self):
    """Returns lenght of data.

    Returns:
        (int):
            lenght of data.
    """
    return self.xdata.size

DataSelection

Bases: DataContainer

Source code in itfit/data/data_classes.py 
 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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
class DataSelection(DataContainer):
    def __init__(self, xdata, ydata, yerr: list|None=None, xerr: list|None=None):
        super().__init__(xdata, ydata, yerr=yerr, xerr=xerr)
        self.indexes_used = np.ones(len(self.xdata), dtype=bool)  

        self._was_plotted: bool = False
        self.collection: RegularPolyCollection = None
        self._axes: Axes = None

    def create_selected_poly(self, ax: Axes):
        """Creates a poly collection of selected data. Adds it to the given ax.
        """
        if self._was_plotted:
            return
        self._was_plotted = True
        self._axes = ax

        self.collection_facecolors = self.get_colors(
            (0, 1, 0, 1), (1, 0, 0, 1))
        self.collection = RegularPolyCollection(
            6, sizes=(40,),
            facecolors=self.collection_facecolors,
            offsets=self.get_data(),
            offset_transform=self._axes.transData)

        self.collection_ = self._axes.add_collection(self.collection)

    def _update_poly(self):
        """Updates poly collection colors.
        """
        if self._was_plotted:
            self.collection.set_facecolors(self.get_colors((0, 1, 0, 1), (1, 0, 0, 1)))

    def select_all(self):
        """Selects all data.
        """
        self.indexes_used[:] = True
        self._update_poly()

    def select_none(self):
        """Unselect all data.
        """
        self.indexes_used[:] = False
        self._update_poly()

    def add_selection(self, indexes: list):
        """Adds `indexes` to `indexes_used`.

        Parameters:
            indexes (list): 
                list of index.
        """
        self.indexes_used[np.array(indexes)] = True
        self._update_poly()

    def selection(self, indexes):
        """Erase previous selected indexes. Adds `indexes` to `indexes_used`.

        Parameters:
            indexes (list):
                list of index.
        """
        self.indexes_used[:] = False
        self.add_selection(indexes)
        self._update_poly()

    def bool_selection(self, indexes_used):
        """Erase previous selected indexes. Sets new `indexes_used`.

        Parameters:
            indexes_used (list):
                list of booleans. True if index used, False otherwise.
        """
        self.indexes_used[:] = indexes_used[:]
        self._update_poly()

    def get_selected(self):
        """Returns the selected data.

        Returns:
            (tuple[tuple[float], tuple[float]]):
                tuple containing x and y selected data in arrays.
        """
        return self.xdata[self.indexes_used], self.ydata[self.indexes_used]

    def get_selected_errors(self):
        """Returns the selected data errors.

        Returns:
            (tuple[tuple[float], tuple[float]]):
                tuple containing x and y selected data errors in arrays.
        """
        return self.xerr[self.indexes_used] if self.xerr is not None else None, self.yerr[self.indexes_used] if self.yerr is not None else None

    def get_not_selected(self):
        """Returns the not selected data.

        Returns:
            (tuple[tuple[float], tuple[float]]):
                tuple containing x and y not selected data in arrays.
        """
        return self.xdata[~self.indexes_used], self.ydata[~self.indexes_used]

    def get_not_selected_errors(self):
        """Returns the not selected data errors.

        Returns:
            (tuple[tuple[float], tuple[float]]):
                tuple containing x and y not selected data errors in arrays.
        """
        return self.xdata[~self.indexes_used] if self.xerr is not None else None, self.ydata[~self.indexes_used] if self.yerr is not None else None

    def get_colors(self, color_in, color_out):
        """Returns a list of colours depending if same index data is selected or not.

        Parameters:
            color_in (tuple[float,float,float,float]):
                Colour for selected data.
            color_out (tuple[float,float,float,float]):
                Colour for unselected data.

        Returns:
            (tuple[tuple[float,float,float,float]]):
                A list of colours.
        """
        colors = np.zeros((self.length(),4))
        colors[self.indexes_used,:] = color_in[:]
        colors[~self.indexes_used,:] = color_out[:]
        return colors

    def copy(self):
        """Creates a copy of the data selection object.

        Returns:
            (DataSelection): A copy of the data selection object.
        """
        instance = DataSelection(self.xdata.copy(), 
                                 self.ydata.copy(), 
                                 self.yerr.copy() if self.yerr is not None else None, 
                                 self.xerr.copy() if self.xerr is not None else None)
        instance.indexes_used = self.indexes_used.copy()
        return instance

add_selection(indexes)

Adds indexes to indexes_used.

Parameters:

Name Type Description Default
indexes list

list of index.

 required
Source code in itfit/data/data_classes.py 
115
116
117
118
119
120
121
122
123
def add_selection(self, indexes: list):
    """Adds `indexes` to `indexes_used`.

    Parameters:
        indexes (list): 
            list of index.
    """
    self.indexes_used[np.array(indexes)] = True
    self._update_poly()

bool_selection(indexes_used)

Erase previous selected indexes. Sets new indexes_used.

Parameters:

Name Type Description Default
indexes_used list

list of booleans. True if index used, False otherwise.

 required
Source code in itfit/data/data_classes.py 
136
137
138
139
140
141
142
143
144
def bool_selection(self, indexes_used):
    """Erase previous selected indexes. Sets new `indexes_used`.

    Parameters:
        indexes_used (list):
            list of booleans. True if index used, False otherwise.
    """
    self.indexes_used[:] = indexes_used[:]
    self._update_poly()

copy()

Creates a copy of the data selection object.

Returns:

Type Description
DataSelection

A copy of the data selection object.
Source code in itfit/data/data_classes.py 
200
201
202
203
204
205
206
207
208
209
210
211
def copy(self):
    """Creates a copy of the data selection object.

    Returns:
        (DataSelection): A copy of the data selection object.
    """
    instance = DataSelection(self.xdata.copy(), 
                             self.ydata.copy(), 
                             self.yerr.copy() if self.yerr is not None else None, 
                             self.xerr.copy() if self.xerr is not None else None)
    instance.indexes_used = self.indexes_used.copy()
    return instance

create_selected_poly(ax)

Creates a poly collection of selected data. Adds it to the given ax.

Source code in itfit/data/data_classes.py 
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def create_selected_poly(self, ax: Axes):
    """Creates a poly collection of selected data. Adds it to the given ax.
    """
    if self._was_plotted:
        return
    self._was_plotted = True
    self._axes = ax

    self.collection_facecolors = self.get_colors(
        (0, 1, 0, 1), (1, 0, 0, 1))
    self.collection = RegularPolyCollection(
        6, sizes=(40,),
        facecolors=self.collection_facecolors,
        offsets=self.get_data(),
        offset_transform=self._axes.transData)

    self.collection_ = self._axes.add_collection(self.collection)

get_colors(color_in, color_out)

Returns a list of colours depending if same index data is selected or not.

Parameters:

Name Type Description Default
color_in tuple[float, float, float, float]

Colour for selected data.

 required
color_out tuple[float, float, float, float]

Colour for unselected data.

 required

Returns:

Type Description
tuple[tuple[float, float, float, float]]

A list of colours.
Source code in itfit/data/data_classes.py 
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
def get_colors(self, color_in, color_out):
    """Returns a list of colours depending if same index data is selected or not.

    Parameters:
        color_in (tuple[float,float,float,float]):
            Colour for selected data.
        color_out (tuple[float,float,float,float]):
            Colour for unselected data.

    Returns:
        (tuple[tuple[float,float,float,float]]):
            A list of colours.
    """
    colors = np.zeros((self.length(),4))
    colors[self.indexes_used,:] = color_in[:]
    colors[~self.indexes_used,:] = color_out[:]
    return colors

get_not_selected()

Returns the not selected data.

Returns:

Type Description
tuple[tuple[float], tuple[float]]

tuple containing x and y not selected data in arrays.
Source code in itfit/data/data_classes.py 
164
165
166
167
168
169
170
171
def get_not_selected(self):
    """Returns the not selected data.

    Returns:
        (tuple[tuple[float], tuple[float]]):
            tuple containing x and y not selected data in arrays.
    """
    return self.xdata[~self.indexes_used], self.ydata[~self.indexes_used]

get_not_selected_errors()

Returns the not selected data errors.

Returns:

Type Description
tuple[tuple[float], tuple[float]]

tuple containing x and y not selected data errors in arrays.
Source code in itfit/data/data_classes.py 
173
174
175
176
177
178
179
180
def get_not_selected_errors(self):
    """Returns the not selected data errors.

    Returns:
        (tuple[tuple[float], tuple[float]]):
            tuple containing x and y not selected data errors in arrays.
    """
    return self.xdata[~self.indexes_used] if self.xerr is not None else None, self.ydata[~self.indexes_used] if self.yerr is not None else None

get_selected()

Returns the selected data.

Returns:

Type Description
tuple[tuple[float], tuple[float]]

tuple containing x and y selected data in arrays.
Source code in itfit/data/data_classes.py 
146
147
148
149
150
151
152
153
def get_selected(self):
    """Returns the selected data.

    Returns:
        (tuple[tuple[float], tuple[float]]):
            tuple containing x and y selected data in arrays.
    """
    return self.xdata[self.indexes_used], self.ydata[self.indexes_used]

get_selected_errors()

Returns the selected data errors.

Returns:

Type Description
tuple[tuple[float], tuple[float]]

tuple containing x and y selected data errors in arrays.
Source code in itfit/data/data_classes.py 
155
156
157
158
159
160
161
162
def get_selected_errors(self):
    """Returns the selected data errors.

    Returns:
        (tuple[tuple[float], tuple[float]]):
            tuple containing x and y selected data errors in arrays.
    """
    return self.xerr[self.indexes_used] if self.xerr is not None else None, self.yerr[self.indexes_used] if self.yerr is not None else None

select_all()

Selects all data.

Source code in itfit/data/data_classes.py 
103
104
105
106
107
def select_all(self):
    """Selects all data.
    """
    self.indexes_used[:] = True
    self._update_poly()

select_none()

Unselect all data.

Source code in itfit/data/data_classes.py 
109
110
111
112
113
def select_none(self):
    """Unselect all data.
    """
    self.indexes_used[:] = False
    self._update_poly()

selection(indexes)

Erase previous selected indexes. Adds indexes to indexes_used.

Parameters:

Name Type Description Default
indexes list

list of index.

 required
Source code in itfit/data/data_classes.py 
125
126
127
128
129
130
131
132
133
134
def selection(self, indexes):
    """Erase previous selected indexes. Adds `indexes` to `indexes_used`.

    Parameters:
        indexes (list):
            list of index.
    """
    self.indexes_used[:] = False
    self.add_selection(indexes)
    self._update_poly()