#include <CoaddBoundedField.h>

Inheritance diagram for lsst::meas::algorithms::CoaddBoundedField:

Classes
class	Factory

Public Types
typedef CoaddBoundedFieldElement	Element

typedef std::vector< Element >	ElementVector

Public Member Functions
	CoaddBoundedField (afw::geom::Box2I const &bbox, boost::shared_ptr< afw::image::Wcs const > coaddWcs, ElementVector const &elements)

	CoaddBoundedField (afw::geom::Box2I const &bbox, boost::shared_ptr< afw::image::Wcs const > coaddWcs, ElementVector const &elements, double default_)

virtual double	evaluate (afw::geom::Point2D const &position) const

virtual bool	isPersistable () const
	Return true if the CoaddBoundedField persistable (always true). More...

virtual boost::shared_ptr < afw::math::BoundedField >	operator* (double const scale) const

Public Member Functions inherited from lsst::afw::math::BoundedField
double	evaluate (double x, double y) const

ndarray::Array< double, 1, 1 >	evaluate (ndarray::Array< double const, 1 > const &x, ndarray::Array< double const, 1 > const &y) const

geom::Box2I	getBBox () const

template<typename T >
void	fillImage (image::Image< T > &image, bool overlapOnly=false) const

template<typename T >
void	addToImage (image::Image< T > &image, double scaleBy=1.0, bool overlapOnly=false) const

template<typename T >
void	multiplyImage (image::Image< T > &image, bool overlapOnly=false) const

template<typename T >
void	divideImage (image::Image< T > &image, bool overlapOnly=false) const

boost::shared_ptr< BoundedField >	operator/ (double scale) const

virtual	~BoundedField ()

Public Member Functions inherited from lsst::afw::table::io::Persistable
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file. More...

void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory. More...

void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object. More...

virtual	~Persistable ()

Protected Member Functions
virtual std::string	getPersistenceName () const
	Return the unique name used to persist this object and look up its factory. More...

virtual std::string	getPythonModule () const
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...

virtual void	write (OutputArchiveHandle &handle) const
	Write the object to one or more catalogs. More...

Protected Member Functions inherited from lsst::afw::math::BoundedField
	BoundedField (geom::Box2I const &bbox)

Protected Member Functions inherited from lsst::afw::table::io::Persistable
	Persistable ()

	Persistable (Persistable const &other)

void	operator= (Persistable const &other)

Private Attributes
bool	_throwOnMissing

double	_default

boost::shared_ptr < afw::image::Wcs const >	_coaddWcs

ElementVector	_elements

Additional Inherited Members
Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< CoaddBoundedField >
static boost::shared_ptr < CoaddBoundedField >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

static boost::shared_ptr < CoaddBoundedField >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...

static boost::shared_ptr < CoaddBoundedField >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...

Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< BoundedField >
static boost::shared_ptr < BoundedField >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

static boost::shared_ptr < BoundedField >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...

static boost::shared_ptr < BoundedField >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...

Protected Types inherited from lsst::afw::table::io::Persistable
typedef io::OutputArchiveHandle	OutputArchiveHandle

Detailed Description

Definition at line 50 of file CoaddBoundedField.h.

Member Typedef Documentation

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

Definition at line 56 of file CoaddBoundedField.h.

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

Definition at line 57 of file CoaddBoundedField.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 34 of file CoaddBoundedField.cc.

   :
     afw::math::BoundedField(bbox),
     _throwOnMissing(true),
     _default(0.0), // unused
     _coaddWcs(coaddWcs),
     _elements(elements)
 {}

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

explicit

Definition at line 46 of file CoaddBoundedField.cc.

   :
     afw::math::BoundedField(bbox),
     _throwOnMissing(false),
     _default(default_),
     _coaddWcs(coaddWcs),
     _elements(elements)
 {}

Member Function Documentation

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

virtual

Evaluate the field at the given point.

This is the only abstract method to be implemented by subclasses.

Subclasses should not provide bounds checking on the given position; this is the responsibility of the user, who can almost always do it more efficiently.

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

