Skip to content

Commit 4f1c692

Browse files
committed
Changes in format for documentation
1 parent 4ebbf68 commit 4f1c692

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

src/astrohack/image_comparison_tool.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -85,27 +85,27 @@ def compare_fits_images(
8585
8686
.. rubric:: Comparison:
8787
Two types of comparison between the images are available:
88-
89-
* *direct*: Where the residuals are simply computed as Reference - Image.
90-
* *scaled*: Where the residuals are Reference - Factor * Image, with Factor = median(Reference/Image).
88+
- *direct*: Where the residuals are simply computed as Reference - Image.
89+
- *scaled*: Where the residuals are Reference - Factor * Image, with Factor = median(Reference/Image).
9190
9291
.. rubric:: Plots:
9392
A plot of the residuals of the comparison is always produced.
9493
However, a few extra plots can be produced and their production is controlled by the plot_ parameters, these are:
95-
* *plot_data*: Activates plotting of the data used in the comparison, default is False as this is the data on the \
96-
FITS file.
97-
* *plot_percentuals*: Activates the plotting of the residuals as a perdentage of the Reference Image, default is \
98-
False as this is just another view on the residuals.
99-
* *plot_divided_image*: Activates the plotting of Reference/Image, default is False. This plot is only available \
100-
when using "scaled" comparison.
101-
* *plot_scatter*: Activates the creation of a scatter plot of Reference vs Image, with a linear regression, default \
102-
is True.
94+
- *plot_data*: Activates plotting of the data used in the comparison, default is False as this is the data on \
95+
the FITS file.
96+
- *plot_percentuals*: Activates the plotting of the residuals as a perdentage of the Reference Image, default \
97+
is False as this is just another view on the residuals.
98+
- *plot_divided_image*: Activates the plotting of Reference/Image, default is False. This plot is only \
99+
available when using "scaled" comparison.
100+
- *plot_scatter*: Activates the creation of a scatter plot of Reference vs Image, with a linear regression, \
101+
default is True.
103102
104103
.. rubric:: Storage on disk:
105104
By default, this function only produces plots, but this can be changed using two parameters:
106-
* *zarr_container_name*: If this parameter is not None a Zarr container will be created on disk with the contents \
107-
of the produced DataTree.
108-
* *export_to_fits*: If set to True will produce FITS files of the produced images and store them at *destination*.
105+
- *zarr_container_name*: If this parameter is not None a Zarr container will be created on disk with the \
106+
contents of the produced DataTree.
107+
- *export_to_fits*: If set to True will produce FITS files of the produced images and store them at \
108+
*destination*.
109109
110110
.. rubric:: Return type:
111111
This funtion returns a Xarray DataTree containing the Xarray DataSets that represent Image and Reference. The nodes \

0 commit comments

Comments
 (0)