lsst.meas.algorithms  13.0-23-gb99accf
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PcaPsf.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2013 LSST Corporation.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 
24 #ifndef LSST_MEAS_ALGORITHMS_PcaPsf_h_INCLUDED
25 #define LSST_MEAS_ALGORITHMS_PcaPsf_h_INCLUDED
26 
28 
29 namespace lsst { namespace meas { namespace algorithms {
30 
34 class PcaPsf : public lsst::afw::table::io::PersistableFacade<PcaPsf>, public KernelPsf {
35 public:
36 
43  explicit PcaPsf(
44  PTR(afw::math::LinearCombinationKernel) kernel,
45  afw::geom::Point2D const & averagePosition = afw::geom::Point2D()
46  );
47 
49  virtual PTR(afw::detection::Psf) clone() const;
50 
52  virtual PTR(afw::detection::Psf) resized(int width, int height) const;
53 
55  PTR(afw::math::LinearCombinationKernel const) getKernel() const;
56 
57 private:
58 
59  // Name used in table persistence; the rest of is implemented by KernelPsf.
60  virtual std::string getPersistenceName() const { return "PcaPsf"; }
61 
63 
64  template <class Archive>
65  void serialize(Archive&, unsigned int const) {
66  boost::serialization::void_cast_register<PcaPsf,
67  lsst::afw::detection::Psf>(static_cast<PcaPsf*>(0), static_cast<lsst::afw::detection::Psf*>(0));
68  }
69 
70 };
71 
72 }}}
73 
74 namespace boost {
75 namespace serialization {
76 
77 template <class Archive>
78 inline void save_construct_data(
79  Archive& ar, lsst::meas::algorithms::PcaPsf const* p,
80  unsigned int const) {
81  lsst::afw::math::LinearCombinationKernel const* kernel = p->getKernel().get();
82  ar << make_nvp("kernel", kernel);
83  lsst::afw::geom::Point2D averagePosition = p->getAveragePosition();
84  ar << make_nvp("averagePositionX", averagePosition.getX());
85  ar << make_nvp("averagePositionY", averagePosition.getY());
86 }
87 
88 template <class Archive>
89 inline void load_construct_data(
90  Archive& ar, lsst::meas::algorithms::PcaPsf* p,
91  unsigned int const) {
92  lsst::afw::math::LinearCombinationKernel* kernel;
93  ar >> make_nvp("kernel", kernel);
94  double x=0.0, y=0.0;
95  ar >> make_nvp("averagePositionX", x);
96  ar >> make_nvp("averagePositionY", y);
97  ::new(p) lsst::meas::algorithms::PcaPsf(PTR(lsst::afw::math::LinearCombinationKernel)(kernel),
98  lsst::afw::geom::Point2D(x, y));
99 }
100 
101 }} // namespace boost::serialization
102 
103 #endif // !LSST_MEAS_ALGORITHMS_PcaPsf_h_INCLUDED
virtual boost::shared_ptr< afw::detection::Psf > resized(int width, int height) const
Return a clone with specified kernel dimensions.
void load_construct_data(Archive &ar, lsst::meas::algorithms::DoubleGaussianPsf *p, unsigned int const )
A Psf defined by a Kernel.
Definition: KernelPsf.h:33
void save_construct_data(Archive &ar, lsst::meas::algorithms::DoubleGaussianPsf const *p, unsigned int const )
friend class boost::serialization::access
Definition: PcaPsf.h:62
Represent a PSF as a linear combination of PCA (== Karhunen-Loeve) basis functions.
Definition: PcaPsf.h:34
boost::shared_ptr< afw::math::LinearCombinationKernel const > getKernel() const
PcaPsf always has a LinearCombinationKernel, so we can override getKernel to make it more useful...
virtual afw::geom::Point2D getAveragePosition() const
Return average position of stars; used as default position.
Definition: KernelPsf.cc:33
tbl::PointKey< double > averagePosition
Definition: CoaddPsf.cc:356
virtual boost::shared_ptr< afw::detection::Psf > clone() const
Polymorphic deep copy; should usually be unnecessary as Psfs are immutable.x.
PcaPsf(boost::shared_ptr< afw::math::LinearCombinationKernel > kernel, afw::geom::Point2D const &averagePosition=afw::geom::Point2D())
Constructor for a PcaPsf.