Python API Reference¶
Module contents¶
-
class
nuflux._nuflux.
FluxFunction
¶ Bases:
Boost.Python.instance
-
property
energy_range
¶
-
getFlux
((FluxFunction)arg1, (object)particle_type, (object)energy, (object)cos_zen) → object :¶ Get the flux of neutrinos predicted by this model.
- Parameters
particle_type – type of neutrino
energy – energy of neutrino in GeV
cos_zen – cosine of the zenith angle in radians
- Returns
a differential flux in units of 1/GeV cm^2 sr s
- C++ signature :
boost::python::api::object getFlux(nuflux::FluxFunction,boost::python::api::object,boost::python::api::object,boost::python::api::object)
-
property
name
¶
-
property
-
class
nuflux._nuflux.
KneeReweightable
¶ Bases:
Boost.Python.instance
-
property
knee_reweighting_model
¶
-
property
-
class
nuflux._nuflux.
LegacyConventionalFlux
¶ Bases:
nuflux._nuflux.FluxFunction
,nuflux._nuflux.PionKaonAdjustable
,nuflux._nuflux.KneeReweightable
-
class
nuflux._nuflux.
LegacyPromptFlux
¶ Bases:
nuflux._nuflux.FluxFunction
,nuflux._nuflux.KneeReweightable
-
class
nuflux._nuflux.
ParticleType
¶ Bases:
Boost.Python.enum
-
NuE
= nuflux._nuflux.ParticleType.NuE¶
-
NuEBar
= nuflux._nuflux.ParticleType.NuEBar¶
-
NuMu
= nuflux._nuflux.ParticleType.NuMu¶
-
NuMuBar
= nuflux._nuflux.ParticleType.NuMuBar¶
-
NuTau
= nuflux._nuflux.ParticleType.NuTau¶
-
NuTauBar
= nuflux._nuflux.ParticleType.NuTauBar¶
-
names
= {'NuE': nuflux._nuflux.ParticleType.NuE, 'NuEBar': nuflux._nuflux.ParticleType.NuEBar, 'NuMu': nuflux._nuflux.ParticleType.NuMu, 'NuMuBar': nuflux._nuflux.ParticleType.NuMuBar, 'NuTau': nuflux._nuflux.ParticleType.NuTau, 'NuTauBar': nuflux._nuflux.ParticleType.NuTauBar}¶
-
values
= {-16: nuflux._nuflux.ParticleType.NuTauBar, -14: nuflux._nuflux.ParticleType.NuMuBar, -12: nuflux._nuflux.ParticleType.NuEBar, 12: nuflux._nuflux.ParticleType.NuE, 14: nuflux._nuflux.ParticleType.NuMu, 16: nuflux._nuflux.ParticleType.NuTau}¶
-
-
class
nuflux._nuflux.
PionKaonAdjustable
¶ Bases:
Boost.Python.instance
-
property
relative_kaon_contribution
¶
-
property
relative_pion_contribution
¶
-
property
-
class
nuflux._nuflux.
SplineFlux
¶ Bases:
nuflux._nuflux.FluxFunction
-
class
nuflux._nuflux.
SplineFlux2
¶ Bases:
nuflux._nuflux.FluxFunction
-
nuflux._nuflux.
availableFluxes
() → list :¶ Get a list of valid flux model names
- C++ signature :
boost::python::list availableFluxes()
-
nuflux._nuflux.
kneesForFlux
((str)arg1) → list :¶ Get a list of valid knee-reweighting scheme names for the given model
- C++ signature :
boost::python::list kneesForFlux(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)
-
nuflux._nuflux.
makeFlux
((str)arg1) → FluxFunction :¶ Instantiate and return a flux model
- C++ signature :
boost::shared_ptr<nuflux::FluxFunction> makeFlux(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)
-
nuflux._nuflux.
printModels
() → None :¶ Print a list of models to stdout
- C++ signature :
void printModels()