Updates docs + fixed bug in helper function converting readme into do…

…cs sections
vortex-exoplanet · Mar 28, 2022 · 36f26d8 · 36f26d8
1 parent 5d3145c
commit 36f26d8
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/docs/source/Image-conventions.rst b/docs/source/Image-conventions.rst
@@ -0,0 +1,11 @@
+Image conventions
+-----------------
+
+By default, VIP routines are compatible with either even- or odd-dimension input frames. For VIP routines that require the star to be centered in the input images (e.g. post-processing routines involving (de)rotation or scaling), the code will assume that it is placed on (zero-based indexing):
+
+- size/2-0.5 for odd-size input images; 
+- size/2 for even-size input images;
+
+i.e. exactly on a pixel in either cases. The VIP recentering routines will place the star centroid at one of these locations accordingly.
+
+
diff --git a/helpers/update_docs_rst_from_README.py b/helpers/update_docs_rst_from_README.py
@@ -33,7 +33,7 @@
                 if occ > titles_occ[i]:
                     f_i.write(line)
                     start_write=True
-            elif str_titles[i+1] in line:
+            elif str_titles[i+1] in line and occ > titles_occ[i]:
                 stop_write=True
             else:
                 continue