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:42:05 +03:00 committed by GitHub
parent 5af064884d
commit 4fb0fe733b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,8 +1,18 @@
# 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)
## Installation
This package is to be used with Python 3.x.x
To install tha package write
`pip install nuwavsource`
## Usage
To use the package in your project, import it in by writing
`from nuwavsource import nuwavsource`
The list of useful tools in this package is