Definition at line 59 of file CoaddBoundedField.cc.

                                                                         {
     PTR(afw::coord::Coord) coord = _coaddWcs->pixelToSky(position);
     double sum = 0.0;
     double wSum = 0.0;
     for (ElementVector::const_iterator i = _elements.begin(); i != _elements.end(); ++i) {
         afw::geom::Point2D transformedPosition = i->wcs->skyToPixel(*coord);
         bool inValidArea = i->validPolygon ? i->validPolygon->contains(transformedPosition) : true;
         if (afw::geom::Box2D(i->field->getBBox()).contains(transformedPosition) && inValidArea) {
             sum += i->weight * i->field->evaluate(transformedPosition);
             wSum += i->weight;
         }
     }
     if (wSum == 0.0) {
         if (_throwOnMissing) {
             throw LSST_EXCEPT(
                 pex::exceptions::DomainError,
                 (boost::format("No constituent fields to evaluate at point %f, %f")
                  % position.getX() % position.getY()).str()
             );
         } else {
             return _default;
         }
     }
     return sum / wSum;
 }

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

protectedvirtual

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 197 of file CoaddBoundedField.cc.

197 { return getCoaddBoundedFieldPersistenceName(); }

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

protectedvirtual

Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.

Will be ignored if empty.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 199 of file CoaddBoundedField.cc.

199 { return "lsst.meas.algorithms"; }

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

inlinevirtual

Return true if the CoaddBoundedField persistable (always true).

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 78 of file CoaddBoundedField.h.

78 { return true; }

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

virtual

Return a scaled BoundedField

Parameters

[in] scale Scaling factor

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

Definition at line 222 of file CoaddBoundedField.cc.

                                                                               {
     throw LSST_EXCEPT(pex::exceptions::NotFoundError, "Scaling of CoaddBoundedField is not implemented");
 }

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

protectedvirtual

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 201 of file CoaddBoundedField.cc.

                                                                 {
     CoaddBoundedFieldPersistenceKeys1 const & keys1 = CoaddBoundedFieldPersistenceKeys1::get();
     CoaddBoundedFieldPersistenceKeys2 const & keys2 = CoaddBoundedFieldPersistenceKeys2::get();
     tbl::BaseCatalog cat1 = handle.makeCatalog(keys1.schema);
     PTR(tbl::BaseRecord) record1 = cat1.addNew();
     record1->set(keys1.bboxMin, getBBox().getMin());
     record1->set(keys1.bboxMax, getBBox().getMax());
     record1->set(keys1.coaddWcs, handle.put(_coaddWcs));
     record1->set(keys1.default_, _default);
     handle.saveCatalog(cat1);
     tbl::BaseCatalog cat2 = handle.makeCatalog(keys2.schema);
     for (ElementVector::const_iterator i = _elements.begin(); i != _elements.end(); ++i) {
         PTR(tbl::BaseRecord) record2 = cat2.addNew();
         record2->set(keys2.field, handle.put(i->field));
         record2->set(keys2.wcs, handle.put(i->wcs));
         record2->set(keys2.validPolygon, handle.put(i->validPolygon));
         record2->set(keys2.weight, i->weight);
     }
     handle.saveCatalog(cat2);
 }

Member Data Documentation

boost::shared_ptr< afw::image::Wcs const > lsst::meas::algorithms::CoaddBoundedField::_coaddWcs

private

Definition at line 100 of file CoaddBoundedField.h.

double lsst::meas::algorithms::CoaddBoundedField::_default

private

Definition at line 99 of file CoaddBoundedField.h.

ElementVector lsst::meas::algorithms::CoaddBoundedField::_elements

private

Definition at line 101 of file CoaddBoundedField.h.

bool lsst::meas::algorithms::CoaddBoundedField::_throwOnMissing

private

Definition at line 98 of file CoaddBoundedField.h.

The documentation for this class was generated from the following files:

/home/lsstsw/stack/Linux64/meas_algorithms/11.0-2-gb8b8ce7/include/lsst/meas/algorithms/CoaddBoundedField.h
/home/lsstsw/stack/Linux64/meas_algorithms/11.0-2-gb8b8ce7/src/CoaddBoundedField.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation