PulsarPeak#
- class ptiming_ana.phaseogram.PulsarPeak(peak_limits, peaktype='signal')#
Bases:
object- A class to manipulate and store information about the statistics of certain regions in a phase list object. 2 types of regions:
Signal region: peaks present in the lightcurve
Background region: background statistics
- Parameters:
- lc_dataPulsarPhases class object
PulsarPhases object from which we extract the pulsar phases and the OFF region statistics
- peak_limitslist
list of phase edges used to define the region. To define a non continuos region (for instance, the sum of two independent peaks), a list of four edges can be provided.
- peak_typestr, optional
‘Background’ or ‘Signal’ type to calculate especific statistics.
- Note: To obtain peak statistics an OFF region must be defined in the phase list object first.
- Attributes:
- limits: str
region phase edges
- type: str
the type of region defined (signal or background)
- deltaP: float
the total phase range of the region
- phases: numpy array
list of phases that fall into the region
- number: int
number of events in the region
- nregions: int
number of phase intervals that define the region
- For ‘signal’ type only:
- sign: float
Li&Ma Significance of the excess of events from the peak with respect to the background
- Nex: int
Number of excess events in the peaks
- yerr: float
Estimated error of the number of excess events
- sign_ratio: float
Ratio of the significance and the square root of the time of observation.
- s_n_ratio: float
Signal to noise ratio
Methods Summary
fillPeak(phases)make_stats(regions, tobs)Methods Documentation
- fillPeak(phases)#
- make_stats(regions, tobs)#