BaseGaussianNoisePass.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef IGNITION_RENDERING_BASE_BASEGAUSSIANNOISEPASS_HH_
#define IGNITION_RENDERING_BASE_BASEGAUSSIANNOISEPASS_HH_

#include <string>
#include <ignition/math/Rand.hh>

#include "ignition/rendering/GaussianNoisePass.hh"

namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    /* \class BaseGaussianNoisePass BaseGaussianNoisePass.hh \
     * ignition/rendering/base/BaseGaussianNoisePass.hh
     */
    template <class T>
    class BaseGaussianNoisePass :
      public virtual GaussianNoisePass,
      public virtual T
    {
      protected: BaseGaussianNoisePass();

      public: virtual ~BaseGaussianNoisePass();

      // Documentation inherited.
      public: double Mean() const;

      // Documentation inherited.
      public: double StdDev() const;

      // Documentation inherited.
      public: double Bias() const;

      // Documentation inherited.
      public: void SetMean(double _mean);

      // Documentation inherited.
      public: void SetStdDev(double _stdDev);

      // Documentation inherited.
      public: void SetBiasMean(double _biasMean);

      // Documentation inherited.
      public: void SetBiasStdDev(double _biasStdDev);

      // Sample the bias from bias mean and bias standard deviation
      protected: void SampleBias();

      protected: double mean = 0.0;

      protected: double stdDev = 0.0;

      protected: double bias = 0.0;

      protected: double biasMean = 0;

      protected: double biasStdDev = 0;
    };

    // BaseGaussianNoisePass
    template <class T>
    BaseGaussianNoisePass<T>::BaseGaussianNoisePass()
    {
    }

    template <class T>
    BaseGaussianNoisePass<T>::~BaseGaussianNoisePass()
    {
    }

    template <class T>
    double BaseGaussianNoisePass<T>::Mean() const
    {
      return this->mean;
    }

    template <class T>
    double BaseGaussianNoisePass<T>::StdDev() const
    {
      return this->stdDev;
    }

    template <class T>
    double BaseGaussianNoisePass<T>::Bias() const
    {
      return this->bias;
    }

    template <class T>
    void BaseGaussianNoisePass<T>::SetMean(double _mean)
    {
      this->mean = _mean;
    }

    template <class T>
    void BaseGaussianNoisePass<T>::SetStdDev(double _stdDev)
    {
      this->stdDev = _stdDev;
    }

    template <class T>
    void BaseGaussianNoisePass<T>::SetBiasMean(double _biasMean)
    {
      this->biasMean = _biasMean;
      this->SampleBias();
    }

    template <class T>
    void BaseGaussianNoisePass<T>::SetBiasStdDev(double _biasStdDev)
    {
      this->biasStdDev = _biasStdDev;
      this->SampleBias();
    }

    template <class T>
    void BaseGaussianNoisePass<T>::SampleBias()
    {
      this->bias =
          ignition::math::Rand::DblNormal(this->biasMean, this->biasStdDev);
      // With equal probability, we pick a negative bias (by convention,
      // rateBiasMean should be positive, though it would work fine if
      // negative).
      if (ignition::math::Rand::DblUniform() < 0.5)
        this->bias = -this->bias;
    }
    }
  }
}
#endif