diff --git a/docs/demos.md b/docs/demos.md deleted file mode 100644 index c754976..0000000 --- a/docs/demos.md +++ /dev/null @@ -1,15 +0,0 @@ -# Demos - -## Isolated galaxies -[demo1](../notebooks/demos/demo1.ipynb) -simulates noisy galaxies with different SNRs and processes the galaxies with FPFS -shear estimator. -+ fpfs.simutil.sim_test: a wrapper of galsim to simulate galaxies for simple tests; -+ fpfs.fpfsBase.fpfsTask: a task to process galaxy images and measure shear. - -[demo2](../notebooks/demos/demo2.ipynb) -estimates shear under a more realistic situation with **PSF errors**. - -## Blended galaxies -[demo1]() -estimates shear from blended galaxies distorted by the same shear. diff --git a/docs/fpfs.rst b/docs/fpfs.rst index e262e81..e4edc96 100644 --- a/docs/fpfs.rst +++ b/docs/fpfs.rst @@ -1,42 +1,11 @@ -Modules +FPFS ============ -fpfs.catalog -------------------- +.. toctree:: + :maxdepth: 1 -.. automodule:: fpfs.catalog - :members: - :undoc-members: - :show-inheritance: - -fpfs.image ------------------ - -.. automodule:: fpfs.image - :members: - :undoc-members: - :show-inheritance: - -fpfs.imgutil -------------------- - -.. automodule:: fpfs.imgutil - :members: - :undoc-members: - :show-inheritance: - -fpfs.pltutil -------------------- - -.. automodule:: fpfs.pltutil - :members: - :undoc-members: - :show-inheritance: - -fpfs.simutil -------------------- - -.. automodule:: fpfs.simutil - :members: - :undoc-members: - :show-inheritance: + fpfs_image + fpfs_catalog + fpfs_imgutil + fpfs_simutil + fpfs_pltutil diff --git a/docs/fpfs_catalog.rst b/docs/fpfs_catalog.rst new file mode 100644 index 0000000..4db6dae --- /dev/null +++ b/docs/fpfs_catalog.rst @@ -0,0 +1,7 @@ +fpfs.catalog +------------------- + +.. automodule:: fpfs.catalog + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fpfs_image.rst b/docs/fpfs_image.rst new file mode 100644 index 0000000..e403686 --- /dev/null +++ b/docs/fpfs_image.rst @@ -0,0 +1,7 @@ +fpfs.image +----------------- + +.. automodule:: fpfs.image + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fpfs_imgutil.rst b/docs/fpfs_imgutil.rst new file mode 100644 index 0000000..a7682fc --- /dev/null +++ b/docs/fpfs_imgutil.rst @@ -0,0 +1,7 @@ +fpfs.imgutil +------------------- + +.. automodule:: fpfs.imgutil + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fpfs_pltutil.rst b/docs/fpfs_pltutil.rst new file mode 100644 index 0000000..fca3e22 --- /dev/null +++ b/docs/fpfs_pltutil.rst @@ -0,0 +1,7 @@ +fpfs.pltutil +------------------- + +.. automodule:: fpfs.pltutil + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fpfs_simutil.rst b/docs/fpfs_simutil.rst new file mode 100644 index 0000000..3a32cdf --- /dev/null +++ b/docs/fpfs_simutil.rst @@ -0,0 +1,7 @@ +fpfs.simutil +------------------- + +.. automodule:: fpfs.simutil + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index ebcbde8..e5e2de6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,6 +5,16 @@ FPFS: A fast, accurate shear estimator ====================================== +Fourier Power Function Shapelets (FPFS) is an innovative estimator for the +shear responses of galaxy shape, flux, and detection. Utilizing leading-order +perturbations of shear (a vector perturbation) and image noise (a tensor +perturbation), FPFS determines shear and noise responses for both measurements +and detections. Unlike traditional methods that distort each observed galaxy +repeatedly, FPFS employs analytical shear responses of select basis functions, +including Shapelets basis and peak basis. Remarkably efficient, FPFS can +process approximately 1,000 galaxies within a single CPU second. Testing under +simple simulations has proven its capability to maintain a multiplicative shear +estimation bias below 0.5%, even amidst blending challenges. .. toctree:: :maxdepth: 2 @@ -13,8 +23,6 @@ FPFS: A fast, accurate shear estimator Examples - Demos - fpfs