implement MultiTimeseries #178
Conversation
|
The goes along with the PR of the same name from spikesortingview: magland/spikesortingview#23 |
| def add_panel(self, figure: Figure, *, relative_height: Union[float, None]=None): | ||
| self._panels.append({ | ||
| 'figure': figure, | ||
| 'relative_height': relative_height | ||
| }) |
There was a problem hiding this comment.
So in practice, add_panel is used to add a timeseries (figure) along with its relative height to the list of panels that should be presented together. Then, when we want to render them, we call get_composite_figure which collects the individual figures and labels the collection as a MultiTimeseries, which is what gets displayed on the front-end. Right?
| fig0: Figure = p['figure'] | ||
| v = { | ||
| 'type': fig0.data['type'], | ||
| 'label': fig0.label, | ||
| 'figureDataSha1': _upload_data_and_return_sha1(fig0.get_serialized_figure_data()) | ||
| } | ||
| if p['relative_height'] is not None: | ||
| v['relativeHeight'] = p['relative_height'] | ||
| panels.append(v) |
There was a problem hiding this comment.
So the distinction here is that each of the Figures in the _panels collection could be a stand-alone time series figure, but when they've been collected as a MultiTimeseries that's a new kind of figure that has special rules on the front-end.
Each v ("view" is the mnemonic here?) is taking a could-have-been-viewed-independently Figure and extracting the type, label, and data, along with possibly a relative height, and then adding them to the panels collection. Understanding the context, this all makes sense.
My only question--is there a benefit to storing the full Figure data in self._panels and then extracting a subset of it in get_composite_figure vs storing only the type, label, sha1, and (optional) relative height to begin with?
There was a problem hiding this comment.
My only question--is there a benefit to storing the full
Figuredata inself._panelsand then extracting a subset of it inget_composite_figurevs storing only the type, label, sha1, and (optional) relative height to begin with?
This just provides a simpler interface. You use the same figure object to view a standalone figure as to build a composite figure.
|
Oh, also, this will need to be moved to comply with the directory structure changes implemented in PR #177 (whether before or after the merge) |
No description provided.