ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_batse::getLogPbol Interface Reference

Generate and return the conversion of an input natural logarithm of photon flux/fluence over a given time in the BATSE detection energy range \([50, 300]\kev\) to a bolometric ( \([0.0001, 20000]\kev\)) energy flux/fluence in units of \(\ergs\) over the same time.
More...

Detailed Description

Generate and return the conversion of an input natural logarithm of photon flux/fluence over a given time in the BATSE detection energy range \([50, 300]\kev\) to a bolometric ( \([0.0001, 20000]\kev\)) energy flux/fluence in units of \(\ergs\) over the same time.

See the Eqn A4 of Shahmoradi and Nemiroff 2015, MNRAS, Short versus long gamma-ray bursts for more details.

Parameters
[in]logEpk: The input scalar, or array of the same rank as other input array-valued arguments, of the same type and kind as logPPF64, containing the natural logarithm of the spectral peak energy of the GRB in units of \(\ergs\).
[in]logPF53: The input scalar, or array of the same rank as other input array-valued arguments, of type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128), containing the natural logarithm of the Photon Flux of an event in units of \([\ms{photons} / \ms{sec}]\).
Returns
logPbol : The output scalar or array of the same rank as the input arguments of same type and kind as the input arguments, containing the natural logarithm of the bolometric ( \([0.0001, 20000]\kev\)) energy flux of the GRB event in units of \(\ergs\) over the same time interval.


Possible calling interfaces

use pm_batse, only: getLogPbol
logPbol = getLogPbol(logEpk, logPF53)
Generate and return the conversion of an input natural logarithm of photon flux/fluence over a given ...
Definition: pm_batse.F90:427
This module contains procedures and generic interfaces for modeling data and detectors of the BATSE G...
Definition: pm_batse.F90:69
Remarks
The procedures under discussion are pure.
The procedures under discussion are elemental.
See also
getLogPbol
getLogPF53
getLog10PF53
getLogEffPPF
setBandEnergy
setBandPhoton
getCorrectionLogEffPPF


Example usage

1program example
2
3 use pm_kind, only: SK, IK, LK
4 use pm_kind, only: RKG => RKH ! all processor kinds are supported.
5 use pm_io, only: display_type
6 use pm_batse, only: getLogPbol
7
8 implicit none
9
10 integer(IK) :: info
11 type(display_type) :: disp
12 disp = display_type(file = "main.out.F90")
13
14 block
15
16 use pm_kind, only: RKG => RKD
17
18 call disp%skip()
19 call disp%show("getLogPbol(logEpk = 2._RKG, logPF53 = 0._RKG)")
20 call disp%show( getLogPbol(logEpk = 2._RKG, logPF53 = 0._RKG) )
21 call disp%skip()
22
23 end block
24
25 !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26 ! Output an example array for visualization.
27 !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28
29 block
30
31 use pm_arraySpace, only: setLinSpace
33 real(RKG) :: logEpk(1000), energy, alpha = -1.1, beta = -2.3
34 integer :: fileUnit, i, info
35
36 call setLinSpace(logEpk, log(1.e-3_RKG), log(1.e5_RKG))
37 open(newunit = fileUnit, file = "getLogPbol.RK.txt")
38 do i = 1, size(logEpk)
39 call setBandEnergy(energy, 0.001_RKG, 20000._RKG, 1._RKG, 50._RKG, 300._RKG, alpha, beta, getBandEbreak(alpha, beta, exp(logEpk(i))), info)
40 if (info < 0) error stop
41 write(fileUnit, "(*(g0,:,' '))") exp(logEpk(i)), exp(getLogPbol(logEpk(i), 0._RKG)), energy / 1.e9
42 end do
43 close(fileUnit)
44
45 end block
46
47end program example
Return the linSpace output argument with size(linSpace) elements of evenly-spaced values over the int...
Generate and return the spectral break energy parameter of the Band spectral model/distribution from ...
Generate and return the energy integral (the energy fluence in units of the input break energy) of th...
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
This module contains procedures and generic interfaces for generating arrays with linear or logarithm...
This module contains procedures and generic interfaces for computing the Band photon distribution wid...
Definition: pm_distBand.F90:97
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
integer, parameter RKD
The double precision real kind in Fortran mode. On most platforms, this is an 64-bit real kind.
Definition: pm_kind.F90:568
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
integer, parameter RKH
The scalar integer constant of intrinsic default kind, representing the highest-precision real kind t...
Definition: pm_kind.F90:858
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output
1
2getLogPbol(logEpk = 2._RKG, logPF53 = 0._RKG)
3-13.836739091145450
4
5

Postprocessing of the example output
1#!/usr/bin/env python
2
3import matplotlib.pyplot as plt
4import pandas as pd
5import numpy as np
6import glob
7import sys
8
9fontsize = 17
10
11kind = "RK"
12
13pattern = "*." + kind + ".txt"
14fileList = glob.glob(pattern)
15if len(fileList) == 1:
16
17 df = pd.read_csv(fileList[0], delimiter = " ")
18
19 fig = plt.figure(figsize = 1.25 * np.array([6.4, 4.8]), dpi = 200)
20 ax = plt.subplot()
21
22 plt.plot( df.values[:,1]
23 , df.values[:, 0]
24 , linewidth = 2
25 )
26
27 plt.plot( df.values[:,2]
28 , df.values[:, 0]
29 , linewidth = 2
30 )
31
32 plt.xticks(fontsize = fontsize - 2)
33 plt.yticks(fontsize = fontsize - 2)
34 ax.set_xlabel("Bolometric energy flux range", fontsize = fontsize)
35 ax.set_ylabel("Epeak [ keV ]", fontsize = fontsize)
36 ax.set_xscale("log")
37 ax.set_yscale("log")
38
39 plt.grid(visible = True, which = "both", axis = "both", color = "0.85", linestyle = "-")
40 ax.tick_params(axis = "y", which = "minor")
41 ax.tick_params(axis = "x", which = "minor")
42
43 ax.legend ( ["getLogPbol()", "setBandPhoton()"]
44 , fontsize = fontsize
45 #, loc = "center left"
46 #, bbox_to_anchor = (1, 0.5)
47 )
48
49 plt.savefig(fileList[0].replace(".txt",".png"))
50
51else:
52
53 sys.exit("Ambiguous file list exists.")

Visualization of the example output
Test:
test_pm_batse


Final Remarks


If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

  1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
  2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Author:
Amir Shahmoradi, Wednesday June 27, 2012, 7:15 PM, Institute for Fusion Studies, The University of Texas at Austin.

Definition at line 427 of file pm_batse.F90.


The documentation for this interface was generated from the following file: