GregoryLoredo
Documentation for GregoryLoredo.
GregoryLoredo.lcshapeGregoryLoredo.orsumGregoryLoredo.persumGregoryLoredo.BinMultGregoryLoredo.BinningFactorGregoryLoredo.ComputeBinValuesGregoryLoredo.FrequencyRangeGregoryLoredo.FullBinMultGregoryLoredo.FullBinMultLogGregoryLoredo.LightCurveShapeGregoryLoredo.LightCurveSimpleShapeGregoryLoredo.MarginalizedPeriodogramGregoryLoredo.OddRatioSummaryGregoryLoredo.OddRatiosGregoryLoredo.PeriodogramGregoryLoredo.PeriodogramSummaryGregoryLoredo.PlotLightCurveGregoryLoredo.PlotOddRatiosGregoryLoredo.PlotPeriodogramGregoryLoredo.WeightingFactorGregoryLoredo.jtGregoryLoredo.logStirlingApprox
GregoryLoredo.lcshape — Typelcshape
Fields
- μlc: Vector of rate mean value for each bin
- σlc: Vector of standard deviation for the rate for each bin
GregoryLoredo.orsum — Typeorsum
Fields
- prob: Vector of probabilities for each possible bin number
m - maxm: Bin number showing the maximum probability
GregoryLoredo.persum — Typepersum
Fields
- maxpow: Maximum power in the periodogram
- maxfreq: Frequency at the maximum power
- maxper: Period at the maximum power
GregoryLoredo.BinMult — MethodBinMult(nbins::Vector{Int})
Arguments
nbinsis a vector with the number of events for each bin.
Compute the basic factor for the multiplicity of the binned events (Eq. 1.4 in Gregory & Lorendo (1992)).
GregoryLoredo.BinningFactor — MethodBinningFactor(ω::Float64,Φ::Float64,m::Int,tlist::Vector{Float64})::BigFloat
Arguments
ωis the angular frequency.Φis the phase.mis the number of bins.tlistis the vector of arrival times.
Compute the binning factor (Eq. B4 in Gregory & Lorendo (1992)).
GregoryLoredo.ComputeBinValues — MethodComputeBinValues(m::Int,ω::Float64,Φ::Float64,tlist::Vector{Float64})
Arguments
mis the number of bins.ωis the angular frequency.Φis the phase.tlistis the vector of arrival times.
Compute the number of events falling in each bin of a model with m bins with given frequency and phase.
GregoryLoredo.FrequencyRange — MethodFrequencyRange(Tlist::Vector{Float64};tstart=minimum(Tlist),tend=maximum(Tlist),logspacing=false))
Arguments
Tlistis the vector of arrival times.tstartis the minimum possible arrival time (default to the minimum of Tlist)tendis the minimum possible arrival time (default to the maximum of Tlist)logspacinggenerates a log-spaced frquency range.
Compute the frequency range to be analysed accordiong to the advises in Gregory & Lorendo (1992)).
GregoryLoredo.FullBinMult — MethodFullBinMult(nbins::Vector{Int})
Arguments
nbinsis a vector with the number of events for each bin.
Compute the full multiplicity of the binned events (Eq. 1.4 in Gregory & Lorendo (1992)).
GregoryLoredo.FullBinMultLog — MethodFullBinMultLog(nbins::Vector{Int})
Arguments
nbinsis a vector with the number of events for each bin.
Compute the full multiplicity of the binned events (Eq. 1.4 in Gregory & Lorendo (1992)).
The computation is here carried out by the logarithm.
GregoryLoredo.LightCurveShape — MethodLightCurveShape(ωr::Vector{Float64},m::Int,tlist::Vector{Float64};unc=false,progress=false,phasesteps=10)::lcshape
Arguments
ωris the vector of the analyzed frequencies.mis the number of bins.tlistis the vector of arrival times.unccomputes light-curve uncertainty if selected.progressshows progress bars if selected.
Compute the light curve shape given the number m of bins and the input arrival time tlist (Eq. 7.10 in Gregory & Lorendo (1992)).
GregoryLoredo.LightCurveSimpleShape — MethodLightCurveSimpleShape(ω::Float64,Φ::Float64,m::Int,tlist::Vector{Float64};unc=false)::lcshape
Arguments
ωis the angular frequency.Φis the phase.mis the number of bins.tlistis the vector of arrival times.unccomputes light-curve uncertainty if selected.
Compute the light curve shape given the angular frequency ω, the phase Φ, m bins given the input arrival time tlist (Eq. 4.3 in Gregory & Lorendo (1992)).
GregoryLoredo.MarginalizedPeriodogram — MethodMarginalizedPeriodogram(Tlist::Vector{Float64},ωr::Vector{Float64};progress=false,phasesteps=10)
Arguments
Tlistis the vector of arrival times.ωris the vector of the analyzed frequencies.mmaxis the maximum number of bins.progressshows progress bars if selected.
Compute the periodogram following Section 6 in Gregory & Lorendo (1992)).
GregoryLoredo.OddRatioSummary — MethodOddRatioSummary(or::Vector{Real})::orsum
Arguments
odis the vector of computed odd ratios for each considered light-curve bin number.
Compute the probability for a non constant model Eq. 5.2. in Gregory & Lorendo (1992)) and the bin number yileding the highest odd-ratio.
GregoryLoredo.OddRatios — MethodOddRatios(Tlist::Vector{Float64},ωr::Vector{Float64},mmax::Int;progress=false,phasesteps=10)
Arguments
Tlistis the vector of arrival times.ωris the vector of the analyzed frequencies.mmaxis the maximum number of bins.progressshows progress bars if selected.
Compute the odd ratio following Appendix A in Gregory & Lorendo (1992)).
GregoryLoredo.Periodogram — FunctionPeriodogram(Tlist::Vector{Float64},ωr::Vector{Float64},m::Int,phasesteps=10)
Arguments
Tlistis the vector of arrival times.ωris the vector of the analyzed frequencies.mis the number of bins.
Compute the periodogram following Section 6 in Gregory & Lorendo (1992)).
GregoryLoredo.PeriodogramSummary — MethodPeriodogramSummary(per::Vector{BigFloat},ωr::Vector{Float64})::persum
Arguments
peris the vector of powers for each considered frequency.ωris the vector of the analyzed frequencies.
Plot the Odd Ratio as a function of the number of bins.
GregoryLoredo.PlotLightCurve — MethodPlotLightCurve(lpl::lcshape;xlabel="",ylabel="",sigma=1.)
Arguments
lplis a light-curve shape structure.xlabelis the (optional) label for the x-axis.ylabelis the (optional) label for the y-axis.sigmais the number od standard deviation to be plotted.
Plot the light-curve in the given bins of the analysis.
GregoryLoredo.PlotOddRatios — MethodPlotOddRatios(or::Vector{Real};xlabel="",ylabel="";xlabel="",ylabel="")
Arguments
odis the vector of computed odd ratios for each considered light-curve bin number.xlabelis the (optional) label for the x-axis.ylabelis the (optional) label for the y-axis.
Plot the oddratio for each possible bin number.
GregoryLoredo.PlotPeriodogram — MethodPlotPeriodogram(per::Vector{BigFloat},ωr::Vector{Float64};xlabel="",ylabel="",pmax=2π/minimum(ωr),pmin=2π/maximum(ωr))
Arguments
peris the vector of powers for each considered frequency.ωris the vector of the analyzed frequencies.xlabelis the (optional) label for the x-axis.ylabelis the (optional) label for the y-axis.pminis the minimum of the plotted periods (default minimum of the input data).pmaxis the maximum of the plotted periods (default maximum of the input data).
Plot the periodogram as a function of the analysed frequencies.
GregoryLoredo.WeightingFactor — MethodWeightingFactor(njbin::Vector{Int},m::Int,totcnt::Int)::Vector{BigFloat}
Arguments
njbinis the vector with the number of events in each model bin.mis the number of bins for the adopted model.totcntis the total number of events in the analyzed dataset.
Compute the weighting factors for each bin of the model.
GregoryLoredo.jt — Methodjt(m::Int,ω::Float64,Φ::Float64,t::Float64)
Arguments
mis the number of bins.ωis the angular frequency.Φis the phase.tis the time.
Compute the bin number at time tfor a model with m bins with given frequency and phase.
GregoryLoredo.logStirlingApprox — MethodlogStirlingApprox(n::Int)
Arguments
nis the integer we want to use to compute the factorial.