Pulse Profiles: A quickstart guide - Revision history

Thalhammer: /* Pulse profiles from event files */

2024-06-07T15:00:34Z

Pulse profiles from event files

Thalhammer at 12:44, 7 June 2024

2024-06-07T12:44:13Z

Thalhammer at 12:42, 7 June 2024

2024-06-07T12:42:42Z

Thalhammer at 12:37, 7 June 2024

2024-06-07T12:37:14Z

Thalhammer: Typos

2024-06-07T12:34:29Z

Typos

Thalhammer: Quick-start guide on pulse profiles in ISIS

2024-06-07T12:13:24Z

Quick-start guide on pulse profiles in ISIS

New page

=== Pules Profiles in ISIS ===

This is supposed to be a very short introduction on how to generate X-ray pulse profile in ISIS. To begin with you need on either the arrival times of all the events in your observation or a light-curve of this observation. While it is less important when using a local pulse period and a short observation, it would be advisable to use barycentered times and depending on your source apply also orbital correction (usually less important).

In the following we will use a NICER observation of EXO 2030-375 as an example.

=== Pulse profiles from event files ===

First we want to describe the generation of pulse profiles directly from the (cleaned) event file. For this we load the event file into isis. Then we might want to select the event by their energy, which is usually quantified in the PI or PHA parameter. For NICER the relationship is simply
EN / 1keV = PI * 0.01
For NuSTAR the relation would be
EN / 1keV = E = PI * 0.04 + 1.6

<pre>
variable filename = "/userdata/data/thalhammer/3C50_EXO230_highres/4201960150/ni4201960150_0mpu7_cl.evt";

variable evts = fits_read_table(filename);

variable n = where (50 < evts.pi < 1000 );
variable tms = evts.time [n] ;
</pre>

To find the local pulse period we use the function "epfold" (make sure to consult "help epfold") to fold the event times onto a range of trial pulse profiles and calculate according to some statistic where the resulting profile shows the most deviation from flat noise.
It is crucial for both speed and accuracy of this step to provide a reasonable range of periods to sample.
Further you want to provide the GTIs where events where actually detectable.

<pre>
variable gti = fits_read_table( filename + "[GTI]");

variable ep = epfold(tms,41.15,41.25;gti=gti);
</pre>

To find the local period we will first have a look at the resulting statistic and determine its maximum. You know that your results are reliable if the plot below "looks like its giving you the finger" and has a clear maximum:

<pre>
xlabel("ep.p"); ylabel("ep.stat");
plot(ep.p , ep.stat);

variable p = ep.p [wherefirstmax (ep.stat)];
</pre>

[[file:Epfold.png]]

Finding the peak of this function can also be made more precise, e.g. by fitting a Gaussian, but will keep it simple in this example. Now that we know the local period, we can simply fold on this period to get profile. Consult "help pfold" if you want e.g. a higher number of phase bins:

<pre>
variable pf = pfold(tms, p ;gti=gti);
hplot_with_err (pf);
</pre>

[[file:Pprofile.png]]

=== Pulse profiles from light-curves ===

The whole thing can also be done using light-curves. The advantage is that this includes for some observatories, e.g. NuSTAR, addition corrections such as vignetting and a background can be subtracted. However, each energy selection requires a new run of e.g nuextract. The script would then look like this

<pre>
variable filename = "ni4201960150_0.01s_0500eV-10000eV.lc";
variable dt = 0.01;
variable lc = fits_read_table(filename);
variable gti = fits_read_table(filename+"[GTI]");

variable ep = epfold(lc.time,lc.rate,41.0,41.4;gti=gti ,dt=dt*lc.fracexp);
variable p = ep.p [wherefirstmax (ep.stat)];

variable pf = pfold(lc.time,lc.rate, p;dt=dt,gti=gti,fracexp=lc.fracexp);

</pre>

=== Further resources: ===
* It might be interesting to read up on the help for some of the higher level functions implemented by Matthias: find_peak, pulseperiod_search, pulseperiod_magic, pulseperiod_epfold
* There is also a pulse profile review in work. A draft of which can be captained from some people at the observatory

[[Category:Isis / Slang]]

@@ Line 12: / Line 12: @@
   EN / 1keV  = PI * 0.01 .
 For NuSTAR the relation would be
