nustar/nuwavdet
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Андрей Мухин 2022-09-09 16:53:21 +03:00 committed by GitHub
parent 4730870f16
commit fcff673291
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -3,14 +3,17 @@
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. 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: Additionaly, it generates a table containing:
Useful data about the observation: Useful data about the observation:
1. OBS_ID 1. OBS_ID
2. Detector 2. Detector
3. coordinates in equatorial (ra,dec) and galactical (lon,lat) systems 3. Coordinates in equatorial (ra,dec) and galactical (lon,lat) systems
4. time of the observation in seconds 4. Time of the observation in seconds
5. exposure 5. Exposure
Useful algorythm-related data: Useful algorythm-related data:
6. average count rate on unmasked area 6. average count rate on unmasked area
7. portion of unmasked area 7. portion of unmasked area
8. specific statistical metric[1] before and after masking the detected sources 8. specific statistical metric[1] before and after masking the detected sources
@ -29,4 +32,12 @@ To use the package in your project, import it in by writing
`from nuwavsource import nuwavsource` `from nuwavsource import nuwavsource`
The list of useful tools in this package is You can process the cl.evt file by creating an Observation class object:
`obs = nuwavsource.Observation(path_to_evt_file)`
Additionally, the energy band to get events from can be passed as an argument:
`obs = nuwavsource.Observation(path_to_evt_file,E_borders=[E_min,E_max])`
The default value used in the code is [3,20]