Skip to content

Commit

Permalink
updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Kamuish committed Nov 17, 2020
1 parent 2480b48 commit 3e7bdb6
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/tutorials/LC_extract.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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="<path_to_file>/config.yaml"
)
def noise_metric(flux, time):
metric = np.std(flux)
return metric
configs_override = {'CDPP_type': noise_metric}
How to plot the outputs
--------------------------------

Expand Down

0 comments on commit 3e7bdb6

Please sign in to comment.