Module flarefly.custom_pdfs

Module containing custom pdfs

Classes

class DoubleGauss (obs: ztyping.ObsTypeInput,
*,
name: str = 'ZPDF',
label: str | None = None,
norm=None,
extended=None,
**params)
Expand source code 
class DoubleGauss(zfit.pdf.ZPDF):
    """
    PDF composed by the sum of two gaussians sharing the same mean parameter
    Parameters:

        - mu: shared mean parameter

        - sigma1: sigma of first Gaussian function

        - sigma2: sigma of second Gaussian function

        - frac1: fraction of integral associated to first Gaussian function
    """

    # override the name of the parameters
    _PARAMS = ['mu', 'sigma1', 'sigma2', 'frac1']

    def _unnormalized_pdf(self, x):
        """
        PDF 'unnormalized'.
        See https://zfit.github.io/zfit/_modules/zfit/core/basepdf.html#BasePDF.unnormalized_pdf
        for more details
        """
        x = zfit.z.unstack_x(x)
        mean = self.params['mu']
        sigma1 = self.params['sigma1']
        sigma2 = self.params['sigma2']
        frac1 = self.params['frac1']
        gauss1 = tf.exp(- ((x - mean)/sigma1)**2)
        gauss2 = tf.exp(- ((x - mean)/sigma2)**2)
        return frac1 * gauss1 + (1-frac1) * gauss2

PDF composed by the sum of two gaussians sharing the same mean parameter

Parameters

  • mu: shared mean parameter

  • sigma1: sigma of first Gaussian function

  • sigma2: sigma of second Gaussian function

  • frac1: fraction of integral associated to first Gaussian function

Ancestors

  • zfit.models.special.ZPDF
  • zfit.core.basemodel.SimpleModelSubclassMixin
  • zfit.core.basepdf.BasePDF
  • zfit._interfaces.ZfitPDF
  • zfit.core.basemodel.BaseModel
  • zfit.core.baseobject.BaseNumeric
  • zfit.util.cache.GraphCachable
  • zfit.util.cache.ZfitGraphCachable
  • zfit.core.baseobject.BaseParametrized
  • zfit.core.dimension.BaseDimensional
  • zfit._interfaces.ZfitModel
  • zfit._interfaces.ZfitNumericParametrized
  • zfit.core.baseobject.BaseObject
  • zfit._interfaces.ZfitParametrized
  • zfit._interfaces.ZfitDimensional
  • zfit._interfaces.ZfitObject

Class variables

var graph_caching_methods : ClassVar
class ExpoPow (obs: ztyping.ObsTypeInput,
*,
name: str = 'ZPDF',
label: str | None = None,
norm=None,
extended=None,
**params)
Expand source code 
class ExpoPow(zfit.pdf.ZPDF):
    """
    PDF composed by an exponential power-law function
    f(x) = sqrt(x - m) * exp( -lam * (x - m) )

    Parameters:

        - mass: mass parameter

        - lam: slope of exponential
    """

    # override the name of the parameters
    _PARAMS = ['mass', 'lam']

    @tf.function
    def _unnormalized_pdf(self, x):
        """
        PDF 'unnormalized'.
        See https://zfit.github.io/zfit/_modules/zfit/core/basepdf.html#BasePDF.unnormalized_pdf
        for more details
        """
        x = zfit.z.unstack_x(x)
        mass = self.params['mass']
        lam = self.params['lam']
        return tf.sqrt(x - mass) * tf.exp(-lam * (x - mass))

PDF composed by an exponential power-law function f(x) = sqrt(x - m) * exp( -lam * (x - m) )

Parameters

  • mass: mass parameter

  • lam: slope of exponential

Ancestors

  • zfit.models.special.ZPDF
  • zfit.core.basemodel.SimpleModelSubclassMixin
  • zfit.core.basepdf.BasePDF
  • zfit._interfaces.ZfitPDF
  • zfit.core.basemodel.BaseModel
  • zfit.core.baseobject.BaseNumeric
  • zfit.util.cache.GraphCachable
  • zfit.util.cache.ZfitGraphCachable
  • zfit.core.baseobject.BaseParametrized
  • zfit.core.dimension.BaseDimensional
  • zfit._interfaces.ZfitModel
  • zfit._interfaces.ZfitNumericParametrized
  • zfit.core.baseobject.BaseObject
  • zfit._interfaces.ZfitParametrized
  • zfit._interfaces.ZfitDimensional
  • zfit._interfaces.ZfitObject

