From 5752aea2c710d6f0ed9c2caad591d8ba9a00861e Mon Sep 17 00:00:00 2001 From: Alex Date: Mon, 24 Oct 2022 14:08:58 -0400 Subject: [PATCH] Add documentation for confidence --- docs/exoplanet_struct.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/exoplanet_struct.md b/docs/exoplanet_struct.md index 6e07d97..3087a1c 100644 --- a/docs/exoplanet_struct.md +++ b/docs/exoplanet_struct.md @@ -8,6 +8,7 @@ The exoplanet struct contains three main values: - `float averageFlux`: The average normalized flux of the planet. Normalized flux means that 1 = average brightness of the star and 0 = no light. - `float averagePeriod`: The average orbital period of the planet. - `Lightcurve planetDatapoints`: Specific datapoints the program found that signifies the exoplanet's existence. +- `float confidence`: Percent confidence of an exoplanet between 0 and 1. **Note that "1" does not mean that it is certain to be an exoplanet, but it is more probable that it is an exoplanet.** These values can be accessed by doing: ```cpp