Camera.h

Go to the documentation of this file.

/*
 * 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_AFW_CAMERAGEOM_CAMERA_H
#define LSST_AFW_CAMERAGEOM_CAMERA_H

#include <string>
#include <memory>

#include "lsst/afw/cameraGeom/DetectorCollection.h"
#include "lsst/afw/cameraGeom/TransformMap.h"
#include "lsst/afw/cameraGeom/CameraSys.h"

namespace lsst {
namespace afw {
namespace cameraGeom {


class Camera : public DetectorCollection, public table::io::PersistableFacade<Camera> {
public:

    class Builder;

    using DetectorList = DetectorCollection::List;

    // Camera is immutable, so it cannot be moveable.  It is also always held
    // by shared_ptr, so there is no good reason to copy it.
    Camera(Camera const &) = delete;
    Camera(Camera &&) = delete;

    // Camera is immutable, so it cannot be assignable.
    Camera & operator=(Camera const &) = delete;
    Camera & operator=(Camera &&) = delete;

    virtual ~Camera() noexcept;

    Camera::Builder rebuild() const;

    std::string getName() const { return _name; }

    std::string getPupilFactoryName() const { return _pupilFactoryName; }

    DetectorList findDetectors(lsst::geom::Point2D const &point, CameraSys const &cameraSys) const;

    std::vector<DetectorList> findDetectorsList(std::vector<lsst::geom::Point2D> const &pointList,
                                                CameraSys const &cameraSys) const;

    std::shared_ptr<afw::geom::TransformPoint2ToPoint2> getTransform(CameraSys const &fromSys,
                                                                     CameraSys const &toSys) const;

    std::shared_ptr<TransformMap const> getTransformMap() const noexcept { return _transformMap; }

    lsst::geom::Point2D transform(lsst::geom::Point2D const &point, CameraSys const &fromSys,
                                  CameraSys const &toSys) const;

    std::vector<lsst::geom::Point2D> transform(std::vector<lsst::geom::Point2D> const &points,
                                               CameraSys const &fromSys,
                                               CameraSys const &toSys) const;

    bool isPersistable() const noexcept override { return true; }

protected:

    void write(OutputArchiveHandle& handle) const override;

private:

    // static methods below provide access to private methods of
    // Detector::InCameraBuilder for use by Camera::Builder, because
    // Detector::InCameraBuilder can only friend Camera.

    /*
     * Create a new Detector::InCameraBuilder for a completely new Detector.
     */
    static std::shared_ptr<Detector::InCameraBuilder> makeDetectorBuilder(std::string const & name, int id);

    /*
     * Create a new Detector::InCameraBuilder with the state of the given
     * Detector.
     */
    static std::shared_ptr<Detector::InCameraBuilder> makeDetectorBuilder(Detector const & detector);

    /*
     * Extract the sequence of TransformMap::Connections from a
     * Detector::InCameraBuilder.
     */
    static std::vector<TransformMap::Connection> const & getDetectorBuilderConnections(
        Detector::InCameraBuilder const & detector
    );

    // Deserialization factory.
    class Factory;

    // Constructor used by Camera::Builder.
    // Some arguments passed by value to make moves possible.
    Camera(std::string const & name, DetectorList detectors,
           std::shared_ptr<TransformMap const> transformMap, std::string const & pupilFactoryName);

    // Constructor used by persistence.
    Camera(table::io::InputArchive const & archive, table::io::CatalogVector const & catalogs);

    std::string getPersistenceName() const override;

    // getPythonModule implementation inherited from DetectorCollection.

    std::string _name;
    std::string _pupilFactoryName;
    std::shared_ptr<TransformMap const> _transformMap;
};


class Camera::Builder : public DetectorCollectionBase<Detector::InCameraBuilder> {
    using BaseCollection = DetectorCollectionBase<Detector::InCameraBuilder>;
public:

    virtual ~Builder() noexcept;

    explicit Builder(std::string const &name);

    explicit Builder(Camera const & camera);

    std::shared_ptr<Camera const> finish() const;

    std::string getName() const { return _name; }

    void setName(std::string const & name) { _name = name; }

    std::string getPupilFactoryName() const { return _pupilFactoryName; }

    void setPupilFactoryName(std::string const & pupilFactoryName) { _pupilFactoryName = pupilFactoryName; }

    void setTransformFromFocalPlaneTo(CameraSys const & toSys,
                                      std::shared_ptr<afw::geom::TransformPoint2ToPoint2 const> transform);

    bool discardTransformFromFocalPlaneTo(CameraSys const & toSys);

    std::shared_ptr<Detector::InCameraBuilder> add(std::string const & name, int id);


    void remove(std::string const & name) { return BaseCollection::remove(name); }
    void remove(int id) { return BaseCollection::remove(id); }

private:
    std::string _name;
    std::string _pupilFactoryName;
    std::vector<TransformMap::Connection> _connections;
};


} // namespace cameraGeom
} // namespace afw
} // namespace lsst

#endif // LSST_AFW_CAMERAGEOM_CAMERA_H