Skip to content

Commit

Permalink
Add documentation for confidence
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderJCS committed Oct 24, 2022
1 parent 5fd5da6 commit 5752aea
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/exoplanet_struct.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5752aea

Please sign in to comment.