class TagViewer(object):
MPL_AUTO_SHOW = True
_default_plot_specs = (
DefaultTagPlots.Voltage,
DefaultTagPlots.CurrentDensity,
DefaultTagPlots.Current,
DefaultTagPlots.Conductance,
DefaultTagPlots.ConductanceDensity,
DefaultTagPlots.StateVariable,
DefaultTagPlots.StateVariableTau,
DefaultTagPlots.StateVariableInf,
DefaultTagPlots.Event,
)
_default_fig_kwargs = {'figsize': (12, 8) }
_options_show_xlabel = ('only-once','all', False)
_options_show_xticklabels=('only-once','all', False)
_options_show_xticklabels_with_units=(True,False)
_options_show_xaxis_position = ('bottom','top')
def __init__(
self,
srcs,
plots=None,
additional_plots=None,
figtitle=None,
fig_kwargs=None,
show=True,
linkage=None,
timerange=None,
mpl_tight_bounds=False,
decimate_points=False,
share_x_labels=True,
nxticks=4,
show_xlabel='only-once',
show_xticklabels='only-once',
show_xticklabels_with_units=True,
show_xaxis_position='bottom',
xticklabel_quantisation = False,
xticks=None,
xlabel='Time'
):
self.xlabel = xlabel
if fig_kwargs is None:
fig_kwargs = self._default_fig_kwargs
self.linkage = linkage
self.decimate_points = decimate_points
if not is_iterable(srcs):
srcs = [srcs]
# For each type of input (in 'srcs'); this should return a list of traces:
self.all_trace_objs = []
self.all_event_set_objs = []
trace_extractors = {
SimulationResult: lambda obj: (self.all_trace_objs.extend(obj.traces),self.all_event_set_objs.extend(obj.evsets)),
TraceFixedDT: lambda obj: self.all_trace_objs.append(obj),
TraceVariableDT: lambda obj: self.all_trace_objs.append(obj),
TracePiecewise: lambda obj: self.all_trace_objs.append(obj),
EventSet: lambda obj: self.all_event_set_objs.append(obj)
}
for obj in srcs:
tr_extractor = trace_extractors[type(obj)]
tr_extractor(obj)
# Use the new PlotSpec architecture:
# Filter out which plots are actually going to display something,
# and filter out the rest:
plots = plots if plots is not None else TagViewer._default_plot_specs
if additional_plots:
plots = tuple(list(plots) + list(additional_plots))
self.plot_specs = [plotspec for plotspec in plots if
[tr for tr in self.all_trace_objs if plotspec.addtrace_predicate(tr)] or \
[evset for evset in self.all_event_set_objs if plotspec.addeventset_predicate(evset)] \
]
self.fig_kwargs = fig_kwargs
self.figtitle = figtitle
self.mpl_tight_bounds = mpl_tight_bounds
self.timerange = timerange
#self.share_x_labels = share_x_labels
self.nxticks = nxticks
# X-axis configuration:
self.show_xlabel = show_xlabel
self.show_xticklabels = show_xticklabels
self.show_xticklabels_with_units = show_xticklabels_with_units
self.show_xaxis_position = show_xaxis_position
#self.xticks_as_ints = xticks_as_ints
self.xticklabel_quantisation = xticklabel_quantisation
self.xticks=xticks
assert self.show_xlabel in self._options_show_xlabel, 'Invalid'
assert self.show_xticklabels in self._options_show_xticklabels, 'Invalid: %s' % show_xticklabels
assert self.show_xticklabels_with_units in self._options_show_xticklabels_with_units
assert self.show_xaxis_position in self._options_show_xaxis_position
if is_iterable( self.xticks ) and all( [isinstance(xtick, (int, float)) for xtick in self.xticks]):
self.xticks = [ xtick*units.ms for xtick in self.xticks]
assert self.xticks is None or isinstance(self.xticks, int) or ( is_iterable(self.xticks) and [ qty(xtick) for xtick in self.xticks] )
self.fig = None
self.subaxes = []
self.create_figure()
if TagViewer.MPL_AUTO_SHOW and show:
import pylab
pylab.show()
def create_figure(self):
self.fig = QuantitiesFigure(**self.fig_kwargs)
# Add a title to the plot:
if self.figtitle:
self.fig.suptitle(self.figtitle)
# Work out what traces are on what graphs:
plotspec_to_traces = dict([(plot_spec, [tr for tr in self.all_trace_objs if plot_spec.addtrace_predicate(tr)]) for plot_spec in self.plot_specs ])
if self.linkage:
self.linkage.process(plotspec_to_traces)
n_plots = len(self.plot_specs)
import matplotlib.gridspec as gridspec
height_ratios = [ps.height_ratio for ps in self.plot_specs]
gs = list(gridspec.GridSpec(n_plots, 1, height_ratios=height_ratios,) )
## Lets share a commonn x-axis:
#axes0 = self.fig.add_axes( gs[0].get_position(self.fig) )
#axesoneplus = [ self.fig.add_axes( ss.get_position(self.fig), sharex=axes0 ) for ss in gs[1:]]
#axes = [axes0] + axesoneplus
axes = [ self.fig.add_axes( ss.get_position(self.fig) ) for ss in gs]
for (i, (plot_spec,ax)) in enumerate(zip(self.plot_specs,axes)):
# Create the axis:
#ax = self.fig.add_subplot(n_plots, 1, i + 1)
ax.set_xunit(units.millisecond)
ax.set_xmargin(0.05)
ax.set_ymargin(0.05)
ax.set_xaxis_maxnlocator(self.nxticks)
# Leave the plotting to the tag-plot object
plot_spec.plot( ax=ax,
all_traces=self.all_trace_objs,
all_eventsets=self.all_event_set_objs,
time_range=self.timerange,
linkage=self.linkage,
decimate_points=self.decimate_points,
show_xlabel = self.show_xlabel,
show_xticklabels = self.show_xticklabels,
show_xticklabels_with_units = self.show_xticklabels_with_units,
show_xaxis_position = self.show_xaxis_position,
xticklabel_quantisation=self.xticklabel_quantisation,
is_top_plot = (i==0),
is_bottom_plot = (i==n_plots-1),
xticks = self.xticks,
xlabel=self.xlabel,
)
# Save the Axis:
self.subaxes.append(ax)
if self.mpl_tight_bounds:
import pylab
try:
pylab.tight_layout()
except AttributeError:
pass # This is version specfic
except ValueError:
pass # Top can't be less than bottom
