FswLocation

class gdt.missions.fermi.gbm.trigdat.FswLocation

Bases: object

Class for the Flight Software localization information.

Attributes Summary

fluence	The fluence of the localization interval
hardness_ratio	The hardness ratio for the localization interval
intensity	The brightness of the signal
location	The RA, Dec, and statistical error of the onboard localization
location_sc	The localization in spacecraft coordinates: Azimuth, Zenith
next_classification	The next most likely classification of the trigger and the probability
rates	The rates in each NaI detector used for localization
significance	The S/N ratio of the localization interval
spectrum	The spectrum used in the localization
time	Time at which the localization was calculated
timescale	The localization interval timescale
top_classification	The most likely classification of the trigger and the probability

Methods Summary

create([time, radec, err, algorithm, ...])	Create a FswLocation object from keywords
from_recarray(rec_array)	Create from a FITS or numpy record array.
to_recarray()	Convert contents of the object to a numpy record array

Attributes Documentation

fluence

The fluence of the localization interval

Type:

(float)

hardness_ratio

The hardness ratio for the localization interval

Type:

(float)

intensity

The brightness of the signal

Type:

(float)

location

The RA, Dec, and statistical error of the onboard localization

Type:

(float, float, float)

location_sc

The localization in spacecraft coordinates: Azimuth, Zenith

Type:

(float, float)

next_classification

The next most likely classification of the trigger and the probability

Type:

(str, float)

rates

The rates in each NaI detector used for localization

Type:

(np.array)

significance

The S/N ratio of the localization interval

Type:

(float)

spectrum

The spectrum used in the localization

Type:

(str)

time

Time at which the localization was calculated

Type:

(float)

timescale

The localization interval timescale

Type:

(float)

top_classification

The most likely classification of the trigger and the probability

Type:

(str, float)

Methods Documentation

classmethod create(time=None, radec=(None, None), err=None, algorithm='normal', class1='UNCERT', class1_prob=1.0, class2='UNCERT', class2_prob=0.0, intensity=None, hardness=None, fluence=None, sigma=None, rates=None, timescale=None, azzen=(None, None))

Create a FswLocation object from keywords

Parameters:

• time (float, optional) – The time of the localization

• radec ((float, float), optional) – RA and Dec

• err (float, optional) – The localization error

• algorithm (str, optional) – The algorithm spectrum; one of ‘hard’, ‘normal’, or ‘soft’

• class1 (str, optional) – The primary classification

• class1_prob (float, optional) – The primary classification probability

• class2 (str, optional) – The secondary classification

• class2_prob (float, optional) – The secondary classification probability

• intensity – (float, optional): Intensity of the signal in the localization interval

• hardness – (float, optional): The hardness ratio in the localization interval

• fluence – (float, optional): The fluence in the localization interval

• sigma – (float, optional): The S/N ratio of the localization interval

• rates – (np.array, optional): A 12-element array containing the rate in each NaI used for localization

• timescale (float, optional) – The localization timescale

• azzen ((float, float), optional) – Spacecraft azimuth and zenith of the localization

Returns:

(FswLocation)

classmethod from_recarray(rec_array)

Create from a FITS or numpy record array.

Parameters:

rec_array (np.recarray) – The FITS OB_CALC record array from the trigdat file

Returns:

(FswLocation)

to_recarray()

Convert contents of the object to a numpy record array

Returns:

(np.recarray)