From 3e7bdb623b9b196e18093ce448b39a9357434cba Mon Sep 17 00:00:00 2001 From: Kamuish Date: Tue, 17 Nov 2020 21:49:07 +0000 Subject: [PATCH] updating documentation --- docs/tutorials/LC_extract.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/tutorials/LC_extract.rst b/docs/tutorials/LC_extract.rst index f1d87be..4f81602 100644 --- a/docs/tutorials/LC_extract.rst +++ b/docs/tutorials/LC_extract.rst @@ -65,6 +65,22 @@ In order to understand the organization of data inside the "data_fits" objects a refer back to Section :ref:`outputs`. +It is **highly recommended** that the user builds its own routine to estimate the noise in the lightcurve. To do so, a given metric must be passed in the configs_override + This metric will be minimized during the mask selection routine. The current version only gives the user the flux and observation time. + +.. code:: python + + from pyarchi import Photo_controller, store_data + + controller = Photo_controller(job_number = 1, + config_path="/config.yaml" + ) + def noise_metric(flux, time): + metric = np.std(flux) + return metric + configs_override = {'CDPP_type': noise_metric} + + How to plot the outputs --------------------------------