ftag.labels
===========

.. py:module:: ftag.labels


Classes
-------

.. autoapisummary::

   ftag.labels.Label
   ftag.labels.LabelContainer


Functions
---------

.. autoapisummary::

   ftag.labels.remove_suffix


Module Contents
---------------

.. py:function:: remove_suffix(string: str, suffix: str) -> str

.. py:class:: Label

   .. py:attribute:: name
      :type:  str


   .. py:attribute:: label
      :type:  str


   .. py:attribute:: cuts
      :type:  ftag.cuts.Cuts


   .. py:attribute:: colour
      :type:  str


   .. py:attribute:: category
      :type:  str


   .. py:attribute:: _px
      :type:  str | None
      :value: None



   .. py:property:: px
      :type: str



   .. py:property:: eff_str
      :type: str



   .. py:property:: rej_str
      :type: str



   .. py:property:: frac_str
      :type: str



   .. py:method:: __str__() -> str


   .. py:method:: __lt__(other) -> bool


.. py:class:: LabelContainer

   .. py:attribute:: labels
      :type:  dict[str, Label]


   .. py:method:: __iter__() -> collections.abc.Iterator


   .. py:method:: __getitem__(key) -> Label


   .. py:method:: __len__() -> int


   .. py:method:: __getattr__(name) -> Label


   .. py:method:: __contains__(label: str | Label) -> bool


   .. py:method:: __eq__(other) -> bool


   .. py:method:: __repr__() -> str


   .. py:property:: categories
      :type: list[str]



   .. py:method:: by_category(category: str) -> LabelContainer


   .. py:method:: from_cuts(cuts: list | ftag.cuts.Cuts) -> Label


   .. py:method:: from_yaml(yaml_path: pathlib.Path | None = None) -> LabelContainer
      :classmethod:



   .. py:method:: from_list(labels: list[Label]) -> LabelContainer
      :classmethod:



   .. py:method:: backgrounds(signal: Label, only_signals: bool = True) -> LabelContainer