Skip to content

plotting

plotting

Utilities for plot creation.

Plotter

Plot creator class.

Source code in cssfinder/reports/plotting.py 
 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
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
class Plotter:
    """Plot creator class."""

    def __init__(self, corrections: pd.DataFrame) -> None:
        """Initialize plot creator.

        Parameters
        ----------
        corrections : pandas.DataFrame
            A DataFrame containing the distance decay corrections. The DataFrame
            should have an "index" column and a "value" column.

        """
        self.corrections = corrections
        self.slope_props = SlopeProperties.find(self.corrections.to_numpy())

    def plot_corrections(self, axes: Optional[plt.Axes] = None) -> Plot:
        """Create a plot of distance decay corrections.

        Parameters
        ----------
        axes : Optional[plt.Axes], optional
            Optional axes object to reuse, when none is given, new figure is created,
            by default None

        Returns
        -------
        Plot
            Plot object containing plot axes.

        Notes
        -----
        The function creates a line plot of the distance decay corrections,
        with the "index" column on the x-axis and the "value" column on the
        y-axis. The plot includes a grid and axis labels, and a title indicating
        that it shows distance decay.

        The function returns the Plot object granting access to axes for the created
        plot, which can be further customized or saved using the methods of the
        matplotlib API.

        """
        if axes is None:
            plt.figure()
            axes = plt.subplot()

        axes.plot(
            self.corrections[["index"]],
            self.corrections[["value"]],
            label="correction",
        )
        axes.hlines(
            [self.slope_props.optimum],
            xmin=-10,
            xmax=self.corrections[["index"]].max(),
            color="red",
            label="H-S distance",
            linestyles="dashed",
        )
        axes.grid(visible=True)

        axes.set_xlabel("Correction index")
        axes.set_ylabel("Correction value")

        axes.set_title("Distance decay")
        plt.legend(loc="upper right")

        return Plot(axes)

    def plot_corrections_inverse(self, axes: Optional[plt.Axes] = None) -> Plot:
        """Create a plot offsets inverse of distance decay corrections.

        Parameters
        ----------
        axes : Optional[plt.Axes], optional
            Optional axes object to reuse, when none is given, new figure is created,
            by default None

        Returns
        -------
        Plot
            Plot object containing plot axes.

        Notes
        -----
        The function creates a line plot of the inverse of distance decay corrections,
        with the "index" column on the x-axis and the "value" column inverse on the
        y-axis. The plot includes a grid and axis labels, and a title indicating
        that it shows distance decay.

        The function returns the Plot object granting access to axes for the created
        plot, which can be further customized or saved using the methods of the
        matplotlib API.

        """
        if axes is None:
            plt.figure()
            axes = plt.subplot()

        axes.plot(
            self.corrections[["index"]],
            1 / (self.corrections[["value"]] - self.slope_props.optimum),
        )
        axes.grid(visible=True)

        axes.set_xlabel("Correction index")
        axes.set_ylabel("Inverse correction value with offset")

        axes.set_title("Inverse distance decay with offset")

        return Plot(axes)

    def plot_iteration(self, axes: Optional[plt.Axes] = None) -> Plot:
        """Create a plot of iteration linear corrections.

        Returns
        -------
        matplotlib.axes.Axes
            The axes object for the created plot.

        Notes
        -----
        The function creates a line plot of the iteration linear corrections,
        with the "iteration" column on the x-axis and the correction values on
        the y-axis. The correction values are calculated using the
        `SlopeProperties` class, which takes the "index" column as input and
        returns the corresponding correction values for each iteration.

        The plot includes a grid and axis labels, but no title. The function returns
        the axes object for the created plot, which can be further customized or
        saved using the methods of the matplotlib API.

        """
        if axes is None:
            plt.figure()
            axes = plt.subplot()

        axes.grid(visible=True)

        axes.set_xlabel("Iteration index")
        axes.set_ylabel("Correction index")

        axes.set_title("Total number of correction")

        axes.plot(
            self.corrections[["iteration"]],
            self.corrections[["index"]],
        )

        return Plot(axes)

__init__ 

__init__(corrections: pd.DataFrame) -> None

Initialize plot creator.

Parameters:

Name Type Description Default
corrections DataFrame

A DataFrame containing the distance decay corrections. The DataFrame should have an "index" column and a "value" column.

 required
Source code in cssfinder/reports/plotting.py 
45
46
47
48
49
50
51
52
53
54
55
56
def __init__(self, corrections: pd.DataFrame) -> None:
    """Initialize plot creator.

    Parameters
    ----------
    corrections : pandas.DataFrame
        A DataFrame containing the distance decay corrections. The DataFrame
        should have an "index" column and a "value" column.

    """
    self.corrections = corrections
    self.slope_props = SlopeProperties.find(self.corrections.to_numpy())

plot_corrections 

plot_corrections(axes: Optional[plt.Axes] = None) -> Plot

