Python API Reference
Module contents
- class nuflux.FluxFunction
Bases:
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
- class nuflux.LegacyConventionalFlux
Bases:
FluxFunction,PionKaonAdjustable,KneeReweightable- 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 knee_reweighting_model
- property name
- property relative_kaon_contribution
- property relative_pion_contribution
- class nuflux.LegacyPromptFlux
Bases:
FluxFunction,KneeReweightable- 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 knee_reweighting_model
- property name
- class nuflux.ParticleType
Bases:
enum- NuE = _nuflux.ParticleType.NuE
- NuEBar = _nuflux.ParticleType.NuEBar
- NuMu = _nuflux.ParticleType.NuMu
- NuMuBar = _nuflux.ParticleType.NuMuBar
- NuTau = _nuflux.ParticleType.NuTau
- NuTauBar = _nuflux.ParticleType.NuTauBar
- as_integer_ratio()
Return integer ratio.
Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.
>>> (10).as_integer_ratio() (10, 1) >>> (-10).as_integer_ratio() (-10, 1) >>> (0).as_integer_ratio() (0, 1)
- bit_count()
Number of ones in the binary representation of the absolute value of self.
Also known as the population count.
>>> bin(13) '0b1101' >>> (13).bit_count() 3
- bit_length()
Number of bits necessary to represent self in binary.
>>> bin(37) '0b100101' >>> (37).bit_length() 6
- conjugate()
Returns self, the complex conjugate of any int.
- denominator
the denominator of a rational number in lowest terms
- from_bytes(byteorder, *, signed=False)
Return the integer represented by the given array of bytes.
- bytes
Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
- byteorder
The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
- signed
Indicates whether two’s complement is used to represent the integer.
- imag
the imaginary part of a complex number
- name
- names = {'NuE': _nuflux.ParticleType.NuE, 'NuEBar': _nuflux.ParticleType.NuEBar, 'NuMu': _nuflux.ParticleType.NuMu, 'NuMuBar': _nuflux.ParticleType.NuMuBar, 'NuTau': _nuflux.ParticleType.NuTau, 'NuTauBar': _nuflux.ParticleType.NuTauBar}
- numerator
the numerator of a rational number in lowest terms
- real
the real part of a complex number
- to_bytes(length, byteorder, *, signed=False)
Return an array of bytes representing an integer.
- length
Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.
- byteorder
The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
- signed
Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.
- values = {-16: _nuflux.ParticleType.NuTauBar, -14: _nuflux.ParticleType.NuMuBar, -12: _nuflux.ParticleType.NuEBar, 12: _nuflux.ParticleType.NuE, 14: _nuflux.ParticleType.NuMu, 16: _nuflux.ParticleType.NuTau}
- class nuflux.PionKaonAdjustable
Bases:
instance- property relative_kaon_contribution
- property relative_pion_contribution
- class nuflux.SplineFlux
Bases:
FluxFunction- 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
- class nuflux.SplineFlux2
Bases:
FluxFunction- 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
- nuflux.availableFluxes() list :
Get a list of valid flux model names
- C++ signature :
boost::python::list availableFluxes()
- nuflux.getVersion() str :
Get the current nuflux version
- C++ signature :
std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > getVersion()
- 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.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.printModels() None :
Print a list of models to stdout
- C++ signature :
void printModels()