diff --git a/docs/source/src/btk.survey.rst b/docs/source/src/btk.survey.rst index b75630ec9..fa06089ae 100644 --- a/docs/source/src/btk.survey.rst +++ b/docs/source/src/btk.survey.rst @@ -1,5 +1,5 @@ btk.survey module ========================= -The survey module interfaces with the `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 `_ 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 diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst index 96995d5b6..d2f3f132f 100644 --- a/docs/source/tutorials.rst +++ b/docs/source/tutorials.rst @@ -148,8 +148,8 @@ You may write more complex sampling functions to have more control over how the Survey ....... -BTK relies on the `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 `_ 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::