Few doc improvements

CHANGES.md

@@ -26,11 +26,17 @@ This will be a big breaking release.
   {func}`fluidimage.works.BaseWorkFromSerie.process_1_serie` (see the examples on
   [preprocessing](./examples/preproc.md) and [PIV](./examples/piv_try_params.md)).
 
-- The work classes {class}`fluidimage.works.image2image.WorkImage2Image` and
+- The work classes {class}`fluidimage.image2image.Work` and
   {class}`fluidimage.works.bos.WorkBOS`
   now have a parameters in `params.images` and a method
   {func}`fluidimage.works.BaseWorkFromImage.process_1_image`.
 
+- The work class {class}`fluidimage.image2image.Work` has a new method
+  {func}`fluidimage.works.image2image.WorkImage2Image.display`.
+
+- The work class {class}`fluidimage.preproc.Work` has a new method
+  {func}`fluidimage.works.preproc.WorkPreproc.display`.
+
 ## [0.2.0] (2024-02-19)
 
 - Python >=3.9,<3.12

doc/autosum.rst

@@ -11,6 +11,7 @@ API reference
    fluidimage.calcul
    fluidimage.piv
    fluidimage.preproc
+   fluidimage.image2image
    fluidimage.calibration
    fluidimage.reconstruct
    fluidimage.postproc

doc/conf.py

@@ -41,6 +41,7 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
     "numpydoc",
     "fluiddoc.mathmacro",
     "sphinx.ext.inheritance_diagram",  # requires Graphviz
@@ -325,3 +326,7 @@
 ]
 
 suppress_warnings = ["mystnb.unknown_mime_type"]
+
+intersphinx_mapping = {
+    "fluiddyn": ("https://fluiddyn.readthedocs.io/en/latest", None)
+}

doc/examples/optflow_try_params.md

@@ -7,7 +7,8 @@ this example:
 ```{literalinclude} optflow_try_params.py
 ```
 
-The parameters in `params.series` are used to define an object `SeriesOfArrays`
+The parameters in `params.series` are used to define an object 
+{class}`fluiddyn.util.serieofarrays.SeriesOfArrays`
 and to select one serie (which represents here a couple of images). It is also
 what is done internally in the topology. Have a look at
 [our tutorial](https://fluiddyn.readthedocs.io/en/latest/ipynb/tuto_serieofarrays.html)

doc/examples/piv_try_params.md

@@ -8,7 +8,8 @@ look for the best parameters for a PIV computation. It is better to use the PIV
 ```{literalinclude} piv_try_params.py
 ```
 
-The parameters in `params.series` are used to define an object `SeriesOfArrays`
+The parameters in `params.series` are used to define a
+{class}`fluiddyn.util.serieofarrays.SeriesOfArrays`
 and to select one serie (which represents here a couple of images). It is also
 what is done internally in the PIV topology. Have a look at
 [our tutorial](https://fluiddyn.readthedocs.io/en/latest/ipynb/tuto_serieofarrays.html)

doc/examples/piv_try_params.py

@@ -1,8 +1,8 @@
 """To be run in IPython to find a good set of parameters"""
 
-from fluidimage.piv import WorkPIV
+from fluidimage.piv import Work
 
-params = WorkPIV.create_default_params()
+params = Work.create_default_params()
 
 params.multipass.number = 2
 params.multipass.use_tps = True
@@ -19,7 +19,7 @@
 params.series.path = path
 params.series.str_subset = "i+1:i+3"
 
-work = WorkPIV(params=params)
+work = Work(params=params)
 
 piv = work.process_1_serie()
 

doc/examples/preproc.md

@@ -19,7 +19,7 @@ to first investigate which are the better parameters for your case:
 ```
 
 and then process a large serie of images in parallel with the class
-{class}`fluidimage.topologies.image2image.TopologyImage2Image`.
+{class}`fluidimage.image2image.Topology`.
 
 ```{literalinclude} im2im_parallel.py
 ```
@@ -32,7 +32,7 @@ standard preprocessing to images.
 ### Preprocessing one serie
 
 To find the good parameter, you can use the class
-{class}`fluidimage.work.preproc.Work` (see also
+{class}`fluidimage.preproc.Work` (see also
 {mod}`fluidimage.preproc`).
 
 ```{literalinclude} preproc_try_params.py
@@ -41,7 +41,7 @@ To find the good parameter, you can use the class
 ### Preprocessing large series of images
 
 To apply the preprocessing to a large serie of images in parallel, use
-{class}`fluidimage.topologies.preproc.TopologyPreproc`.
+{class}`fluidimage.preproc.Topology`.
 
 ```{literalinclude} preproc_parallel.py
 ```

src/fluidimage/topologies/preproc.py

@@ -107,15 +107,15 @@ def create_default_params(cls, backend="python"):
 
 ind_start : int
     Start index for the whole series of images being loaded.
-    For more details: see `class SeriesOfArrays`.
+    For more details: see {class}`fluiddyn.util.serieofarrays.SeriesOfArrays`.
 
 ind_stop : int
     Stop index for the whole series of images being loaded.
-    For more details: see `class SeriesOfArrays`.
+    For more details: see {class}`fluiddyn.util.serieofarrays.SeriesOfArrays`.
 
 ind_step : int
     Step index for the whole series of images being loaded.
-    For more details: see `class SeriesOfArrays`.
+    For more details: see {class}`fluiddyn.util.serieofarrays.SeriesOfArrays`.
 
 """
         )