lsst.afw  21.0.0-8-gd9c33f4a0+ec3713772a
ProductBoundedField.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2014 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_AFW_MATH_ProductBoundedField_h_INCLUDED
25 #define LSST_AFW_MATH_ProductBoundedField_h_INCLUDED
26 
28 
29 namespace lsst {
30 namespace afw {
31 namespace math {
32 
36 class ProductBoundedField final : public table::io::PersistableFacade<ProductBoundedField>,
37  public BoundedField {
38 public:
39 
51 
57 
59  double evaluate(lsst::geom::Point2D const& position) const override;
60 
62  ndarray::Array<double, 1, 1> evaluate(ndarray::Array<double const, 1> const& x,
63  ndarray::Array<double const, 1> const& y) const override;
64 
66 
71  bool isPersistable() const noexcept override;
72 
74  std::shared_ptr<BoundedField> operator*(double const scale) const override;
75 
77  bool operator==(BoundedField const& rhs) const override;
78 
79 protected:
80 
81  std::string getPersistenceName() const override;
82 
83  std::string getPythonModule() const override;
84 
85  void write(OutputArchiveHandle& handle) const override;
86 
87 private:
88 
89  std::string toString() const override;
90 
91  std::vector<std::shared_ptr<BoundedField const>> _factors;
92 };
93 } // namespace math
94 } // namespace afw
95 } // namespace lsst
96 
97 #endif // !LSST_AFW_MATH_ProductBoundedField_h_INCLUDED
y
int y
Definition: SpanSet.cc:49
lsst::afw::math::ProductBoundedField::ProductBoundedField
ProductBoundedField(std::vector< std::shared_ptr< BoundedField const >> const &factors)
Construct from a sequence of BoundedField factors.
Definition: ProductBoundedField.cc:70
std::shared_ptr
STL class.
lsst::afw::math::BoundedField
An abstract base class for 2-d functions defined on an integer bounding boxes.
Definition: BoundedField.h:55
lsst::afw::math::ProductBoundedField
A BoundedField that lazily multiplies a sequence of other BoundedFields.
Definition: ProductBoundedField.h:37
lsst::afw::table::io::OutputArchiveHandle
An object passed to Persistable::write to allow it to persist itself.
Definition: OutputArchive.h:118
lsst::afw::math::ProductBoundedField::evaluate
double evaluate(lsst::geom::Point2D const &position) const override
Evaluate the field at the given point.
Definition: ProductBoundedField.cc:78
std::vector
STL class.
lsst::afw::math::ProductBoundedField::operator=
ProductBoundedField & operator=(ProductBoundedField &&)=delete
lsst::afw::math::ProductBoundedField::getPersistenceName
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
Definition: ProductBoundedField.cc:163
lsst::afw::math::ProductBoundedField::operator=
ProductBoundedField & operator=(ProductBoundedField const &)=delete
x
double x
Definition: ChebyshevBoundedField.cc:277
lsst::afw::math::ProductBoundedField::ProductBoundedField
ProductBoundedField(ProductBoundedField &&)
lsst
A base class for image defects.
lsst::afw::math::BoundedField::evaluate
virtual double evaluate(lsst::geom::Point2D const &position) const =0
Evaluate the field at the given point.
lsst::afw::math::ProductBoundedField::isPersistable
bool isPersistable() const noexcept override
ProductBoundedField is persistable if and only if all of its factors are.
Definition: ProductBoundedField.cc:158
std
STL namespace.
Point< double, 2 >
lsst::afw::table::io::PersistableFacade
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
lsst::afw.display.ds9.scale
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:109
lsst::afw::math::ProductBoundedField::ProductBoundedField
ProductBoundedField(ProductBoundedField const &)
lsst::afw::math::ProductBoundedField::~ProductBoundedField
~ProductBoundedField() override
lsst::afw::math::ProductBoundedField::getPythonModule
std::string getPythonModule() const override
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
Definition: ProductBoundedField.cc:167
BoundedField.h
lsst::afw::math::ProductBoundedField::write
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
Definition: ProductBoundedField.cc:169