centroid.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * This file is part of gauss2d.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef LSST_GAUSS2D_CENTROID_H
#define LSST_GAUSS2D_CENTROID_H
 
#include <array>
#include <memory>
#include <string>
 
#include "object.h"
 
namespace lsst::gauss2d {
 
class CentroidData : public Object {
public:
    virtual double get_x() const = 0;
    virtual std::array<double, 2> get_xy() const = 0;
    virtual double get_y() const = 0;
 
    virtual void set_x(double x) = 0;
    virtual void set_xy(const std::array<double, 2>& xy) = 0;
    virtual void set_y(double y) = 0;
 
    bool operator==(const CentroidData& other) const {
        return (get_x() == other.get_x()) && (get_y() == other.get_y());
    };
 
    virtual std::string repr(bool name_keywords = false, std::string_view namespace_separator
                                                         = Object::CC_NAMESPACE_SEPARATOR) const override
            = 0;
    virtual std::string str() const override = 0;
    virtual ~CentroidData() = default;
};
 
class CentroidValues : public virtual CentroidData {
public:
    double get_x() const override;
    std::array<double, 2> get_xy() const override;
    double get_y() const override;
 
    void set_x(double x) override;
    void set_xy(const std::array<double, 2>& xy) override;
    void set_y(double y) override;
 
    std::string repr(bool name_keywords, std::string_view namespace_separator) const override;
    std::string str() const override;
 
    bool operator==(const CentroidValues& other) const;
    bool operator!=(const CentroidValues& other) const;
 
    CentroidValues(std::shared_ptr<double> x, std::shared_ptr<double> y);
    CentroidValues(double x = 0, double y = 0);
 
    virtual ~CentroidValues() {};
 
private:
    std::shared_ptr<double> _x;
    std::shared_ptr<double> _y;
};
 
class Centroid : public Object {
public:
    explicit Centroid(std::shared_ptr<CentroidData> data);
    explicit Centroid(double x = 0, double y = 0);
    void convolve(const Centroid& cen);
 
    const CentroidData& get_data() const;
    double get_x() const;
    std::array<double, 2> get_xy() const;
    double get_y() const;
 
    std::shared_ptr<Centroid> make_convolution(const Centroid& cen) const;
    std::unique_ptr<Centroid> make_convolution_uniq(const Centroid& cen) const;
 
    void set_x(double x);
    void set_xy(const std::array<double, 2>& xy);
    void set_y(double y);
 
    std::string repr(bool name_keywords = false,
                     std::string_view namespace_separator = Object::CC_NAMESPACE_SEPARATOR) const override;
    std::string str() const override;
 
    bool operator==(const Centroid& other) const;
    bool operator!=(const Centroid& other) const;
 
private:
    std::shared_ptr<CentroidData> _data;
};
 
}  // namespace lsst::gauss2d
#endif