Module gdess.graphics.utils

Functions

def aesthetic_grid_no_spines(axis: matplotlib.axes._axes.Axes) -> NoneType

Add dashed grid lines and remove axis spines

Parameters

axis : plt.Axes

 

Expand source code

def aesthetic_grid_no_spines(axis: plt.Axes) -> None:
    """Add dashed grid lines and remove axis spines

    Parameters
    ----------
    axis : plt.Axes
    """
    axis.grid(True, linestyle='--', color='gray', alpha=1)
    for spine in axis.spines.values():
        spine.set_visible(False)

def get_colormap(colormap=None, colormap_search_dir=None) -> matplotlib.colors.LinearSegmentedColormap

Parameters

colormap : str

filename for an .rgb colormap file

colormap_search_dir : str

where the colormap files are located

Raises

IOError

 

Returns

colormap

 

Expand source code

def get_colormap(colormap=None,
                 colormap_search_dir=None) -> LinearSegmentedColormap:
    """

    Parameters
    ----------
    colormap : str
        filename for an .rgb colormap file
    colormap_search_dir : str
        where the colormap files are located

    Raises
    ------
    IOError

    Returns
    -------
    colormap
    """
    if not colormap:
        colormap = "WhiteBlueGreenYellowRed.rgb"
    if not colormap_search_dir:
        colormap_search_dir = colormap_dir

    installed_colormap = os.path.join(colormap_search_dir, colormap)

    try:
        matplotlib_cmap = cm.get_cmap(colormap)
    except ValueError:
        matplotlib_cmap = None
        pass

    if os.path.exists(installed_colormap):
        # use the colormap from ./colormaps
        colormap = installed_colormap
    elif matplotlib_cmap:
        return matplotlib_cmap
    elif not os.path.exists(installed_colormap):
        msg = "File {} isn't installed in {} or in matplotlib"
        raise IOError(msg.format(colormap, colormap_search_dir))

    rgb_arr = np.loadtxt(colormap)
    rgb_arr = rgb_arr / 255.0
    cmap = LinearSegmentedColormap.from_list(name=colormap, colors=rgb_arr)

    return cmap

def limits_with_zero(t: tuple) -> tuple

Take a 2-tuple of axis limits If zero is not between them, then replace the one closest to zero with zero.

Raises

ValueError

 

TypeError

 

Expand source code

def limits_with_zero(t: tuple) -> tuple:
    """Take a 2-tuple of axis limits
    If zero is not between them, then replace the one closest to zero with zero.

    Raises
    ------
    ValueError
    TypeError
    """
    if (not t) | (len(t) > 2):
        raise ValueError("Unexpected input size. Should be a tuple of length 2.")
    elif not all([isinstance(x, (int, float)) for x in t]):
        raise TypeError("Unexpected input types. Should be float or integer.")

    zero_crossings = np.where(np.diff(np.sign(t)))[0]
    if len(zero_crossings) > 0:
        # tuple already crosses or contains zero
        return t
    elif (t[0] > 0) & (t[1] > 0):
        # both are positive
        if t[0] < t[1]:
            return 0, t[1]
        else:
            return t[0], 0
    elif (t[0] < 0) & (t[1] < 0):
        # both are negative
        if t[0] < t[1]:
            return t[0], 0
        else:
            return 0, t[1]
    else:
        raise ValueError("Unexpected condition")

def mysavefig(fig: matplotlib.figure.Figure, results_dir='', plot_save_name='test', **kwargs) -> NoneType

Append today's date to the file path and save with a tight bbox

Parameters

fig : plt.Figure

 

results_dir : str

 

plot_save_name : str, default 'test'

 

kwargs

Additional keyword arguments that are passed to savefig

Expand source code

def mysavefig(fig: plt.Figure,
              results_dir='',
              plot_save_name='test',
              **kwargs) -> None:
    """Append today's date to the file path and save with a tight bbox

    Parameters
    ----------
    fig : plt.Figure
    results_dir : str
    plot_save_name : str, default 'test'
    kwargs
        Additional keyword arguments that are passed to `savefig`
    """
    path = os.path.join(results_dir, plot_save_name)
    # If the path doesn't have an extension, we will default to png.
    if not path.lower().endswith(('.png', '.pdf', '.tif', '.tiff', '.jpg', '.jpeg', '.svg', '.eps')):
        path += '.png'
    # A datetime stamp is added immediately before the extension.
    path_with_datetime = append_before_extension(path, datetime.today().strftime('%Y-%m-%dT%H%M%S.%f'))

    fig.savefig(path_with_datetime, **kwargs)