ViBe.h

Go to the documentation of this file.

/* Copyright - Benjamin Laugraud <blaugraud@ulg.ac.be> - 2016
 * Copyright - Marc Van Droogenbroeck <m.vandroogenbroeck@ulg.ac.be> - 2016
 *
 * ViBe is covered by a patent (see http://www.telecom.ulg.ac.be/research/vibe).
 *
 * Permission to use ViBe without payment of fee is granted for nonprofit
 * educational and research purposes only.
 *
 * This work may not be copied or reproduced in whole or in part for any
 * purpose.
 *
 * Copying, reproduction, or republishing for any purpose shall require a
 * license. Please contact the authors in such cases. All the code is provided
 * without any guarantee.
 */

/**
    @file ViBe.h
    @brief Interface for the libvibe++ library

    @author Benjamin Laungraud and Marc Van Droogenbroeck 

    @date June 2016

    @details

  Full documentation is available online at:
     http://www.telecom.ulg.ac.be/research/vibe/doc2

  All technical details are available in the following paper:
<em>O. Barnich and M. Van Droogenbroeck. ViBe: A universal background subtraction algorithm for video sequences. IEEE Transactions on Image Processing, 20(6):1709-1724, June 2011.</em>

\verbatim
BiBTeX information

  @article{Barnich2011ViBe,
  title = {{ViBe}: A universal background subtraction algorithm for video sequences},
  author = {O. Barnich and M. {Van Droogenbroeck}},
  journal = {IEEE Transactions on Image Processing},
  volume = {20},
  number = {6},
  pages = {1709-1724},
  month = {June},
  year = {2011},
  keywords = {ViBe, Background, Background subtraction, Segmentation, Motion, Motion detection},
  pdf = {http://orbi.ulg.ac.be/bitstream/2268/145853/1/Barnich2011ViBe.pdf},
  doi = {10.1109/TIP.2010.2101613},
  url = {http://hdl.handle.net/2268/145853}
  }
\endverbatim

See
\cite Barnich2011ViBe
*/


#ifndef _LIB_VIBE_XX_VIBE_H_
#define _LIB_VIBE_XX_VIBE_H_

#include <cstring>

#include "common/ViBeTemplateBase.h"
#include "metaprograms/CopyPixel.h"
#include "metaprograms/SwapPixels.h"

namespace ViBe {
  template <int32_t Channels, class Distance>
  class ViBeSequential : public ViBeTemplateBase<ViBeSequential<Channels, Distance> > {
    protected:

      typedef ViBeTemplateBase<ViBeSequential<Channels, Distance> >       Base;

    public:

      ViBeSequential(
        int32_t height,
        int32_t width,
        const uint8_t* buffer
      );

      virtual ~ViBeSequential() {}

      void _CRTP_segmentation(
        const uint8_t* buffer,
        uint8_t* segmentationMap
      );

      void _CRTP_update(
        const uint8_t* buffer,
        uint8_t* updatingMask
      );
  };

#include "ViBe.t"
} /* _NS_ViBe_ */

#endif /* _LIB_VIBE_XX_VIBE_H_ */