Create a plot of distance decay corrections.

Parameters:

Name Type Description Default
axes Optional[Axes]

Optional axes object to reuse, when none is given, new figure is created, by default None

 None

Returns:

Type Description
Plot

Plot object containing plot axes.
Notes

The function creates a line plot of the distance decay corrections, with the "index" column on the x-axis and the "value" column on the y-axis. The plot includes a grid and axis labels, and a title indicating that it shows distance decay.

The function returns the Plot object granting access to axes for the created plot, which can be further customized or saved using the methods of the matplotlib API.

Source code in cssfinder/reports/plotting.py 
 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
def plot_corrections(self, axes: Optional[plt.Axes] = None) -> Plot:
    """Create a plot of distance decay corrections.

    Parameters
    ----------
    axes : Optional[plt.Axes], optional
        Optional axes object to reuse, when none is given, new figure is created,
        by default None

    Returns
    -------
    Plot
        Plot object containing plot axes.

    Notes
    -----
    The function creates a line plot of the distance decay corrections,
    with the "index" column on the x-axis and the "value" column on the
    y-axis. The plot includes a grid and axis labels, and a title indicating
    that it shows distance decay.

    The function returns the Plot object granting access to axes for the created
    plot, which can be further customized or saved using the methods of the
    matplotlib API.

    """
    if axes is None:
        plt.figure()
        axes = plt.subplot()

    axes.plot(
        self.corrections[["index"]],
        self.corrections[["value"]],
        label="correction",
    )
    axes.hlines(
        [self.slope_props.optimum],
        xmin=-10,
        xmax=self.corrections[["index"]].max(),
        color="red",
        label="H-S distance",
        linestyles="dashed",
    )
    axes.grid(visible=True)

    axes.set_xlabel("Correction index")
    axes.set_ylabel("Correction value")

    axes.set_title("Distance decay")
    plt.legend(loc="upper right")

    return Plot(axes)

plot_corrections_inverse 

plot_corrections_inverse(
    axes: Optional[plt.Axes] = None,
) -> Plot

Create a plot offsets inverse of distance decay corrections.

Parameters:

Name Type Description Default
axes Optional[Axes]

Optional axes object to reuse, when none is given, new figure is created, by default None

 None

Returns:

Type Description
Plot

Plot object containing plot axes.
Notes

The function creates a line plot of the inverse of distance decay corrections, with the "index" column on the x-axis and the "value" column inverse on the y-axis. The plot includes a grid and axis labels, and a title indicating that it shows distance decay.

The function returns the Plot object granting access to axes for the created plot, which can be further customized or saved using the methods of the matplotlib API.

Source code in cssfinder/reports/plotting.py 
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
def plot_corrections_inverse(self, axes: Optional[plt.Axes] = None) -> Plot:
    """Create a plot offsets inverse of distance decay corrections.

    Parameters
    ----------
    axes : Optional[plt.Axes], optional
        Optional axes object to reuse, when none is given, new figure is created,
        by default None

    Returns
    -------
    Plot
        Plot object containing plot axes.

    Notes
    -----
    The function creates a line plot of the inverse of distance decay corrections,
    with the "index" column on the x-axis and the "value" column inverse on the
    y-axis. The plot includes a grid and axis labels, and a title indicating
    that it shows distance decay.

    The function returns the Plot object granting access to axes for the created
    plot, which can be further customized or saved using the methods of the
    matplotlib API.

    """
    if axes is None:
        plt.figure()
        axes = plt.subplot()

    axes.plot(
        self.corrections[["index"]],
        1 / (self.corrections[["value"]] - self.slope_props.optimum),
    )
    axes.grid(visible=True)

    axes.set_xlabel("Correction index")
    axes.set_ylabel("Inverse correction value with offset")

    axes.set_title("Inverse distance decay with offset")

    return Plot(axes)

plot_iteration 

plot_iteration(axes: Optional[plt.Axes] = None) -> Plot

Create a plot of iteration linear corrections.

Returns:

Type Description
Axes

The axes object for the created plot.
Notes

The function creates a line plot of the iteration linear corrections, with the "iteration" column on the x-axis and the correction values on the y-axis. The correction values are calculated using the SlopeProperties class, which takes the "index" column as input and returns the corresponding correction values for each iteration.

The plot includes a grid and axis labels, but no title. The function returns the axes object for the created plot, which can be further customized or saved using the methods of the matplotlib API.