Class variables

var graph_caching_methods : ClassVar
class ExpoPowExt (obs: ztyping.ObsTypeInput,
*,
name: str = 'ZPDF',
label: str | None = None,
norm=None,
extended=None,
**params)
Expand source code 
class ExpoPowExt(zfit.pdf.ZPDF):
    """
    PDF composed by an exponential power-law function
    f(x) = (x - m)^power * exp( c1 * (x - m) + c2 * (x - m)^2  + c3 * (x - m)^3 )

    Parameters:

        - mass: mass parameter

        - power: power

        - c1: coefficient of the first-order term in the exponential

        - c2: coefficient of the second-order term in the exponential

        - c3: coefficient of the third-order term in the exponential
    """

    # override the name of the parameters
    _PARAMS = ['mass', 'power', 'c1', 'c2', 'c3']

    @tf.function
    def _unnormalized_pdf(self, x):
        """
        PDF 'unnormalized'.
        See https://zfit.github.io/zfit/_modules/zfit/core/basepdf.html#BasePDF.unnormalized_pdf
        for more details
        """
        x = zfit.z.unstack_x(x)
        mass = self.params['mass']
        power = self.params['power']
        c1 = self.params['c1']
        c2 = self.params['c2']
        c3 = self.params['c3']
        return tf.pow(x - mass, power) * tf.exp(c1 * (x - mass) + c2 * (x - mass)**2 + c3 * (x - mass)**3)

PDF composed by an exponential power-law function f(x) = (x - m)^power * exp( c1 * (x - m) + c2 * (x - m)^2 + c3 * (x - m)^3 )

Parameters

  • mass: mass parameter

  • power: power

  • c1: coefficient of the first-order term in the exponential

  • c2: coefficient of the second-order term in the exponential

  • c3: coefficient of the third-order term in the exponential

Ancestors

  • zfit.models.special.ZPDF
  • zfit.core.basemodel.SimpleModelSubclassMixin
  • zfit.core.basepdf.BasePDF
  • zfit._interfaces.ZfitPDF
  • zfit.core.basemodel.BaseModel
  • zfit.core.baseobject.BaseNumeric
  • zfit.util.cache.GraphCachable
  • zfit.util.cache.ZfitGraphCachable
  • zfit.core.baseobject.BaseParametrized
  • zfit.core.dimension.BaseDimensional
  • zfit._interfaces.ZfitModel
  • zfit._interfaces.ZfitNumericParametrized
  • zfit.core.baseobject.BaseObject
  • zfit._interfaces.ZfitParametrized
  • zfit._interfaces.ZfitDimensional
  • zfit._interfaces.ZfitObject

Class variables

var graph_caching_methods : ClassVar
class Pow (obs: ztyping.ObsTypeInput,
*,
name: str = 'ZPDF',
label: str | None = None,
norm=None,
extended=None,
**params)
Expand source code 
class Pow(zfit.pdf.ZPDF):
    """
    PDF composed by a power-law function
    f(x) = (x - m)^power

    Parameters:

        - mass: mass parameter

        - power: power
    """

    # override the name of the parameters
    _PARAMS = ['mass', 'power']

    def _unnormalized_pdf(self, x):
        """
        PDF 'unnormalized'.
        See https://zfit.github.io/zfit/_modules/zfit/core/basepdf.html#BasePDF.unnormalized_pdf
        for more details
        """
        x = zfit.z.unstack_x(x)
        mass = self.params['mass']
        power = self.params['power']
        return tf.pow(x - mass, power)

PDF composed by a power-law function f(x) = (x - m)^power

Parameters

  • mass: mass parameter

  • power: power

Ancestors

  • zfit.models.special.ZPDF
  • zfit.core.basemodel.SimpleModelSubclassMixin
  • zfit.core.basepdf.BasePDF
  • zfit._interfaces.ZfitPDF
  • zfit.core.basemodel.BaseModel
  • zfit.core.baseobject.BaseNumeric
  • zfit.util.cache.GraphCachable
  • zfit.util.cache.ZfitGraphCachable
  • zfit.core.baseobject.BaseParametrized
  • zfit.core.dimension.BaseDimensional
  • zfit._interfaces.ZfitModel
  • zfit._interfaces.ZfitNumericParametrized
  • zfit.core.baseobject.BaseObject
  • zfit._interfaces.ZfitParametrized
  • zfit._interfaces.ZfitDimensional
  • zfit._interfaces.ZfitObject

Class variables

var graph_caching_methods : ClassVar