mean.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009, Willow Garage, Inc.
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Willow Garage, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef FILTERS_MEAN_H
#define FILTERS_MEAN_H

#include <stdint.h>
#include <cstring>
#include <stdio.h>

#include <boost/scoped_ptr.hpp>

#include "filters/filter_base.h"
#include "ros/assert.h"

#include "filters/realtime_circular_buffer.h"

namespace filters
{

template <typename T>
class MeanFilter: public FilterBase <T>
{
public:
  MeanFilter();

  ~MeanFilter();

  virtual bool configure();

  virtual bool update( const T & data_in, T& data_out);
  
protected:
  boost::scoped_ptr<RealtimeCircularBuffer<T > > data_storage_; 
  uint32_t last_updated_row_;                     
  T temp_; 
  uint32_t number_of_observations_;             
  
};


template <typename T>
MeanFilter<T>::MeanFilter():
  number_of_observations_(0)
{
}

template <typename T>
bool MeanFilter<T>::configure()
{
  
  if (!FilterBase<T>::getParam(std::string("number_of_observations"), number_of_observations_))
  {
    ROS_ERROR("MeanFilter did not find param number_of_observations");
    return false;
  }
  
  data_storage_.reset(new RealtimeCircularBuffer<T >(number_of_observations_, temp_));

  return true;
}

template <typename T>
MeanFilter<T>::~MeanFilter()
{
}


template <typename T>
bool MeanFilter<T>::update(const T & data_in, T& data_out)
{
  //update active row
  if (last_updated_row_ >= number_of_observations_ - 1)
    last_updated_row_ = 0;
  else
    last_updated_row_++;

  data_storage_->push_back(data_in);


  unsigned int length = data_storage_->size();
  
  data_out = 0;
  for (uint32_t row = 0; row < length; row ++)
  {
    data_out += data_storage_->at(row);
  }
  data_out /= length;
  

  return true;
};

template <typename T>
class MultiChannelMeanFilter: public MultiChannelFilterBase <T>
{
public:
  MultiChannelMeanFilter();

  ~MultiChannelMeanFilter();

  virtual bool configure();

  virtual bool update( const std::vector<T> & data_in, std::vector<T>& data_out);
  
protected:
  boost::scoped_ptr<RealtimeCircularBuffer<std::vector<T> > > data_storage_; 
  uint32_t last_updated_row_;                     

  std::vector<T> temp;  //used for preallocation and copying from non vector source

  uint32_t number_of_observations_;             
  using MultiChannelFilterBase<T>::number_of_channels_;           

  
  
};


template <typename T>
MultiChannelMeanFilter<T>::MultiChannelMeanFilter():
  number_of_observations_(0)
{
}

template <typename T>
bool MultiChannelMeanFilter<T>::configure()
{
  
  if (!FilterBase<T>::getParam("number_of_observations", number_of_observations_))
  {
    ROS_ERROR("MultiChannelMeanFilter did not find param number_of_observations");
    return false;
  }
  
  temp.resize(number_of_channels_);
  data_storage_.reset(new RealtimeCircularBuffer<std::vector<T> >(number_of_observations_, temp));

  return true;
}

template <typename T>
MultiChannelMeanFilter<T>::~MultiChannelMeanFilter()
{
}


template <typename T>
bool MultiChannelMeanFilter<T>::update(const std::vector<T> & data_in, std::vector<T>& data_out)
{
  //  ROS_ASSERT(data_in.size() == width_);
  //ROS_ASSERT(data_out.size() == width_);
  if (data_in.size() != number_of_channels_ || data_out.size() != number_of_channels_)
  {
    ROS_ERROR("Configured with wrong size config:%d in:%d out:%d", number_of_channels_, (int)data_in.size(), (int)data_out.size());
    return false;
  }

  //update active row
  if (last_updated_row_ >= number_of_observations_ - 1)
    last_updated_row_ = 0;
  else
    last_updated_row_++;

  data_storage_->push_back(data_in);


  unsigned int length = data_storage_->size();
  
  //Return each value
  for (uint32_t i = 0; i < number_of_channels_; i++)
  {
    data_out[i] = 0;
    for (uint32_t row = 0; row < length; row ++)
    {
      data_out[i] += data_storage_->at(row)[i];
    }
    data_out[i] /= length;
  }

  return true;
};

}
#endif// FILTERS_MEAN_H