sorbetto.tile.correlation_tile module

class sorbetto.tile.correlation_tile.CorrelationTile(parameterization: AbstractParameterization, flavor: CorrelationFlavor, name: str = 'Correlation Tile', resolution: int = 1001, disable_colorbar: bool = False)[source]

Bases: NumericTile

property flavor: CorrelationFlavor

getExplanation() → str[source]

maximize(precision: float = 1e-08)[source]

Tries to maximize the value. There is no guarantee to find the maximum with the implemented algorithm. As described in Section A.7.2 of the supplementary material for Piérard et al. [17], this method implements a custom coarse-to-fine grid-based direct search Conn et al. [6]: we compute the value on a coarse grid over the Tile, locate the maximum on the grid, center a smaller region of interrest and a finer grid around that point, and iterate until the region of interrest is small enough.

Parameters:: precision (float, optional) – the desired precision for the coordinates of the point on the Tile. Defaults to 1e-8.
Returns:: the first coordinate of the point on the Tile where the largest value has been found. float: the second coordinate of the point on the Tile where the largest value has been found. float: the largest value that has been found.
Return type:: float

minimize(precision: float = 1e-08)[source]

Tries to minimize the value. There is no guarantee to find the minimum with the implemented algorithm. As described in Section A.7.2 of the supplementary material for Piérard et al. [17], this method implements a custom coarse-to-fine grid-based direct search Conn et al. [6]: we compute the value on a coarse grid over the Tile, locate the minimum on the grid, center a smaller region of interrest and a finer grid around that point, and iterate until the region of interrest is small enough.

Parameters:: precision (float, optional) – the desired precision for the coordinates of the point on the Tile. Defaults to 1e-8.
Returns:: the first coordinate of the point on the Tile where the smallest value has been found. float: the second coordinate of the point on the Tile where the smallest value has been found. float: the smallest value that has been found.
Return type:: float