From 4730870f16cd3f751096245bd93b77e9e91a72e3 Mon Sep 17 00:00:00 2001 From: Andrey Mukhin Date: Fri, 9 Sep 2022 16:45:19 +0300 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 73ced59..ffd81e3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,20 @@ # nuwavsource -This package is supposed to be used to detect the sources in NuStar observations and generate a mask excluding the signal from the sources of any kind. Additionaly, it generates a table containing useful data about the observation(OBS_ID, Detector, coordinates in equatorial (ra,dec) and galactical (lon,lat) systems, time of the observation in seconds, exposure) and useful algorythm-related data (average count rate on unmasked area, portion of unmasked area, specific statistical metric[1] before and after masking the detected sources and root-mean-square of counts in unmasked area) +This package is supposed to be used to detect the sources in NuStar observations and generate a mask excluding the signal from the sources of any kind. + +Additionaly, it generates a table containing: +Useful data about the observation: +1. OBS_ID +2. Detector +3. coordinates in equatorial (ra,dec) and galactical (lon,lat) systems +4. time of the observation in seconds +5. exposure + +Useful algorythm-related data: +6. average count rate on unmasked area +7. portion of unmasked area +8. specific statistical metric[1] before and after masking the detected sources +9. root-mean-square of counts in unmasked area ## Installation This package is to be used with Python 3.x.x