From a0bfb6c3a73734bc4c2b5179ee527968e61ee143 Mon Sep 17 00:00:00 2001 From: AlexanderJCS <98898166+AlexanderJCS@users.noreply.github.com> Date: Mon, 24 Oct 2022 14:15:37 -0400 Subject: [PATCH] Update exoplanet_struct.md --- docs/exoplanet_struct.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/exoplanet_struct.md b/docs/exoplanet_struct.md index 3087a1c..34d25a0 100644 --- a/docs/exoplanet_struct.md +++ b/docs/exoplanet_struct.md @@ -8,7 +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.** +- `float confidence`: Percent confidence of an exoplanet between 0 and 1. All planets found by the deprecated FindPlanet::findPlanets() will always return 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 @@ -82,4 +82,4 @@ int main() float planetRadius = radiusRatio * starRadius; // find the radius of the planet in the units given for starRadius } } -``` \ No newline at end of file +```