-  EN / 1keV  =  E = PI * 0.04  + 1.6 .
+  EN / 1keV  = PI * 0.04  + 1.6 .
 <pre>
@@ Line 52: / Line 52: @@
 [[file:Pprofile.png|560px]]
 === Pulse profiles from light-curves ===

@@ Line 42: / Line 42: @@
 </pre>
-[[file:Epfold.png]]
+[[file:Epfold.png|560px]]
 Finding the peak of this function can also be made more precise, e.g. by fitting a Gaussian, but we will keep it simple in this example. Now that we know the local period, we can simply fold on this period to get profile. Consult "help pfold" if you want e.g. a higher number of phase bins:
@@ Line 51: / Line 51: @@
 </pre>
-[[file:Pprofile.png]]
+[[file:Pprofile.png|560px]]

@@ Line 4: / Line 4: @@
 This is a very short introduction on how to generate X-ray pulse profile in ISIS. To begin, you need either the arrival times of all the events in your observation or a light-curve of this observation. While it is less important when using a local pulse period and a short observation, it would be advisable to use barycentered times and  depending on your source apply also orbital correction (usually less important).
-In the following we will use a NICER observation of EXO 2030-375 as an example.
+In the following we will use a NICER observation of EXO 2030+375 as an example.
@@ Line 23: / Line 23: @@
 </pre>
-To find the local pulse period we use the function "epfold" (make sure to consult "help epfold") to fold the event times onto a range of trial pulse periods and calculate according to some statistic where the resulting profile shows the most deviation from flat noise.
+To find the local pulse period we use the function "epfold" (make sure to consult 'help epfold') to fold the event times onto a range of trial pulse periods and calculate according to some statistic where the resulting profile shows the most deviation from flat noise.
 It is crucial for both speed and accuracy of this step to provide a reasonable range of periods.
 Further you want to provide the GTIs where events were actually detectable.
@@ Line 44: / Line 44: @@
 [[file:Epfold.png]]
-Finding the peak of this function can also be made more precise, e.g. by fitting a Gaussian, but will keep it simple in this example. Now that we know the local period, we can simply fold on this period to get profile. Consult "help pfold" if you want e.g. a higher number of phase bins:
+Finding the peak of this function can also be made more precise, e.g. by fitting a Gaussian, but we will keep it simple in this example. Now that we know the local period, we can simply fold on this period to get profile. Consult "help pfold" if you want e.g. a higher number of phase bins:
 <pre>
@@ Line 56: / Line 56: @@
 === Pulse profiles from light-curves ===
-The whole thing can also be done using light-curves. The advantage is that this includes for some observatories, e.g. NuSTAR, addition corrections such as vignetting and a background can be subtracted. However, each energy selection requires a new run of e.g nuextract.  The script would then look like this
+The whole thing can also be done using light-curves. The advantage is that this includes for some observatories, e.g. NuSTAR, additional corrections such as vignetting. Further this allows for background to be subtracted. However, each energy selection requires a new run of e.g nuextract.  The script would then look like this:
@@ Line 73: / Line 73: @@
 === Further resources: ===
-* It might be interesting to read up on the help for some of the higher level functions implemented by Matthias: find_peak, pulseperiod_search, pulseperiod_magic, pulseperiod_epfold
+* It might be interesting to read up on some of the higher level functions implemented by Matthias: find_peak, pulseperiod_search, pulseperiod_magic, pulseperiod_epfold
-* There is also a pulse profile review in work. A draft of which can be captained from some people at the observatory
+* There is also a pulse profile review in work. A draft of which can be obtained e.g. by asking Joern.
 [[Category:Isis / Slang]]

@@ Line 1: / Line 1: @@
-===  Pules Profiles in ISIS ===
+===  Pulse Profiles in ISIS ===
-This is supposed to be a very short introduction on how to generate X-ray pulse profile in ISIS. To begin with you need on either the arrival times of all the events in your observation or a light-curve of this observation. While it is less important when using a local pulse period and a short observation, it would be advisable to use barycentered times and  depending on your source apply also orbital correction (usually less important).
+This is a very short introduction on how to generate X-ray pulse profile in ISIS. To begin, you need either the arrival times of all the events in your observation or a light-curve of this observation. While it is less important when using a local pulse period and a short observation, it would be advisable to use barycentered times and  depending on your source apply also orbital correction (usually less important).
 In the following we will use a NICER observation of EXO 2030-375 as an example.