smpl.plot.AutoLocator

class smpl.plot.AutoLocator

Bases: MaxNLocator

Dynamically find major tick positions. This is actually a subclass of ~matplotlib.ticker.MaxNLocator, with parameters nbins = ‘auto’ and steps = [1, 2, 2.5, 5, 10].

__init__()

To know the values of the non-public parameters, please have a look to the defaults of ~matplotlib.ticker.MaxNLocator.

Methods

__init__()	To know the values of the non-public parameters, please have a look to the defaults of ~matplotlib.ticker.MaxNLocator.
create_dummy_axis(**kwargs)
nonsingular(v0, v1)	Adjust a range as needed to avoid singularities.
raise_if_exceeds(locs)	Log at WARNING level if locs is longer than Locator.MAXTICKS.
set_axis(axis)
set_bounds(vmin, vmax)	[Deprecated]
set_data_interval(vmin, vmax)	[Deprecated]
set_params(**kwargs)	Set parameters for this locator.
set_view_interval(vmin, vmax)	[Deprecated]
tick_values(vmin, vmax)	Return the values of the located ticks given vmin and vmax.
view_limits(dmin, dmax)	Select a scale for the range from vmin to vmax.

Attributes

MAXTICKS
axis
default_params

nonsingular(v0, v1)

Adjust a range as needed to avoid singularities.

This method gets called during autoscaling, with (v0, v1) set to the data limits on the axes if the axes contains any data, or (-inf, +inf) if not.

• If v0 == v1 (possibly up to some floating point slop), this method returns an expanded interval around this value.

• If (v0, v1) == (-inf, +inf), this method returns appropriate default view limits.

• Otherwise, (v0, v1) is returned without modification.

raise_if_exceeds(locs)

Log at WARNING level if locs is longer than Locator.MAXTICKS.

This is intended to be called immediately before returning locs from __call__ to inform users in case their Locator returns a huge number of ticks, causing Matplotlib to run out of memory.

The “strange” name of this method dates back to when it would raise an exception instead of emitting a log.

set_bounds(vmin, vmax)

[Deprecated]

Notes

Deprecated since version 3.5: Use .Axis.set_view_interval and .Axis.set_data_interval instead.

set_data_interval(vmin, vmax)

[Deprecated]

Notes

Deprecated since version 3.5: Use .Axis.set_data_interval instead.

set_params(**kwargs)

Set parameters for this locator.

Parameters

nbinsint or ‘auto’, optional

see .MaxNLocator

stepsarray-like, optional

see .MaxNLocator

integerbool, optional

see .MaxNLocator

symmetricbool, optional

see .MaxNLocator

prune{‘lower’, ‘upper’, ‘both’, None}, optional

see .MaxNLocator

min_n_ticksint, optional

see .MaxNLocator

set_view_interval(vmin, vmax)

[Deprecated]

Notes

Deprecated since version 3.5: Use .Axis.set_view_interval instead.

tick_values(vmin, vmax)

Return the values of the located ticks given vmin and vmax.

Note

To get tick locations with the vmin and vmax values defined automatically for the associated axis simply call the Locator instance:

>>> print(type(loc))
<type 'Locator'>
>>> print(loc())
[1, 2, 3, 4]

view_limits(dmin, dmax)

Select a scale for the range from vmin to vmax.

Subclasses should override this method to change locator behaviour.