Skip to content

Commit

Permalink
Additional tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
thuiop committed Apr 20, 2022
1 parent e7cb393 commit 56b6a00
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/source/src/btk.survey.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
btk.survey module
=========================
The survey module interfaces with the `galcheat <https://github.com/aboucaud/galcheat>`_ package ; this package contains various informations about different surveys, including LSST, HSC (wide-field survey), HST COSMOS... Those informations are stored in a galcheat :class:`~galcheat.survey.Survey` object, containing several galcheat :class:`~galcheat.filter.Filter` objects, which is retrieved in BTK to compute fluxes and noise levels (using functions which are available in galcheat). The main modifications made by BTK to the galcheat objects are adding the PSF to the Filter object, and making them editable. This is achieved by defining a BTK :class:`~bkt.survey.Survey` and a BTK:class:`~bkt.survey.Filter` objects, which directly inherit from the corresponding galcheat objects.
The survey module interfaces with the `galcheat <https://github.com/aboucaud/galcheat>`_ package ; this package contains various informations about different surveys, including LSST, HSC (wide-field survey), HST COSMOS... Those informations are stored in a galcheat :class:`~galcheat.survey.Survey` object, containing several galcheat :class:`~galcheat.filter.Filter` objects, which is retrieved in BTK to compute fluxes and noise levels (using functions which are available in galcheat). The main modifications made by BTK to the galcheat objects are adding the PSF to the Filter object, and making them editable. This is achieved by defining a BTK :class:`~bkt.survey.Survey` and a BTK :class:`~bkt.survey.Filter` objects, which directly inherit from the corresponding galcheat objects.

.. automodule:: btk.survey
4 changes: 2 additions & 2 deletions docs/source/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,8 @@ You may write more complex sampling functions to have more control over how the
Survey
.......

BTK relies on the `galcheat <https://github.com/aboucaud/galcheat>`_ package, which contains several `galcheat.survey.Survey` instances, which store the parameters for different surveys (including LSST, HSC, HST COSMOS...). The parameters represent physical parameters of the survey (mirror size, pixel scale) ; each survey also contains several `galcheat.filter.Filter` objects with the parameters specific to each filter (exposure time, zeropoint).
Those objects can easily be imported in BTK using the following function and the name of the survey. Internally, we use a `btk.survey.Survey` and a corresponding `btk.filter.Filter`, which can be modified by the user (galcheat objects cannot) and contain an additional PSF attribute.
BTK relies on the `galcheat <https://github.com/aboucaud/galcheat>`_ package, which contains several galcheat :class:`~galcheat.survey.Survey` instances, which store the parameters for different surveys (including LSST, HSC, HST COSMOS...). The parameters represent physical parameters of the survey (mirror size, pixel scale) ; each survey also contains several galcheat :class:`galcheat.filter.Filter` objects with the parameters specific to each filter (exposure time, zeropoint).
Those objects can easily be imported in BTK using the following function and the name of the survey. Internally, we use a :class:`btk.survey.Survey` and a corresponding :class:`btk.filter.Filter`, which can be modified by the user (galcheat objects cannot) and contain an additional PSF attribute.
For this tutorial, we will import the survey corresponding to LSST.

.. jupyter-execute::
Expand Down

0 comments on commit 56b6a00

Please sign in to comment.