Gaussian3D.h

Go to the documentation of this file.

/**
 *  \file IMP/algebra/Gaussian3D.h
 *  \brief Gaussian shape
 *
 *  Copyright 2007-2022 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPALGEBRA_GAUSSIAN3D_H
#define IMPALGEBRA_GAUSSIAN3D_H

#include <IMP/algebra/algebra_config.h>
#include "Transformation3D.h"
#include "ReferenceFrame3D.h"
#include <IMP/algebra/VectorD.h>
#include <IMP/algebra/standard_grids.h>
#include <boost/serialization/access.hpp>
#include <Eigen/Dense>

IMPALGEBRA_BEGIN_NAMESPACE

//! A Gaussian distribution in 3D.
/** The variances are along the axis of the reference frame.
*/
class Gaussian3D : public GeometricPrimitiveD<3> {
  ReferenceFrame3D tr_;
  Vector3D variances_;

  friend class boost::serialization::access;

  template<class Archive> void serialize(Archive &ar, const unsigned int) {
    ar & tr_ & variances_;
  }

public:
  Gaussian3D() {
    tr_ = ReferenceFrame3D();
    variances_ = Vector3D(0, 0, 0);
  }
  Gaussian3D(const ReferenceFrame3D &tr, const Vector3D &variances)
      : tr_(tr), variances_(variances) {}

  const ReferenceFrame3D &get_reference_frame() const { return tr_; }
  const Vector3D &get_variances() const { return variances_; }
  const Vector3D &get_center() const {
    return get_reference_frame().get_transformation_to().get_translation();
  }
  IMP_SHOWABLE_INLINE(Gaussian3D, out << tr_ << ": " << variances_);
};
IMP_VALUES(Gaussian3D, Gaussian3Ds);

/** Return the covariance matrix from a given set of standard deviations in
    the passed reference frame. */
IMPALGEBRAEXPORT Eigen::Matrix3d get_covariance(const Gaussian3D &g);

//! Return a Gaussian centered at the origin from a covariance matrix.
IMPALGEBRAEXPORT Gaussian3D
get_gaussian_from_covariance(const Eigen::Matrix3d &covariance,
                             const Vector3D &center);

//! Rasterize the Gaussians to a grid.
IMPALGEBRAEXPORT DenseGrid3D<double>
get_rasterized(const Gaussian3Ds &gmm, const Floats &weights, double cell_width,
               const BoundingBox3D &bb);

//! Rasterize the Gaussians to a grid.
/** The result is an approximation, but is obtained significantly faster.
 * Good for quickly checking a GMM.
 */
IMPALGEBRAEXPORT DenseGrid3D<double>
get_rasterized_fast(const Gaussian3Ds &gmm, const Floats &weights,
                    double cell_width, const BoundingBox3D &bb, double factor=2.5);

IMPALGEBRA_END_NAMESPACE

#endif /* IMPALGEBRA_GAUSSIAN3D_H */