Skip to content

Commit

Permalink
documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mschwamb committed Jan 5, 2025
1 parent 610b448 commit bcb7bed
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 15 deletions.
48 changes: 45 additions & 3 deletions docs/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Advanced User Features
==========================

.. warning::
**If you're new to sorcha, turn away from this section NOW! (we're only partially kidding)** This section provides information about features for advanced users of ``sorcha``. Changing or adjusting the parameters described in this section may produce unintended results. *With great power comes great responsibility. **Be very careful in applying the knowledge below.** Most users will not need to touch these parameters within ``sorcha``.
**If you're new to sorcha, turn away from this section NOW! (we're only partially kidding)** This section provides information about features for advanced users of ``sorcha``. Changing or adjusting the parameters described in this section may produce unintended results. **With great power comes great responsibility. Be very careful in applying the knowledge below.** Most users will not need to touch these parameters within ``sorcha``.

Setting the Random Number Generator Seed
---------------------------------------------
Expand All @@ -17,9 +17,51 @@ The value used to seed the random number generator can be specified via the **SO

.. tip::
If you're trying to reproduce a crash or a certain behavior in ``sorcha``, you can find the value that you need to set the random seed to in the log file.



Expert User Config File Options
-----------------------------------

The following options can be optionally added to an expert section of the :ref:`configs`. The section will start with::

[EXPERT]

Turning Vignetting Off
~~~~~~~~~~~~~~~~~~~~~~~~~~~

By default, vignetting using LSSTCam parameters is applied. To turn vignetting off, add to the configuratuion file::

[EXPERT]
vignetting_on = False

.. tip::
Vignetting is a small effect for the LSSTCam, so you will see only a modest change in results if you turn this off for LSST simulations


Turning Off the Randomization of the Magnitude and Astrometry Values
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There may be a reason that you want to turn off the randomization of the trailed source magnitude and PSF magnitude as well as the RA and Dec values::

[EXPERT]
randomization_on = False


Turning Off Trailing Losses
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The trailing losses filter is on by default, but it can be turned off by including the option in the configuration file::

[EXPERT]
trailing_losses_on = False

.. warning::
We **very strongly recommend** that the user never turn this off, but we provide
this option for debugging or for speed increases when the user is absolutely sure
they are only supplying slow-moving objects.

SNR/Apparent Magnitude Filters
-------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. warning::
These filters are for the advanced user. If you only want to know what the survey will discover, you **DO NOT** need these filters on.
Expand Down
10 changes: 0 additions & 10 deletions docs/apparentmag.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,6 @@ Applying Photometric and Astrometric Uncerainties
Trailing Losses
-----------------

.. warning::
We **very strongly recommend** that the user never turn this off, but we provide
this option for debugging or for speed increases when the user is absolutely sure
they are only supplying slow-moving objects.

If the observed object is fast-moving, the signal will form a trail, reducing the measured magnitude.
This filter will recalculate the PSF magnitude of the observations, adjusting for trailing losses.

Expand All @@ -60,8 +55,3 @@ This filter will recalculate the PSF magnitude of the observations, adjusting fo
:alt: Sky image showing a short trailing source circled in red.
:align: center

The trailing losses filter is on by default, but it can be turned off by including the option in the configuration file::

[EXPERT]
trailing_losses_on = False

2 changes: 0 additions & 2 deletions docs/filters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,6 @@ This filter applies a model of this from a built-in function tailored specifical
`Araujo-Hauck et al. 2016 <https://ui.adsabs.harvard.edu/abs/2016SPIE.9906E..0LA/abstract>`_, with further
discussion and below figure from `Veres and Chesley 2017 <https://ui.adsabs.harvard.edu/abs/2017arXiv170506209C/abstract>`_.)

Vignetting is applied by default and cannot be turned off by the user in the config file.

.. image:: images/vignetting.jpg
:width: 500
:alt: Plot of the LSST camera footprint in Dec vs. RA, showing shaded dimming due to vignetting.
Expand Down

0 comments on commit bcb7bed

Please sign in to comment.