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/TransformMap.h"
#include "lsst/afw/table/AmpInfo.h"
#include "lsst/afw/cameraGeom/CameraSys.h"
#include "lsst/afw/cameraGeom/CameraPoint.h"
#include "lsst/afw/cameraGeom/Orientation.h"

namespace lsst {
namespace afw {
namespace cameraGeom {

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


class Detector {
public:
    explicit Detector(
        std::string const &name,    
        int id,                     
        DetectorType type,          
        std::string const &serial,  
        geom::Box2I const &bbox,    
        lsst::afw::table::AmpInfoCatalog const &ampInfoCatalog, 
        Orientation const &orientation,     
        geom::Extent2D const &pixelSize,    
        CameraTransformMap::Transforms const &transforms    
    );

    ~Detector() {}

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

    int getId() const { return _id; }

    DetectorType getType() const { return _type; }

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

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

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

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

    CameraPoint getCenter(CameraSys const &cameraSys) const;

    CameraPoint getCenter(CameraSysPrefix const &cameraSysPrefix) const;

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

    Orientation const getOrientation() const { return _orientation; }

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

    CameraTransformMap const getTransformMap() const { return _transformMap; }

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

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

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

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

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

    bool hasTransform(CameraSys const &cameraSys) const;

    bool hasTransform(CameraSysPrefix const &cameraSysPrefix) const;

    CONST_PTR(afw::geom::XYTransform) getTransform(CameraSys const &cameraSys) const;

    CONST_PTR(afw::geom::XYTransform) getTransform(CameraSysPrefix const &cameraSysPrefix) const;

    CameraPoint makeCameraPoint(
        geom::Point2D point,    
        CameraSys cameraSys     
    ) const {
        return CameraPoint(point, cameraSys);
    }

    CameraPoint makeCameraPoint(
        geom::Point2D point,    
        CameraSysPrefix cameraSysPrefix     
    ) const {
        return CameraPoint(point, makeCameraSys(cameraSysPrefix));
    }

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

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

    CameraPoint transform(
        CameraPoint const &fromCameraPoint, 
        CameraSys const &toSys          
    ) const {
        return CameraPoint(
            _transformMap.transform(fromCameraPoint.getPoint(), fromCameraPoint.getCameraSys(), toSys),
            toSys);
    }

    CameraPoint transform(
        CameraPoint const &fromCameraPoint, 
        CameraSysPrefix const &toSys    
    ) const {
        return transform(fromCameraPoint, makeCameraSys(toSys));
    }

private:
    typedef std::unordered_map<std::string, table::AmpInfoCatalog::const_iterator> _AmpInfoMap;
    void _init();

    std::string _name;      
    int _id;                
    DetectorType _type;     
    std::string _serial;    
    geom::Box2I _bbox;      
    table::AmpInfoCatalog _ampInfoCatalog; 
    _AmpInfoMap _ampNameIterMap;    
    Orientation _orientation;       
    geom::Extent2D _pixelSize;      
    CameraTransformMap _transformMap; 
};

}}}

#endif