Skip to content

Commit

Permalink
docs(demos): better exception-handling, hiding stacktrace
Browse files Browse the repository at this point in the history
Closes #74
  • Loading branch information
JorisVincent committed May 10, 2023
1 parent c3b0a0e commit ae98e04
Show file tree
Hide file tree
Showing 33 changed files with 1,593 additions and 1,290 deletions.
50 changes: 28 additions & 22 deletions docs/reference/demos/components/angulars.md
Expand Up @@ -74,18 +74,21 @@ def show_wedge(
origin=None,
add_mask=False,
):
stim = wedge(
visual_size=(height, width),
ppd=ppd,
angle=wwidth,
radius=radius,
rotation=rotation,
inner_radius=inner_radius,
intensity_wedge=intensity_wedge,
intensity_background=intensity_background,
origin=origin,
)
plot_stim(stim, mask=add_mask)
try:
stim = wedge(
visual_size=(height, width),
ppd=ppd,
angle=wwidth,
radius=radius,
rotation=rotation,
inner_radius=inner_radius,
intensity_wedge=intensity_wedge,
intensity_background=intensity_background,
origin=origin,
)
plot_stim(stim, mask=add_mask)
except Exception as e:
raise ValueError(f"Invalid parameter combination: {e}") from None
# Set interactivity
out = iw.interactive_output(
Expand Down Expand Up @@ -161,16 +164,19 @@ def show_segments(
origin=None,
add_mask=False,
):
stim = segments(
visual_size=(height, width),
ppd=ppd,
angles=(wwidth1, wwidth2, wwidth3),
rotation=rotation,
intensity_segments=(int1, int2, int3),
intensity_background=intensity_background,
origin=origin,
)
plot_stim(stim, mask=add_mask)
try:
stim = segments(
visual_size=(height, width),
ppd=ppd,
angles=(wwidth1, wwidth2, wwidth3),
rotation=rotation,
intensity_segments=(int1, int2, int3),
intensity_background=intensity_background,
origin=origin,
)
plot_stim(stim, mask=add_mask)
except Exception as e:
raise ValueError(f"Invalid parameter combination: {e}") from None
# Set interactivity
out = iw.interactive_output(
Expand Down
64 changes: 35 additions & 29 deletions docs/reference/demos/components/edges.md
Expand Up @@ -62,14 +62,16 @@ def show_step_edge(
intensity2=None,
add_mask=False,
):
stim = step(
visual_size=(height, width),
ppd=ppd,
rotation=rotation,
intensity_edges=(intensity1, intensity2),
)
plot_stim(stim, mask=add_mask)
try:
stim = step(
visual_size=(height, width),
ppd=ppd,
rotation=rotation,
intensity_edges=(intensity1, intensity2),
)
plot_stim(stim, mask=add_mask)
except Exception as e:
raise ValueError(f"Invalid parameter combination: {e}") from None
# Set interactivity
out = iw.interactive_output(
Expand Down Expand Up @@ -129,16 +131,18 @@ def show_gaussian_edge(
intensity_background=None,
add_mask=False,
):
stim = gaussian(
visual_size=(height, width),
ppd=ppd,
sigma=sigma,
rotation=rotation,
intensity_edges=(intensity1, intensity2),
intensity_background=intensity_background,
)
plot_stim(stim, mask=add_mask)
try:
stim = gaussian(
visual_size=(height, width),
ppd=ppd,
sigma=sigma,
rotation=rotation,
intensity_edges=(intensity1, intensity2),
intensity_background=intensity_background,
)
plot_stim(stim, mask=add_mask)
except Exception as e:
raise ValueError(f"Invalid parameter combination: {e}") from None
# Set interactivity
out = iw.interactive_output(
Expand Down Expand Up @@ -202,17 +206,19 @@ def show_cornsweet_edge(
intensity_plateau=None,
add_mask=False,
):
stim = cornsweet(
visual_size=(height, width),
ppd=ppd,
ramp_width=ramp_width,
exponent=exponent,
rotation=rotation,
intensity_edges=(intensity1, intensity2),
intensity_plateau=intensity_plateau,
)
plot_stim(stim, mask=add_mask)
try:
stim = cornsweet(
visual_size=(height, width),
ppd=ppd,
ramp_width=ramp_width,
exponent=exponent,
rotation=rotation,
intensity_edges=(intensity1, intensity2),
intensity_plateau=intensity_plateau,
)
plot_stim(stim, mask=add_mask)
except Exception as e:
raise ValueError(f"Invalid parameter combination: {e}") from None
# Set interactivity
out = iw.interactive_output(
Expand Down
21 changes: 12 additions & 9 deletions docs/reference/demos/components/frames.md
Expand Up @@ -74,15 +74,18 @@ def show_frames(
origin=None,
add_mask=False,
):
stim = frames(
visual_size=(height, width),
ppd=ppd,
radii=(radius1, radius2, radius3),
intensity_frames=(int1, int2, int3),
intensity_background=intensity_background,
origin=origin,
)
plot_stim(stim, mask=add_mask)
try:
stim = frames(
visual_size=(height, width),
ppd=ppd,
radii=(radius1, radius2, radius3),
intensity_frames=(int1, int2, int3),
intensity_background=intensity_background,
origin=origin,
)
plot_stim(stim, mask=add_mask)
except Exception as e:
raise ValueError(f"Invalid parameter combination: {e}") from None
# Set interactivity
out = iw.interactive_output(
Expand Down
22 changes: 12 additions & 10 deletions docs/reference/demos/components/gaussians.md
Expand Up @@ -67,16 +67,18 @@ def show_gaussian(
intensity_max=None,
add_mask=False,
):
stim = gaussian(
visual_size=(height, width),
ppd=ppd,
sigma=(sigma1, sigma2),
origin=origin,
rotation=rotation,
intensity_max=intensity_max,
)
plot_stim(stim, mask=add_mask)
try:
stim = gaussian(
visual_size=(height, width),
ppd=ppd,
sigma=(sigma1, sigma2),
origin=origin,
rotation=rotation,
intensity_max=intensity_max,
)
plot_stim(stim, mask=add_mask)
except Exception as e:
raise ValueError(f"Invalid parameter combination: {e}") from None
# Set interactivity
out = iw.interactive_output(
Expand Down
96 changes: 52 additions & 44 deletions docs/reference/demos/components/lines.md
Expand Up @@ -76,19 +76,21 @@ def show_line(
add_mask=False,
origin=None,
):
stim = line(
visual_size=(height, width),
ppd=ppd,
line_position=(ypos, xpos),
line_length=line_length,
line_width=line_width,
rotation=rotation,
intensity_line=intensity_line,
intensity_background=intensity_background,
origin=origin,
)
plot_stim(stim, mask=add_mask)
try:
stim = line(
visual_size=(height, width),
ppd=ppd,
line_position=(ypos, xpos),
line_length=line_length,
line_width=line_width,
rotation=rotation,
intensity_line=intensity_line,
intensity_background=intensity_background,
origin=origin,
)
plot_stim(stim, mask=add_mask)
except Exception as e:
raise ValueError(f"Invalid parameter combination: {e}") from None
# Set interactivity
out = iw.interactive_output(
Expand Down Expand Up @@ -155,17 +157,19 @@ def show_dipole(
int2=None,
add_mask=False,
):
stim = dipole(
visual_size=(height, width),
ppd=ppd,
line_length=line_length,
line_width=line_width,
line_gap=line_gap,
rotation=rotation,
intensity_lines=(int1, int2),
)
plot_stim(stim, mask=add_mask)
try:
stim = dipole(
visual_size=(height, width),
ppd=ppd,
line_length=line_length,
line_width=line_width,
line_gap=line_gap,
rotation=rotation,
intensity_lines=(int1, int2),
)
plot_stim(stim, mask=add_mask)
except Exception as e:
raise ValueError(f"Invalid parameter combination: {e}") from None
# Set interactivity
out = iw.interactive_output(
Expand Down Expand Up @@ -228,16 +232,18 @@ def show_ellipse(
intensity_background=None,
add_mask=False,
):
stim = ellipse(
visual_size=(height, width),
ppd=ppd,
radius=(rad1, rad2),
line_width=line_width,
intensity_line=intensity_line,
intensity_background=intensity_background,
)
plot_stim(stim, mask=add_mask)
try:
stim = ellipse(
visual_size=(height, width),
ppd=ppd,
radius=(rad1, rad2),
line_width=line_width,
intensity_line=intensity_line,
intensity_background=intensity_background,
)
plot_stim(stim, mask=add_mask)
except Exception as e:
raise ValueError(f"Invalid parameter combination: {e}") from None
# Set interactivity
out = iw.interactive_output(
Expand Down Expand Up @@ -297,16 +303,18 @@ def show_circle(
intensity_background=None,
add_mask=False,
):
stim = circle(
visual_size=(height, width),
ppd=ppd,
radius=radius,
line_width=line_width,
intensity_line=intensity_line,
intensity_background=intensity_background,
)
plot_stim(stim, mask=add_mask)
try:
stim = circle(
visual_size=(height, width),
ppd=ppd,
radius=radius,
line_width=line_width,
intensity_line=intensity_line,
intensity_background=intensity_background,
)
plot_stim(stim, mask=add_mask)
except Exception as e:
raise ValueError(f"Invalid parameter combination: {e}") from None
# Set interactivity
out = iw.interactive_output(
Expand Down

0 comments on commit ae98e04

Please sign in to comment.