TransmissionCurve.h

Go to the documentation of this file.

/*
 * LSST Data Management System
 * Copyright 2017 LSST/AURA.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * 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 LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

#ifndef LSST_AFW_IMAGE_TRANSMISSIONCURVE_H_INCLUDED
#define LSST_AFW_IMAGE_TRANSMISSIONCURVE_H_INCLUDED

#include "ndarray_fwd.h"

#include "lsst/afw/geom/Transform.h"
#include "lsst/geom/Box.h"
#include "lsst/afw/table/io/Persistable.h"
#include "lsst/afw/typehandling/Storable.h"

namespace lsst {
namespace afw {
namespace image {

class TransmissionCurve : public table::io::PersistableFacade<TransmissionCurve>,
                          public typehandling::Storable,
                          public std::enable_shared_from_this<TransmissionCurve> {
public:
    static std::shared_ptr<TransmissionCurve const> makeIdentity();

    static std::shared_ptr<TransmissionCurve const> makeSpatiallyConstant(
            ndarray::Array<double const, 1> const &throughput,
            ndarray::Array<double const, 1> const &wavelengths, double throughputAtMin = 0.0,
            double throughputAtMax = 0.0);

    static std::shared_ptr<TransmissionCurve const> makeRadial(
            ndarray::Array<double const, 2> const &throughput,
            ndarray::Array<double const, 1> const &wavelengths, ndarray::Array<double const, 1> const &radii,
            double throughputAtMin = 0.0, double throughputAtMax = 0.0);

    std::shared_ptr<TransmissionCurve const> multipliedBy(TransmissionCurve const &other) const;

    std::shared_ptr<TransmissionCurve const> transformedBy(
            std::shared_ptr<geom::TransformPoint2ToPoint2> transform) const;

    // TransmissionCurve is not copyable.
    TransmissionCurve(TransmissionCurve const &) = delete;

    // TransmissionCurve is not movable.
    TransmissionCurve(TransmissionCurve &&) = delete;

    // TransmissionCurve is not copy-assignable.
    TransmissionCurve &operator=(TransmissionCurve const &) = delete;

    // TransmissionCurve is not move-assignable.
    TransmissionCurve &operator=(TransmissionCurve &&) = delete;

    ~TransmissionCurve() override = default;

    virtual std::pair<double, double> getWavelengthBounds() const = 0;

    virtual std::pair<double, double> getThroughputAtBounds() const = 0;

    virtual void sampleAt(lsst::geom::Point2D const &position,
                          ndarray::Array<double const, 1, 1> const &wavelengths,
                          ndarray::Array<double, 1, 1> const &out) const = 0;

    ndarray::Array<double, 1, 1> sampleAt(lsst::geom::Point2D const &position,
                                          ndarray::Array<double const, 1, 1> const &wavelengths) const;

protected:
    virtual std::shared_ptr<TransmissionCurve const> _transformedByImpl(
            std::shared_ptr<geom::TransformPoint2ToPoint2> transform) const;

    virtual std::shared_ptr<TransmissionCurve const> _multipliedByImpl(
            std::shared_ptr<TransmissionCurve const> other) const;

    TransmissionCurve() = default;

    std::string getPythonModule() const override;
};

}  // namespace image
}  // namespace afw
}  // namespace lsst

#endif  // !LSST_AFW_IMAGE_TRANSMISSIONCURVE_H_INCLUDED