Source code in cssfinder/reports/plotting.py 
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
def plot_iteration(self, axes: Optional[plt.Axes] = None) -> Plot:
    """Create a plot of iteration linear corrections.

    Returns
    -------
    matplotlib.axes.Axes
        The axes object for the created plot.

    Notes
    -----
    The function creates a line plot of the iteration linear corrections,
    with the "iteration" column on the x-axis and the correction values on
    the y-axis. The correction values are calculated using the
    `SlopeProperties` class, which takes the "index" column as input and
    returns the corresponding correction values for each iteration.

    The plot includes a grid and axis labels, but no title. The function returns
    the axes object for the created plot, which can be further customized or
    saved using the methods of the matplotlib API.

    """
    if axes is None:
        plt.figure()
        axes = plt.subplot()

    axes.grid(visible=True)

    axes.set_xlabel("Iteration index")
    axes.set_ylabel("Correction index")

    axes.set_title("Total number of correction")

    axes.plot(
        self.corrections[["iteration"]],
        self.corrections[["index"]],
    )

    return Plot(axes)

Plot dataclass

Container class for plots generated with Plotter class.

Source code in cssfinder/reports/plotting.py 
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
@dataclass
class Plot:
    """Container class for plots generated with Plotter class."""

    axes: plt.Axes

    @property
    def figure(self) -> fig.Figure:
        """Axes figure."""
        return self.axes.figure

    def configure(self, width: int = 8, height: int = 6) -> Self:
        """Set the size of the current figure.

        Parameters
        ----------
        width : int, optional
            The width of the figure in inches. Default is 10.
        height : int, optional
            The height of the figure in inches. Default is 10.

        Returns
        -------
        Self
            Returns the instance of the object to allow for method chaining.

        """
        self.axes.figure.set_figwidth(width)
        self.axes.figure.set_figheight(height)
        return self

    def save_plot(
        self,
        dest: Path | BytesIO,
        dpi: int = 300,
        file_format: Optional[str] = None,
    ) -> None:
        """Save figure to file.

        Parameters
        ----------
        dest : Path | BytesIO
            Path to file or writable BytesIO.
        dpi : int, optional
            Plot output dpi, by default 150
        file_format : Optional[str], optional
            File format, when None, deduced from file path, by default None

        """
        self.axes.figure.savefig(
            dest.as_posix() if isinstance(dest, Path) else dest,
            dpi=dpi,
            format=file_format,
        )

    def base64_encode(self, file_format: Optional[str] = None) -> str:
        """Encode plot as base64 string.

        Parameters
        ----------
        file_format : Optional[str], optional
            Preferred file format, by default None

        Returns
        -------
        str
            Encoded image.

        """
        io = BytesIO()
        self.save_plot(io, file_format=file_format)
        io.seek(0)

        return base64.b64encode(io.read()).decode("utf-8")

figure property 

figure: Figure

Axes figure.

configure 

configure(width: int = 8, height: int = 6) -> Self

Set the size of the current figure.

Parameters:

Name Type Description Default
width int

The width of the figure in inches. Default is 10.

 8
height int

The height of the figure in inches. Default is 10.

 6

Returns:

Type Description
Self

Returns the instance of the object to allow for method chaining.
Source code in cssfinder/reports/plotting.py 
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def configure(self, width: int = 8, height: int = 6) -> Self:
    """Set the size of the current figure.

    Parameters
    ----------
    width : int, optional
        The width of the figure in inches. Default is 10.
    height : int, optional
        The height of the figure in inches. Default is 10.

    Returns
    -------
    Self
        Returns the instance of the object to allow for method chaining.

    """
    self.axes.figure.set_figwidth(width)
    self.axes.figure.set_figheight(height)
    return self

save_plot 

save_plot(
    dest: Path | BytesIO,
    dpi: int = 300,
    file_format: Optional[str] = None,
) -> None

Save figure to file.

Parameters:

Name Type Description Default
dest Path | BytesIO

Path to file or writable BytesIO.

 required
dpi int

Plot output dpi, by default 150

 300
file_format Optional[str]

File format, when None, deduced from file path, by default None

 None
Source code in cssfinder/reports/plotting.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
def save_plot(
    self,
    dest: Path | BytesIO,
    dpi: int = 300,
    file_format: Optional[str] = None,
) -> None:
    """Save figure to file.

    Parameters
    ----------
    dest : Path | BytesIO
        Path to file or writable BytesIO.
    dpi : int, optional
        Plot output dpi, by default 150
    file_format : Optional[str], optional
        File format, when None, deduced from file path, by default None

    """
    self.axes.figure.savefig(
        dest.as_posix() if isinstance(dest, Path) else dest,
        dpi=dpi,
        format=file_format,
    )

base64_encode 

base64_encode(file_format: Optional[str] = None) -> str

Encode plot as base64 string.

Parameters:

Name Type Description Default
file_format Optional[str]

Preferred file format, by default None

 None

Returns:

Type Description
str

Encoded image.
Source code in cssfinder/reports/plotting.py 
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
def base64_encode(self, file_format: Optional[str] = None) -> str:
    """Encode plot as base64 string.

    Parameters
    ----------
    file_format : Optional[str], optional
        Preferred file format, by default None

    Returns
    -------
    str
        Encoded image.

    """
    io = BytesIO()
    self.save_plot(io, file_format=file_format)
    io.seek(0)

    return base64.b64encode(io.read()).decode("utf-8")