Detector.h

Go to the documentation of this file.

/*
 * LSST Data Management System
 * Copyright 2014 LSST Corporation.
 *
 * 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/>.
 */

#if !defined(LSST_AFW_CAMERAGEOM_DETECTOR_H)
#define LSST_AFW_CAMERAGEOM_DETECTOR_H

#include <string>
#include <vector>
#include <unordered_map>
#include "lsst/base.h"
#include "lsst/afw/geom/Transform.h"
#include "lsst/afw/table/AmpInfo.h"
#include "lsst/afw/cameraGeom/CameraSys.h"
#include "lsst/afw/cameraGeom/Orientation.h"
#include "lsst/afw/cameraGeom/TransformMap.h"
#include "lsst/afw/typehandling/Storable.h"

namespace lsst {
namespace afw {
namespace cameraGeom {

enum DetectorType {
    SCIENCE,
    FOCUS,
    GUIDER,
    WAVEFRONT,
};

class Detector final : public table::io::PersistableFacade<Detector>, public typehandling::Storable {
public:
    typedef ndarray::Array<float const, 2> CrosstalkMatrix;

    Detector(std::string const &name, int id, DetectorType type, std::string const &serial,
             lsst::geom::Box2I const &bbox, lsst::afw::table::AmpInfoCatalog const &ampInfoCatalog,
             Orientation const &orientation, lsst::geom::Extent2D const &pixelSize,
             TransformMap::Transforms const &transforms,
             CrosstalkMatrix const &crosstalk = CrosstalkMatrix(),
             std::string const &physicalType="");

    Detector(std::string const &name, int id, DetectorType type, std::string const &serial,
             lsst::geom::Box2I const &bbox, lsst::afw::table::AmpInfoCatalog const &ampInfoCatalog,
             Orientation const &orientation, lsst::geom::Extent2D const &pixelSize,
             std::shared_ptr<TransformMap const> transformMap,
             CrosstalkMatrix const &crosstalk = CrosstalkMatrix(),
             std::string const &physicalType="");

    ~Detector() = default;

    Detector(Detector const &) = delete;
    Detector(Detector &&) = delete;
    Detector &operator=(Detector const &) = delete;
    Detector &operator=(Detector &&) = delete;

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

    int getId() const { return _id; }

    DetectorType getType() const { return _type; }

    std::string getPhysicalType() const { return _physicalType; }

    std::string getSerial() const { return _serial; }

    lsst::geom::Box2I getBBox() const { return _bbox; }

    std::vector<lsst::geom::Point2D> getCorners(CameraSys const &cameraSys) const;

    std::vector<lsst::geom::Point2D> getCorners(CameraSysPrefix const &cameraSysPrefix) const;

    lsst::geom::Point2D getCenter(CameraSys const &cameraSys) const;

    lsst::geom::Point2D getCenter(CameraSysPrefix const &cameraSysPrefix) const;

    table::AmpInfoCatalog const getAmpInfoCatalog() const { return _ampInfoCatalog; }

    Orientation const getOrientation() const { return _orientation; }

    lsst::geom::Extent2D getPixelSize() const { return _pixelSize; }

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

    bool hasCrosstalk() const {
        return !(_crosstalk.isEmpty() || _crosstalk.getShape() == ndarray::makeVector(0, 0));
    }

    CrosstalkMatrix const getCrosstalk() const { return _crosstalk; }

    table::AmpInfoCatalog::const_iterator begin() const { return _ampInfoCatalog.begin(); }

    table::AmpInfoCatalog::const_iterator end() const { return _ampInfoCatalog.end(); }

    table::AmpInfoRecord const &operator[](size_t i) const { return _ampInfoCatalog.at(i); }

    table::AmpInfoRecord const &operator[](std::string const &name) const;

    std::shared_ptr<table::AmpInfoRecord const> _get(int i) const;

    std::shared_ptr<table::AmpInfoRecord const> _get(std::string const &name) const;

    size_t size() const { return _ampInfoCatalog.size(); }

    bool hasTransform(CameraSys const &cameraSys) const;

    bool hasTransform(CameraSysPrefix const &cameraSysPrefix) const;

    template <typename FromSysT, typename ToSysT>
    std::shared_ptr<afw::geom::TransformPoint2ToPoint2> getTransform(FromSysT const &fromSys,
                                                                     ToSysT const &toSys) const;

    CameraSys const makeCameraSys(CameraSys const &cameraSys) const { return cameraSys; }

    CameraSys const makeCameraSys(CameraSysPrefix const &cameraSysPrefix) const {
        return CameraSys(cameraSysPrefix, _name);
    }

    template <typename FromSysT, typename ToSysT>
    lsst::geom::Point2D transform(lsst::geom::Point2D const &point, FromSysT const &fromSys,
                                  ToSysT const &toSys) const;

    template <typename FromSysT, typename ToSysT>
    std::vector<lsst::geom::Point2D> transform(std::vector<lsst::geom::Point2D> const &points,
                                               FromSysT const &fromSys, ToSysT const &toSys) const;

    CameraSys getNativeCoordSys() const { return _nativeSys; }

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

private:
    typedef std::unordered_map<std::string, table::AmpInfoCatalog::const_iterator> _AmpInfoMap;

    std::string getPersistenceName() const override;

    std::string getPythonModule() const override;

    void write(OutputArchiveHandle& handle) const override;

    std::string _name;                      
    int _id;                                
    DetectorType _type;                     
    std::string _serial;                    
    lsst::geom::Box2I _bbox;                
    table::AmpInfoCatalog _ampInfoCatalog;  
    _AmpInfoMap _ampNameIterMap;            
    Orientation _orientation;               
    lsst::geom::Extent2D _pixelSize;        
    CameraSys _nativeSys;                   
    std::shared_ptr<TransformMap const> _transformMap;   
    CrosstalkMatrix _crosstalk;             
    std::string _physicalType;              
};
}  // namespace cameraGeom
}  // namespace afw
}  // namespace lsst

#endif