Loading [MathJax]/extensions/tex2jax.js
LSST Applications g0f08755f38+9522ef2f0f,g1653933729+a905cd61c3,g168dd56ebc+a905cd61c3,g1a2382251a+910d683904,g20f6ffc8e0+9522ef2f0f,g217e2c1bcf+f4af07de8a,g28da252d5a+26a25b978d,g2bbee38e9b+cc7bbd92cc,g2bc492864f+cc7bbd92cc,g32e5bea42b+de24d92311,g347aa1857d+cc7bbd92cc,g35bb328faa+a905cd61c3,g3a166c0a6a+cc7bbd92cc,g3bd4b5ce2c+02735527dc,g3e281a1b8c+2bff41ced5,g414038480c+4de324692b,g41af890bb2+4fc8c6ef01,g43bc871e57+d0d7cc457a,g78460c75b0+4ae99bb757,g80478fca09+615987a4d7,g82479be7b0+970d1d03ea,g8365541083+a905cd61c3,g858d7b2824+9522ef2f0f,g9125e01d80+a905cd61c3,ga5288a1d22+9ad990292e,gb58c049af0+84d1b6ec45,gc28159a63d+cc7bbd92cc,gc5452a3dca+b82ec7cc4c,gcab2d0539d+475d436cbd,gcf0d15dbbd+d816b8a730,gda6a2b7d83+d816b8a730,gdaeeff99f8+686ef0dd99,ge79ae78c31+cc7bbd92cc,gef2f8181fd+c1889b0e42,gf0baf85859+f9edac6842,gf1e97e5484+a55c27affc,gfa517265be+9522ef2f0f,gfa999e8aa5+d85414070d,w.2025.01
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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
33namespace lsst {
34namespace afw {
35namespace image {
36
65class TransmissionCurve : public table::io::PersistableFacade<TransmissionCurve>,
67 public std::enable_shared_from_this<TransmissionCurve> {
68public:
73
89 ndarray::Array<double const, 1> const &throughput,
90 ndarray::Array<double const, 1> const &wavelengths, double throughputAtMin = 0.0,
91 double throughputAtMax = 0.0);
92
112 ndarray::Array<double const, 2> const &throughput,
113 ndarray::Array<double const, 1> const &wavelengths, ndarray::Array<double const, 1> const &radii,
114 double throughputAtMin = 0.0, double throughputAtMax = 0.0);
115
129
139
140 // TransmissionCurve is not copyable.
142
143 // TransmissionCurve is not movable.
145
146 // TransmissionCurve is not copy-assignable.
148
149 // TransmissionCurve is not move-assignable.
151
152 ~TransmissionCurve() override = default;
153
164
170
187 virtual void sampleAt(lsst::geom::Point2D const &position,
188 ndarray::Array<double const, 1, 1> const &wavelengths,
189 ndarray::Array<double, 1, 1> const &out) const = 0;
190
200 ndarray::Array<double, 1, 1> sampleAt(lsst::geom::Point2D const &position,
201 ndarray::Array<double const, 1, 1> const &wavelengths) const;
202
203protected:
217
232
233 TransmissionCurve() = default;
234
235 std::string getPythonModule() const override;
236};
237
238} // namespace image
239} // namespace afw
240} // namespace lsst
241
242#endif // !LSST_AFW_IMAGE_TRANSMISSIONCURVE_H_INCLUDED
table::Key< int > transform
table::Key< double > throughputAtMax
table::Key< double > throughputAtMin
A spatially-varying transmission curve as a function of wavelength.
TransmissionCurve(TransmissionCurve const &)=delete
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.
virtual std::pair< double, double > getWavelengthBounds() const =0
Return the wavelength interval on which this TransmissionCurve varies.
TransmissionCurve & operator=(TransmissionCurve &&)=delete
virtual std::pair< double, double > getThroughputAtBounds() const =0
Return the throughput value that will be returned for wavelengths below and above getWavelenthBounds(...
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.
std::shared_ptr< TransmissionCurve const > multipliedBy(TransmissionCurve const &other) const
Return a new TransmissionCurve that simply multiplies the values of two others.
virtual std::shared_ptr< TransmissionCurve const > _transformedByImpl(std::shared_ptr< geom::TransformPoint2ToPoint2 > transform) const
Polymorphic implementation for transformedBy().
std::string getPythonModule() const override
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
~TransmissionCurve() override=default
std::shared_ptr< TransmissionCurve const > transformedBy(std::shared_ptr< geom::TransformPoint2ToPoint2 > transform) const
Return a view of a TransmissionCurve in a different coordinate system.
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.
virtual std::shared_ptr< TransmissionCurve const > _multipliedByImpl(std::shared_ptr< TransmissionCurve const > other) const
One-way polymorphic implementation for multipliedBy().
TransmissionCurve(TransmissionCurve &&)=delete
TransmissionCurve & operator=(TransmissionCurve const &)=delete
static std::shared_ptr< TransmissionCurve const > makeIdentity()
Create a new TranmissionCurve that has unit thoughput at all wavelengths everywhere.
A CRTP facade class for subclasses of Persistable.
Interface supporting iteration over heterogenous containers.
Definition Storable.h:58