You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/user_guide/guide.rst
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ or install the bleeding edge from Github:
18
18
19
19
20
20
What is ``fastplotlib``?
21
-
----------------------
21
+
------------------------
22
22
23
23
``fastplotlib`` is a cutting-edge plotting library built using the ```pygfx`` <https://github.com/pygfx/pygfx>`_ rendering engine.
24
24
The lower-level details of the rendering process (i.e. defining a scene, camera, renderer, etc.) are abstracted away, allowing users to focus on their data.
@@ -27,7 +27,7 @@ make it easy and intuitive to produce interactive visualizations that are as per
27
27
28
28
29
29
How to use ``fastplotlib``
30
-
------------------------
30
+
--------------------------
31
31
32
32
Before giving a detailed overview of the library, here is a minimal example::
33
33
@@ -49,7 +49,7 @@ Before giving a detailed overview of the library, here is a minimal example::
49
49
if __name__ == "__main__":
50
50
fpl.run()
51
51
52
-
.. image:: ./_static/guide_hello_world.png
52
+
.. image:: ../_static/guide_hello_world.png
53
53
54
54
55
55
This is just a simple example of how the ``fastplotlib`` API works to create a plot, add some image data to the plot, and then visualize it.
@@ -173,14 +173,14 @@ Using our example from above: once we add a ``Graphic`` to the figure, we can th
173
173
174
174
image_graphic.vmax = 150
175
175
176
-
.. image:: ./_static/hello_world_vmax.png
176
+
.. image:: ../_static/guide_hello_world_vmax.png
177
177
178
178
``Graphic`` properties also support slicing and indexing. For example ::
179
179
180
180
image_graphic.data[::8, :, :] = 1
181
181
image_graphic.data[:, ::8, :] = 1
182
182
183
-
.. image:: ./_static/hello_world_data.png
183
+
.. image:: ../_static/guide_hello_world_data.png
184
184
185
185
186
186
Selectors
@@ -211,7 +211,7 @@ data. Let's look at an example: ::
211
211
212
212
fig.show(maintain_aspect=False)
213
213
214
-
.. image:: _static/guide_linear_selector.gif
214
+
.. image:: ../_static/guide_linear_selector.gif
215
215
216
216
217
217
A ``LinearRegionSelector`` is very similar to a ``LinearSelector`` but as opposed to selecting a singular point of
@@ -448,7 +448,8 @@ For example: ::
448
448
nearest.colors = "w"
449
449
450
450
fig.show()
451
-
.. image:: ./_static/click_event.gif
451
+
452
+
.. image:: ../_static/click_event.gif
452
453
453
454
ImageWidget
454
455
-----------
@@ -472,7 +473,7 @@ to easily navigate through different dimensions of your data. Let's look at an e
472
473
473
474
iw_movie.show()
474
475
475
-
.. image:: _static/guide_image_widget.gif
476
+
.. image:: ../_static/guide_image_widget.gif
476
477
477
478
Animations
478
479
----------
@@ -496,7 +497,7 @@ An animation function is a user-defined function that gets called on every rende
496
497
497
498
fig.show()
498
499
499
-
.. image:: _static/guide_animation.gif
500
+
.. image:: ../_static/guide_animation.gif
500
501
501
502
Here we are defining a function that updates the data of the ``ImageGraphic`` in the plot with new random data. When adding an animation function, the
502
503
user-defined function will receive a plot instance as an argument when it is called.
0 commit comments