:py:mod:`fitlistreader.fitintegralcoll`
=======================================

.. py:module:: fitlistreader.fitintegralcoll


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

Classes
~~~~~~~

.. autoapisummary::

   fitlistreader.fitintegralcoll.FitIntegralCollection




.. py:class:: FitIntegralCollection


   Bases: :py:obj:`collections.abc.MutableSequence`

   Acts as a container class holding all integrals of a fit. Also constructs the integral objects and manages them.

   an integral

   .. py:method:: __setitem__(index, value)


   .. py:method:: __getitem__(index)


   .. py:method:: __delitem__(index)


   .. py:method:: __len__()


   .. py:method:: insert(index, value)

      S.insert(index, value) -- insert value before index


   .. py:method:: append(value)

      S.append(value) -- append value to the end of the sequence


   .. py:method:: reverse()

      S.reverse() -- reverse *IN PLACE*


   .. py:method:: extend(iterable)

      S.extend(iterable) -- extend sequence by appending elements from the iterable


   .. py:method:: __iadd__(other)


   .. py:method:: check_valid_element(elem)

      checks if elem is of a valid form to add to the integralcollection.

      Elements of the FitIntegralCollection are dicts which contain one or
      three valid FitIntegrals.
      In the case of only a single entry, the key must be named "tot".
      For three entries, the two additional keys are "bg" and "sub".
      :param elem: To pass the check, elem must be an object as described above.
      :type elem: Any


   .. py:method:: create_new_integral(fit) -> None

      Creates and adds a new FitIntegral object to this collection.

      :param fit: The subtree must contain the <integral> tag as a first-level element.
                  Can also contain other first-level elements.
      :type fit: cElementTree: xml-subtree


   .. py:method:: to_list()

      Returns a deepcopied List object representing the FitIntegralCollection.