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)

Remarks

The procedures under discussion are pure.

The procedures under discussion are elemental.

See also

getLogPbol
getLogPF53
getLog10PF53
getLogEffPPF
setBandEnergy
setBandPhoton
getCorrectionLogEffPPF

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK, LK
    use pm_kind, only: RKG => RKH ! all processor kinds are supported.
    use pm_io, only: display_type
    use pm_batse, only: getLogPbol
 
    implicit none
 
    integer(IK) :: info
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    block
 
        use pm_kind, only: RKG => RKD
 
        call disp%skip()
        call disp%show("getLogPbol(logEpk = 2._RKG, logPF53 = 0._RKG)")
        call disp%show( getLogPbol(logEpk = 2._RKG, logPF53 = 0._RKG) )
        call disp%skip()
 
    end block
 
    !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    ! Output an example array for visualization.
    !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    block
 
        use pm_arraySpace, only: setLinSpace
        use pm_distBand, only: getBandEbreak, setBandEnergy
        real(RKG) :: logEpk(1000), energy, alpha = -1.1, beta = -2.3
        integer :: fileUnit, i, info
 
        call setLinSpace(logEpk, log(1.e-3_RKG), log(1.e5_RKG))
        open(newunit = fileUnit, file = "getLogPbol.RK.txt")
        do i = 1, size(logEpk)
            call setBandEnergy(energy, 0.001_RKG, 20000._RKG, 1._RKG, 50._RKG, 300._RKG, alpha, beta, getBandEbreak(alpha, beta, exp(logEpk(i))), info)
            if (info < 0) error stop
            write(fileUnit, "(*(g0,:,' '))") exp(logEpk(i)), exp(getLogPbol(logEpk(i), 0._RKG)), energy / 1.e9
        end do
        close(fileUnit)
 
    end block
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
getLogPbol(logEpk = 2._RKG, logPF53 = 0._RKG)
-13.836739091145450
 
 

Postprocessing of the example output ⛓

#!/usr/bin/env python
 
import matplotlib.pyplot as plt
import pandas as pd
import numpy as np
import glob
import sys
 
fontsize = 17
 
kind = "RK"
 
pattern = "*." + kind + ".txt"
fileList = glob.glob(pattern)
if len(fileList) == 1:
 
    df = pd.read_csv(fileList[0], delimiter = " ")
 
    fig = plt.figure(figsize = 1.25 * np.array([6.4, 4.8]), dpi = 200)
    ax = plt.subplot()
 
    plt.plot( df.values[:, 1]
            , df.values[:, 0]
            , linewidth = 2
            )
 
    plt.plot( df.values[:,2]
            , df.values[:, 0]
            , linewidth = 2
            )
 
    plt.xticks(fontsize = fontsize - 2)
    plt.yticks(fontsize = fontsize - 2)
    ax.set_xlabel("Bolometric energy flux range", fontsize = fontsize)
    ax.set_ylabel("Epeak [ keV ]", fontsize = fontsize)
    ax.set_xscale("log")
    ax.set_yscale("log")
 
    plt.grid(visible = True, which = "both", axis = "both", color = "0.85", linestyle = "-")
    ax.tick_params(axis = "y", which = "minor")
    ax.tick_params(axis = "x", which = "minor")
 
    ax.legend   ( ["getLogPbol()", "setBandPhoton()"]
                , fontsize = fontsize
               #, loc = "center left"
               #, bbox_to_anchor = (1, 0.5)
                )
 
    plt.savefig(fileList[0].replace(".txt",".png"))
 
else:
 
    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.

Copyright

Computational Data Science Lab

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:

• src/fortran/main/pm_batse.F90