epicsarchiver.retrieval.archiver_retrieval.processor
====================================================

.. py:module:: epicsarchiver.retrieval.archiver_retrieval.processor

.. autoapi-nested-parse::

   Module for the retrieval processors.



Classes
-------

.. autoapisummary::

   epicsarchiver.retrieval.archiver_retrieval.processor.ProcessorName
   epicsarchiver.retrieval.archiver_retrieval.processor.Processor


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

.. py:class:: ProcessorName

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Preprocessors for data from the archiver.

   https://epicsarchiver.readthedocs.io/en/latest/user/userguide.html#processing-of-data


   .. py:attribute:: FIRSTSAMPLE
      :value: 'firstSample'



   .. py:attribute:: LASTSAMPLE
      :value: 'lastSample'



   .. py:attribute:: FIRSTFILL
      :value: 'firstFill'



   .. py:attribute:: LASTFILL
      :value: 'lastFill'



   .. py:attribute:: MEAN
      :value: 'mean'



   .. py:attribute:: MIN
      :value: 'min'



   .. py:attribute:: MAX
      :value: 'max'



   .. py:attribute:: COUNT
      :value: 'count'



   .. py:attribute:: NCOUNT
      :value: 'ncount'



   .. py:attribute:: NTH
      :value: 'nth'



   .. py:attribute:: MEDIAN
      :value: 'median'



   .. py:attribute:: STD
      :value: 'std'



   .. py:attribute:: JITTER
      :value: 'jitter'



   .. py:attribute:: IGNOREFLYERS
      :value: 'ignoreflyers'



   .. py:attribute:: FLYERS
      :value: 'flyers'



   .. py:attribute:: VARIANCE
      :value: 'variance'



   .. py:attribute:: POPVARIANCE
      :value: 'popvariance'



   .. py:attribute:: KURTOSIS
      :value: 'kurtosis'



   .. py:attribute:: SKEWNESS
      :value: 'skewness'



   .. py:attribute:: LINEAR
      :value: 'linear'



   .. py:attribute:: LOESS
      :value: 'loess'



   .. py:attribute:: OPTIMIZED
      :value: 'optimized'



   .. py:attribute:: OPTIMLASTSAMPLE
      :value: 'optimLastSample'



   .. py:attribute:: CAPLOTBINNING
      :value: 'caplotbinning'



   .. py:attribute:: DEADBAND
      :value: 'deadBand'



   .. py:attribute:: ERRORBAR
      :value: 'errorbar'



.. py:class:: Processor

   Representation of a preprocessor.


   .. py:attribute:: processor_name
      :type:  ProcessorName


   .. py:attribute:: bin_size
      :type:  int | None


   .. py:method:: calc_pv_name(pv: str) -> str

      Calculate PV Name to request from the archiver.

      :param pv: base pv name
      :type pv: str

      :returns: the preprocessor string
      :rtype: str