LSSTApplications  19.0.0-14-gb0260a2+b89439f59d,20.0.0+126303c00d,20.0.0+2f3d0e5c40,20.0.0+36ef800059,20.0.0+6ab788e194,20.0.0+a788ff1d83,20.0.0+b545961afb,20.0.0+bebc1f60e8,20.0.0+e2e26847c2,20.0.0+ec00f03e9c,20.0.0-1-g10df615+b92a01c08d,20.0.0-1-g253301a+36ef800059,20.0.0-1-g2b7511a+bebc1f60e8,20.0.0-1-g4d801e7+7c74587066,20.0.0-1-g5b95a8c+3e2d406de1,20.0.0-1-g660595b+f45b7d88f4,20.0.0-1-gc96f8cb+665e8551f1,20.0.0-1-gd1c87d7+85c46248f3,20.0.0-1-gedffbd8+ca2c461684,20.0.0-14-g1ce627f+450400e286,20.0.0-16-g111fe95+665e8551f1,20.0.0-16-g233ea98+b7ef15a6f8,20.0.0-17-ga9337b4+235318a901,20.0.0-2-g4dae9ad+665e8551f1,20.0.0-2-g7818986+85c46248f3,20.0.0-2-gec03fae+ff10c6d78d,20.0.0-25-g38d2b7ae+6870ac0cf6,20.0.0-3-g4cc78c6+63636aeed8,20.0.0-3-g6a8623c+450400e286,20.0.0-3-g750bffe+50c7740d2d,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-48-gd64a390+cf2ddfd0ca,20.0.0-5-g357b56b+f45b7d88f4,20.0.0-5-gfcebe35+806271b712,20.0.0-7-gc818c6e6+7d435f9f99,20.0.0-7-gcda7bf1+1884c7ddc6,20.0.0-9-g61a2a9a3d+14f89e4eca,w.2020.39
LSSTDataManagementBasePackage
TransmissionCurve.h
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2017 LSST/AURA.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <http://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #ifndef LSST_AFW_IMAGE_TRANSMISSIONCURVE_H_INCLUDED
24 #define LSST_AFW_IMAGE_TRANSMISSIONCURVE_H_INCLUDED
25 
26 #include "ndarray_fwd.h"
27 
29 #include "lsst/geom/Box.h"
32 
33 namespace lsst {
34 namespace afw {
35 namespace image {
36 
59 class TransmissionCurve : public table::io::PersistableFacade<TransmissionCurve>,
61  public std::enable_shared_from_this<TransmissionCurve> {
62 public:
67 
83  ndarray::Array<double const, 1> const &throughput,
84  ndarray::Array<double const, 1> const &wavelengths, double throughputAtMin = 0.0,
85  double throughputAtMax = 0.0);
86 
106  ndarray::Array<double const, 2> const &throughput,
107  ndarray::Array<double const, 1> const &wavelengths, ndarray::Array<double const, 1> const &radii,
108  double throughputAtMin = 0.0, double throughputAtMax = 0.0);
109 
123 
133 
134  // TransmissionCurve is not copyable.
136 
137  // TransmissionCurve is not movable.
139 
140  // TransmissionCurve is not copy-assignable.
142 
143  // TransmissionCurve is not move-assignable.
145 
146  ~TransmissionCurve() override = default;
147 
158 
164 
181  virtual void sampleAt(lsst::geom::Point2D const &position,
182  ndarray::Array<double const, 1, 1> const &wavelengths,
183  ndarray::Array<double, 1, 1> const &out) const = 0;
184 
194  ndarray::Array<double, 1, 1> sampleAt(lsst::geom::Point2D const &position,
195  ndarray::Array<double const, 1, 1> const &wavelengths) const;
196 
197 protected:
211 
226 
227  TransmissionCurve() = default;
228 
229  std::string getPythonModule() const override;
230 };
231 
232 } // namespace image
233 } // namespace afw
234 } // namespace lsst
235 
236 #endif // !LSST_AFW_IMAGE_TRANSMISSIONCURVE_H_INCLUDED
lsst::afw::image
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Definition: imageAlgorithm.dox:1
lsst::afw::image::TransmissionCurve::_transformedByImpl
virtual std::shared_ptr< TransmissionCurve const > _transformedByImpl(std::shared_ptr< geom::TransformPoint2ToPoint2 > transform) const
Polymorphic implementation for transformedBy().
Definition: TransmissionCurve.cc:672
lsst::afw::image::TransmissionCurve::TransmissionCurve
TransmissionCurve()=default
std::string
STL class.
std::shared_ptr
STL class.
std::pair< double, double >
lsst::afw::image::TransmissionCurve::makeIdentity
static std::shared_ptr< TransmissionCurve const > makeIdentity()
Create a new TranmissionCurve that has unit thoughput at all wavelengths everywhere.
Definition: TransmissionCurve.cc:610
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::image::TransmissionCurve::transformedBy
std::shared_ptr< TransmissionCurve const > transformedBy(std::shared_ptr< geom::TransformPoint2ToPoint2 > transform) const
Return a view of a TransmissionCurve in a different coordinate system.
Definition: TransmissionCurve.cc:660
lsst::afw::image::TransmissionCurve::sampleAt
virtual void sampleAt(lsst::geom::Point2D const &position, ndarray::Array< double const, 1, 1 > const &wavelengths, ndarray::Array< double, 1, 1 > const &out) const =0
Evaluate the throughput at a position into a provided output array.
lsst::afw::typehandling::Storable
Interface supporting iteration over heterogenous containers.
Definition: Storable.h:58
lsst::afw::image::TransmissionCurve::getPythonModule
std::string getPythonModule() const override
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
Definition: TransmissionCurve.cc:682
lsst::afw::image::TransmissionCurve::makeRadial
static std::shared_ptr< TransmissionCurve const > makeRadial(ndarray::Array< double const, 2 > const &throughput, ndarray::Array< double const, 1 > const &wavelengths, ndarray::Array< double const, 1 > const &radii, double throughputAtMin=0.0, double throughputAtMax=0.0)
Create a new TransmissionCurve with throughput varying as function of radius.
Definition: TransmissionCurve.cc:625
lsst::afw::image::TransmissionCurve::getWavelengthBounds
virtual std::pair< double, double > getWavelengthBounds() const =0
Return the wavelength interval on which this TransmissionCurve varies.
lsst::afw::image::TransmissionCurve::operator=
TransmissionCurve & operator=(TransmissionCurve const &)=delete
lsst::afw::image::TransmissionCurve::makeSpatiallyConstant
static std::shared_ptr< TransmissionCurve const > makeSpatiallyConstant(ndarray::Array< double const, 1 > const &throughput, ndarray::Array< double const, 1 > const &wavelengths, double throughputAtMin=0.0, double throughputAtMax=0.0)
Create a new TransmissionCurve with spatially-constant throughput.
Definition: TransmissionCurve.cc:614
throughputAtMax
table::Key< double > throughputAtMax
Definition: TransmissionCurve.cc:347
Box.h
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::image::TransmissionCurve::~TransmissionCurve
~TransmissionCurve() override=default
std::enable_shared_from_this
Storable.h
lsst::afw::image::TransmissionCurve::operator=
TransmissionCurve & operator=(TransmissionCurve &&)=delete
lsst::afw::image::TransmissionCurve::TransmissionCurve
TransmissionCurve(TransmissionCurve const &)=delete
lsst::afw::image::TransmissionCurve::multipliedBy
std::shared_ptr< TransmissionCurve const > multipliedBy(TransmissionCurve const &other) const
Return a new TransmissionCurve that simply multiplies the values of two others.
Definition: TransmissionCurve.cc:646
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::image::TransmissionCurve::_multipliedByImpl
virtual std::shared_ptr< TransmissionCurve const > _multipliedByImpl(std::shared_ptr< TransmissionCurve const > other) const
One-way polymorphic implementation for multipliedBy().
Definition: TransmissionCurve.cc:677
lsst::afw::image::TransmissionCurve
A spatially-varying transmission curve as a function of wavelength.
Definition: TransmissionCurve.h:61
Transform.h
lsst::geom::Point< double, 2 >
lsst::afw::table::io::PersistableFacade
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
throughputAtMin
table::Key< double > throughputAtMin
Definition: TransmissionCurve.cc:346
transform
table::Key< int > transform
Definition: TransformMap.cc:299
lsst::afw::image::TransmissionCurve::TransmissionCurve
TransmissionCurve(TransmissionCurve &&)=delete
lsst::afw::image::TransmissionCurve::getThroughputAtBounds
virtual std::pair< double, double > getThroughputAtBounds() const =0
Return the throughput value that will be returned for wavelengths below and above getWavelenthBounds(...
Persistable.h