Skip to content

Commit ea03674

Browse files
committed
fix docstring error in qc.py
1 parent 7a89a7f commit ea03674

File tree

1 file changed

+8
-14
lines changed
  • element_array_ephys/plotting

1 file changed

+8
-14
lines changed

element_array_ephys/plotting/qc.py

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,10 @@ def __init__(
2828
key (dict, optional): key from ephys.QualityMetric table. Defaults to None.
2929
scale (float, optional): Scale at which to render figure. Defaults to 1.4.
3030
fig_width (int, optional): Figure width in pixels. Defaults to 800.
31-
amplitude_cutoff_maximum (float, optional): Cutoff for unit amplitude in
32-
visualizations. Defaults to None.
33-
presence_ratio_minimum (float, optional): Cutoff for presence ratio in
34-
visualizations. Defaults to None.
35-
isi_violations_maximum (float, optional): Cutoff for isi violations in
36-
visualizations. Defaults to None.
37-
dark_mode (bool, optional): Set background to black, foreground white.
38-
Default False, black on white.
31+
amplitude_cutoff_maximum (float, optional): Cutoff for unit amplitude in visualizations. Defaults to None.
32+
presence_ratio_minimum (float, optional): Cutoff for presence ratio in visualizations. Defaults to None.
33+
isi_violations_maximum (float, optional): Cutoff for isi violations in visualizations. Defaults to None.
34+
dark_mode (bool, optional): Set background to black, foreground white. Default False, black on white.
3935
"""
4036
self._ephys = ephys
4137
self._key = key
@@ -134,7 +130,7 @@ def _format_fig(
134130
Figure to apply formatting. Defaults to empty.
135131
scale (float, optional): Scale to render figure. Defaults to scale from
136132
class init, 1.
137-
ratio (float, optional): Figure aspect ratio width/height . Defaults to 1.
133+
ratio (float, optional): Figure aspect ratio width/height. Defaults to 1.
138134
139135
Returns:
140136
go.Figure: Formatted figure
@@ -202,7 +198,7 @@ class initialization.
202198
return fig.add_trace(
203199
go.Scatter(
204200
x=histogram_bins[:-1],
205-
y=gaussian_filter1d(histogram, 1), # TODO: remove smoothing
201+
y=gaussian_filter1d(histogram, 1),
206202
mode="lines",
207203
line=dict(color="rgb(0, 160, 223)", width=2 * scale), # DataJoint Blue
208204
hovertemplate="%{x:.2f}<br>%{y:.2f}<extra></extra>",
@@ -215,8 +211,7 @@ def get_single_fig(self, fig_name: str, scale: float = None) -> go.Figure:
215211
216212
Args:
217213
fig_name (str): Name of figure to be rendered
218-
scale (float, optional): Scale to render fig. Defaults to scale at class
219-
init, 1.
214+
scale (float, optional): Scale to render fig. Defaults to scale at class init, 1.
220215
221216
Returns:
222217
go.Figure: Histogram plot
@@ -253,8 +248,7 @@ def get_grid(self, n_columns: int = 4, scale: float = 1.0) -> go.Figure:
253248
254249
Args:
255250
n_columns (int, optional): Number of column in grid. Defaults to 4.
256-
scale (float, optional): Scale to render fig. Defaults to scale at class
257-
init, 1.
251+
scale (float, optional): Scale to render fig. Defaults to scale at class init, 1.
258252
259253
Returns:
260254
go.Figure: grid of available plots

0 commit comments

Comments
 (0)