From 15c8c4e2c32dc6e6af0fa68a95bdc567210622b2 Mon Sep 17 00:00:00 2001 From: Caitlin Date: Sun, 23 Jun 2024 05:30:54 -0400 Subject: [PATCH] fix guide --- docs/source/_static/click_event.gif | 3 +++ docs/source/_static/guide_hello_world.png | 4 ++-- .../source/_static/guide_hello_world_data.png | 4 ++-- .../source/_static/guide_hello_world_vmax.png | 4 ++-- docs/source/user_guide/guide.rst | 19 ++++++++++--------- 5 files changed, 19 insertions(+), 15 deletions(-) create mode 100644 docs/source/_static/click_event.gif diff --git a/docs/source/_static/click_event.gif b/docs/source/_static/click_event.gif new file mode 100644 index 000000000..81a334318 --- /dev/null +++ b/docs/source/_static/click_event.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b45c8aba01ba9557ee707e11952798df151d111a144cc09432323d98a3e2ee17 +size 110505 diff --git a/docs/source/_static/guide_hello_world.png b/docs/source/_static/guide_hello_world.png index b66b3d592..dbdc7029a 100644 --- a/docs/source/_static/guide_hello_world.png +++ b/docs/source/_static/guide_hello_world.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:81fdee4dda9bbc46d810a6e80ddc4d6ceb8ff0db8dfea2faf90424f977c000d4 -size 201157 +oid sha256:b621c2034eb2998e602409ab41b5c574d24e265088787fd7331c8308eec6d7cb +size 178268 diff --git a/docs/source/_static/guide_hello_world_data.png b/docs/source/_static/guide_hello_world_data.png index 6164f4d55..105a2292a 100644 --- a/docs/source/_static/guide_hello_world_data.png +++ b/docs/source/_static/guide_hello_world_data.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cda3395fb158706eeffc669f3f7cf09b99316870e32f51f69aedc9a6f1590ddb -size 123621 +oid sha256:11652d0a0cfef535eb7e9fe1b796cbd2a6ef3f779dd5ce477273fcfda4cefb99 +size 207602 diff --git a/docs/source/_static/guide_hello_world_vmax.png b/docs/source/_static/guide_hello_world_vmax.png index 91441a16c..c90785b1b 100644 --- a/docs/source/_static/guide_hello_world_vmax.png +++ b/docs/source/_static/guide_hello_world_vmax.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:36902d1e082730af8dc383ff7f89434c93b9e605f0410dd199d39495cd61c552 -size 143561 +oid sha256:14f07430628acef116b5e426fa274978127b2f8decb2655b8367edf5ca731501 +size 170500 diff --git a/docs/source/user_guide/guide.rst b/docs/source/user_guide/guide.rst index 87e2b7fab..4ee374389 100644 --- a/docs/source/user_guide/guide.rst +++ b/docs/source/user_guide/guide.rst @@ -18,7 +18,7 @@ or install the bleeding edge from Github: What is ``fastplotlib``? ----------------------- +------------------------ ``fastplotlib`` is a cutting-edge plotting library built using the ```pygfx`` `_ rendering engine. 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 How to use ``fastplotlib`` ------------------------- +-------------------------- Before giving a detailed overview of the library, here is a minimal example:: @@ -49,7 +49,7 @@ Before giving a detailed overview of the library, here is a minimal example:: if __name__ == "__main__": fpl.run() -.. image:: ./_static/guide_hello_world.png +.. image:: ../_static/guide_hello_world.png 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 image_graphic.vmax = 150 -.. image:: ./_static/hello_world_vmax.png +.. image:: ../_static/guide_hello_world_vmax.png ``Graphic`` properties also support slicing and indexing. For example :: image_graphic.data[::8, :, :] = 1 image_graphic.data[:, ::8, :] = 1 -.. image:: ./_static/hello_world_data.png +.. image:: ../_static/guide_hello_world_data.png Selectors @@ -211,7 +211,7 @@ data. Let's look at an example: :: fig.show(maintain_aspect=False) -.. image:: _static/guide_linear_selector.gif +.. image:: ../_static/guide_linear_selector.gif A ``LinearRegionSelector`` is very similar to a ``LinearSelector`` but as opposed to selecting a singular point of @@ -448,7 +448,8 @@ For example: :: nearest.colors = "w" fig.show() -.. image:: ./_static/click_event.gif + +.. image:: ../_static/click_event.gif ImageWidget ----------- @@ -472,7 +473,7 @@ to easily navigate through different dimensions of your data. Let's look at an e iw_movie.show() -.. image:: _static/guide_image_widget.gif +.. image:: ../_static/guide_image_widget.gif Animations ---------- @@ -496,7 +497,7 @@ An animation function is a user-defined function that gets called on every rende fig.show() -.. image:: _static/guide_animation.gif +.. image:: ../_static/guide_animation.gif 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 user-defined function will receive a plot instance as an argument when it is called. pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy