LSSTApplications  20.0.0
LSSTDataManagementBasePackage
SpatialModelPsf.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 #if !defined(LSST_MEAS_ALGORITHMS_SPATIALMODELPSF_H)
3 #define LSST_MEAS_ALGORITHMS_SPATIALMODELPSF_H
4 
5 /*
6  * LSST Data Management System
7  * Copyright 2008, 2009, 2010 LSST Corporation.
8  *
9  * This product includes software developed by the
10  * LSST Project (http://www.lsst.org/).
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the LSST License Statement and
23  * the GNU General Public License along with this program. If not,
24  * see <http://www.lsstcorp.org/LegalNotices/>.
25  */
26 
34 #include <memory>
35 #include <utility>
36 #include <vector>
37 
38 #include "lsst/afw.h"
39 #include "lsst/geom/Point.h"
40 #include "lsst/afw/detection/Psf.h"
41 #include "lsst/afw/math/Kernel.h"
43 
44 namespace lsst {
45 namespace meas {
46 namespace algorithms {
47 
48 template <typename PixelT>
50 createKernelFromPsfCandidates(afw::math::SpatialCellSet const& psfCells, geom::Extent2I const& dims,
51  geom::Point2I const& xy0, int const nEigenComponents, int const spatialOrder,
52  int const ksize, int const nStarPerCell = -1, bool const constantWeight = true,
53  int const border = 3);
54 
55 template <typename PixelT>
56 int countPsfCandidates(afw::math::SpatialCellSet const& psfCells, int const nStarPerCell = -1);
57 
58 template <typename PixelT>
60  afw::math::SpatialCellSet const& psfCells,
61  int const nStarPerCell = -1,
62  double const tolerance = 1e-5,
63  double const lambda = 0.0);
64 template <typename PixelT>
66  afw::math::Kernel* kernel, afw::math::SpatialCellSet const& psfCells, bool const doNonLinearFit,
67  int const nStarPerCell = -1, double const tolerance = 1e-5, double const lambda = 0.0);
68 
69 template <typename ImageT>
70 double subtractPsf(afw::detection::Psf const& psf, ImageT* data, double x, double y,
71  double psfFlux = std::numeric_limits<double>::quiet_NaN());
72 
73 template <typename Image>
75  afw::math::LinearCombinationKernel const& kernel, Image const& image, geom::Point2D const& pos);
76 
77 template <typename Image>
79  afw::math::LinearCombinationKernel const& kernel, Image const& image, geom::Point2D const& pos);
80 
81 } // namespace algorithms
82 } // namespace meas
83 } // namespace lsst
84 
85 #endif
y
int y
Definition: SpanSet.cc:49
lsst::afw::image
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Definition: imageAlgorithm.dox:1
Psf.h
lsst::meas::algorithms::createKernelFromPsfCandidates
std::pair< std::shared_ptr< afw::math::LinearCombinationKernel >, std::vector< double > > createKernelFromPsfCandidates(afw::math::SpatialCellSet const &psfCells, geom::Extent2I const &dims, geom::Point2I const &xy0, int const nEigenComponents, int const spatialOrder, int const ksize, int const nStarPerCell=-1, bool const constantWeight=true, int const border=3)
Return a Kernel pointer and a list of eigenvalues resulting from analysing the provided SpatialCellSe...
Definition: SpatialModelPsf.cc:193
afw.h
std::pair
std::vector< double >
psf
Key< int > psf
Definition: Exposure.cc:65
lsst::meas::algorithms::countPsfCandidates
int countPsfCandidates(afw::math::SpatialCellSet const &psfCells, int const nStarPerCell=-1)
Count the number of candidates in use.
Definition: SpatialModelPsf.cc:337
lsst::meas::algorithms::subtractPsf
double subtractPsf(afw::detection::Psf const &psf, ImageT *data, double x, double y, double psfFlux=std::numeric_limits< double >::quiet_NaN())
lsst::meas::algorithms::fitKernelParamsToImage
std::pair< std::vector< double >, afw::math::KernelList > fitKernelParamsToImage(afw::math::LinearCombinationKernel const &kernel, Image const &image, geom::Point2D const &pos)
Fit a LinearCombinationKernel to an Image, allowing the coefficients of the components to vary.
Definition: SpatialModelPsf.cc:1037
data
char * data
Definition: BaseRecord.cc:62
lsst::afw::math::LinearCombinationKernel
A kernel that is a linear combination of fixed basis kernels.
Definition: Kernel.h:751
x
double x
Definition: ChebyshevBoundedField.cc:277
SpatialCell.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::meas::algorithms::fitSpatialKernelFromPsfCandidates
std::pair< bool, double > fitSpatialKernelFromPsfCandidates(afw::math::Kernel *kernel, afw::math::SpatialCellSet const &psfCells, int const nStarPerCell=-1, double const tolerance=1e-5, double const lambda=0.0)
Fit spatial kernel using full-nonlinear optimization to estimate candidate amplitudes.
Definition: SpatialModelPsf.cc:592
Kernel.h
lsst::geom::Point< int, 2 >
Point.h
lsst::afw::detection::Psf
A polymorphic base class for representing an image's Point Spread Function.
Definition: Psf.h:76
lsst::meas::algorithms::fitKernelToImage
std::pair< std::shared_ptr< afw::math::Kernel >, std::pair< double, double > > fitKernelToImage(afw::math::LinearCombinationKernel const &kernel, Image const &image, geom::Point2D const &pos)
Fit a LinearCombinationKernel to an Image, allowing the coefficients of the components to vary.
Definition: SpatialModelPsf.cc:1104
lsst::geom::Extent< int, 2 >
std::numeric_limits