-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Major documentation update, including tutorials
- Loading branch information
1 parent
f3b41ee
commit aa4af0e
Showing
27 changed files
with
528 additions
and
298 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Index | ||
----- | ||
* :ref:`genindex` | ||
* :ref:`modindex` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
Structure | ||
--------- | ||
On the links below you can find the subpackages structure and access the | ||
docstrings (internal documentation) of each one of ``VIP``'s functions. | ||
|
||
``VIP`` implements basic image processing functionalities such as image | ||
registration, rotation, shift, rescaling, pixel temporal and spatial | ||
subsampling. On top of that several pre-processing functions are available | ||
such as recentering and bad frame removal. | ||
|
||
For Angular differential imaging (ADI) data several point spread function | ||
subtraction techniques are available: pairwise frame differencing, median | ||
subtraction, least-squares combination, NMF and PCA based algorithms. PCA | ||
methods are implemented in different flavours. Also PCA can process RDI and | ||
multiple channel SDI (IFS) data. ``VIP`` contains an implementation of the Local | ||
Low-rank plus Sparse plus Gaussian-noise decomposition (LLSG, Gomez Gonzalez et | ||
al. 2016). | ||
|
||
Functions for signal-to-noise ratio (S/N) estimation and S/N map generation are | ||
included, as well as injection of fake companions in 3D and 4D cubes. Flux and | ||
position of point-like sources are estimated using the Negative Fake Companion | ||
technique. ``VIP`` also implements algorithm throughput and contrast-curve | ||
generation routines. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
TL;DR setup guide | ||
----------------- | ||
.. code-block:: bash | ||
$ pip install vip_hci | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Mailing list | ||
------------ | ||
Please subscribe to our `mailing list <http://lists.astro.caltech.edu:88/mailman/listinfo/vip>`_ | ||
if you want to be informed of ``VIP``'s latest developments (new versions | ||
and/or updates). | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
Running the tutorials | ||
--------------------- | ||
|
||
Tutorials, in the form of Jupyter notebooks, showcasing ``VIP``'s usage and | ||
other resources can be visualised within this documentation. | ||
In order to execute them, you can either download/clone the | ||
``VIP-extras`` `repository <https://github.com/vortex-exoplanet/VIP_extras>`_, and open each tutorial locally with jupyter notebook. | ||
Alternatively, you can execute these tutorials on | ||
`Binder <https://mybinder.org/v2/gh/vortex-exoplanet/VIP_extras/master>`_. | ||
|
||
If you are new to the Jupyter notebook application check out the `beginner's guide | ||
<https://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/what_is_jupyter.html>`_. |
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.