GaussianNoiseModel.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 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_SENSORS_GAUSSIANNOISEMODEL_HH_
#define IGNITION_SENSORS_GAUSSIANNOISEMODEL_HH_

#include <sdf/sdf.hh>

#include "ignition/sensors/config.hh"
#include "ignition/sensors/Export.hh"
#include "ignition/sensors/Noise.hh"

namespace ignition
{
  namespace sensors
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_SENSORS_VERSION_NAMESPACE {
    //
    // Forward declarations
    class GaussianNoiseModelPrivate;

    class IGNITION_SENSORS_VISIBLE GaussianNoiseModel : public Noise
    {
      public: GaussianNoiseModel();

      public: virtual ~GaussianNoiseModel();

      // Documentation inherited.
      public: virtual void Load(const sdf::Noise &_sdf) override;

      // Documentation inherited.
      public: double ApplyImpl(double _in, double _dt) override;

      public: double Mean() const;

      public: double StdDev() const;

      public: double Bias() const;

      public: virtual void Print(std::ostream &_out) const override;

      private: GaussianNoiseModelPrivate *dataPtr = nullptr;
    };
  }
  }
}

#endif