lsst.meas.algorithms  19.0.0-7-ga57c4689+15
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | List of all members
lsst::meas::algorithms::CoaddBoundedField Class Referenceabstract

#include <CoaddBoundedField.h>

Inheritance diagram for lsst::meas::algorithms::CoaddBoundedField:
lsst::afw::table::io::PersistableFacade< CoaddBoundedField > lsst::afw::math::BoundedField PersistableFacade< BoundedField > lsst::afw::table::io::Persistable

Classes

class  Factory
 

Public Types

typedef CoaddBoundedFieldElement Element
 
typedef std::vector< Element > ElementVector
 

Public Member Functions

 CoaddBoundedField (geom::Box2I const &bbox, boost::shared_ptr< afw::geom::SkyWcs const > coaddWcs, ElementVector const &elements)
 
 CoaddBoundedField (geom::Box2I const &bbox, boost::shared_ptr< afw::geom::SkyWcs const > coaddWcs, ElementVector const &elements, double default_)
 
double evaluate (geom::Point2D const &position) const override
 
std::shared_ptr< afw::geom::SkyWcs const > getCoaddWcs () const
 Get the coaddWcs. More...
 
double getDefault () const
 Get the default value. More...
 
ElementVector getElements () const
 Get the elements vector. More...
 
virtual bool isPersistable () const noexcept override
 Return true if the CoaddBoundedField persistable (always true). More...
 
boost::shared_ptr< afw::math::BoundedField > operator* (double const scale) const override
 
bool operator== (BoundedField const &rhs) const override
 BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal. More...
 
double evaluate (double x, double y) const
 
virtual ndarray::Array< double, 1, 1 > evaluate (ndarray::Array< double const, 1 > const &x, ndarray::Array< double const, 1 > const &y) const
 
virtual double integrate () const
 
virtual double mean () const
 
lsst::geom::Box2I getBBox () const
 
void fillImage (image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
 
void addToImage (image::Image< T > &image, double scaleBy=1.0, bool overlapOnly=false, int xStep=1, int yStep=1) const
 
void multiplyImage (image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
 
void divideImage (image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
 
std::shared_ptr< BoundedField > operator/ (double scale) const
 
virtual bool operator== (BoundedField const &rhs) const=0
 
bool operator!= (BoundedField const &rhs) const
 
void writeFits (std::string const &fileName, std::string const &mode="w") const
 
void writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
 
void writeFits (fits::Fits &fitsfile) const
 

Static Public Member Functions

static std::shared_ptr< CoaddBoundedField > readFits (fits::Fits &fitsfile)
 
static std::shared_ptr< CoaddBoundedField > readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< CoaddBoundedField > readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< CoaddBoundedField > dynamicCast (std::shared_ptr< Persistable > const &ptr)
 
static std::shared_ptr< BoundedField > readFits (fits::Fits &fitsfile)
 
static std::shared_ptr< BoundedField > readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< BoundedField > readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< BoundedField > readFits (fits::Fits &fitsfile)
 
static std::shared_ptr< BoundedField > readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< BoundedField > dynamicCast (std::shared_ptr< Persistable > const &ptr)
 

Protected Types

typedef io::OutputArchiveHandle OutputArchiveHandle
 

Protected Member Functions

std::string getPersistenceName () const override
 
std::string getPythonModule () const override
 
void write (OutputArchiveHandle &handle) const override
 
virtual void write (OutputArchiveHandle &handle) const
 

Detailed Description

Definition at line 59 of file CoaddBoundedField.h.

Member Typedef Documentation

◆ Element

typedef CoaddBoundedFieldElement lsst::meas::algorithms::CoaddBoundedField::Element

Definition at line 62 of file CoaddBoundedField.h.

◆ ElementVector

typedef std::vector<Element> lsst::meas::algorithms::CoaddBoundedField::ElementVector

Definition at line 63 of file CoaddBoundedField.h.

Constructor & Destructor Documentation

◆ CoaddBoundedField() [1/2]

lsst::meas::algorithms::CoaddBoundedField::CoaddBoundedField ( geom::Box2I const &  bbox,
boost::shared_ptr< afw::geom::SkyWcs const >  coaddWcs,
ElementVector const &  elements 
)
explicit

Definition at line 73 of file CoaddBoundedField.cc.

◆ CoaddBoundedField() [2/2]

lsst::meas::algorithms::CoaddBoundedField::CoaddBoundedField ( geom::Box2I const &  bbox,
boost::shared_ptr< afw::geom::SkyWcs const >  coaddWcs,
ElementVector const &  elements,
double  default_ 
)
explicit

Definition at line 81 of file CoaddBoundedField.cc.

Member Function Documentation

◆ evaluate()

double lsst::meas::algorithms::CoaddBoundedField::evaluate ( geom::Point2D const &  position) const
overridevirtual

Implements lsst::afw::math::BoundedField.

Definition at line 89 of file CoaddBoundedField.cc.

◆ getCoaddWcs()

std::shared_ptr<afw::geom::SkyWcs const> lsst::meas::algorithms::CoaddBoundedField::getCoaddWcs ( ) const
inline

Get the coaddWcs.

Definition at line 75 of file CoaddBoundedField.h.

◆ getDefault()

double lsst::meas::algorithms::CoaddBoundedField::getDefault ( ) const
inline

Get the default value.

Definition at line 78 of file CoaddBoundedField.h.

◆ getElements()

ElementVector lsst::meas::algorithms::CoaddBoundedField::getElements ( ) const
inline

Get the elements vector.

Definition at line 81 of file CoaddBoundedField.h.

◆ getPersistenceName()

std::string lsst::meas::algorithms::CoaddBoundedField::getPersistenceName ( ) const
overrideprotectedvirtual

Reimplemented from lsst::afw::math::BoundedField.

Definition at line 229 of file CoaddBoundedField.cc.

◆ getPythonModule()

std::string lsst::meas::algorithms::CoaddBoundedField::getPythonModule ( ) const
overrideprotectedvirtual

Reimplemented from lsst::afw::math::BoundedField.

Definition at line 231 of file CoaddBoundedField.cc.

◆ isPersistable()

virtual bool lsst::meas::algorithms::CoaddBoundedField::isPersistable ( ) const
inlineoverridevirtualnoexcept

Return true if the CoaddBoundedField persistable (always true).

Reimplemented from lsst::afw::math::BoundedField.

Definition at line 86 of file CoaddBoundedField.h.

◆ operator*()

boost::shared_ptr< afw::math::BoundedField > lsst::meas::algorithms::CoaddBoundedField::operator* ( double const  scale) const
overridevirtual

Implements lsst::afw::math::BoundedField.

Definition at line 254 of file CoaddBoundedField.cc.

◆ operator==()

bool lsst::meas::algorithms::CoaddBoundedField::operator== ( BoundedField const &  rhs) const
override

BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.

Definition at line 258 of file CoaddBoundedField.cc.

◆ write()

void lsst::meas::algorithms::CoaddBoundedField::write ( OutputArchiveHandle &  handle) const
overrideprotectedvirtual

Reimplemented from lsst::afw::math::BoundedField.

Definition at line 233 of file CoaddBoundedField.cc.

The documentation for this class was generated from the following files:
Generated on Thu Mar 5 2020 10:10:50 for lsst.meas.algorithms by   doxygen 1.8.13