diff --git a/README.md b/README.md index ffd81e3..971e199 100644 --- a/README.md +++ b/README.md @@ -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. 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 +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 @@ -29,4 +32,12 @@ 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 +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]