lsst::afw::math::PixelAreaBoundedField Class Reference

A BoundedField that evaluate the pixel area of a SkyWcs in angular units. More...

#include <PixelAreaBoundedField.h>

Inheritance diagram for lsst::afw::math::PixelAreaBoundedField:

Public Member Functions
	PixelAreaBoundedField (lsst::geom::Box2I const &bbox, std::shared_ptr< geom::SkyWcs const > skyWcs, lsst::geom::AngleUnit const &unit=lsst::geom::radians, double scaling=1.0)
	Create a PixelAreaBoundedField from a SkyWcs.
	~PixelAreaBoundedField () override=default
	PixelAreaBoundedField (PixelAreaBoundedField const &)=default
	PixelAreaBoundedField (PixelAreaBoundedField &&)=default
PixelAreaBoundedField &	operator= (PixelAreaBoundedField const &)=delete
PixelAreaBoundedField &	operator= (PixelAreaBoundedField &&)=delete
double	evaluate (lsst::geom::Point2D const &position) const override
	Evaluate the field at the given point.
ndarray::Array< double, 1, 1 >	evaluate (ndarray::Array< double const, 1 > const &x, ndarray::Array< double const, 1 > const &y) const override
	Evaluate the field at multiple arbitrary points.
bool	isPersistable () const noexcept override
	PixelAreaBoundedField is persistable if and only if the nested SkyWcs is.
std::shared_ptr< BoundedField >	operator* (double const scale) const override
	Return a scaled BoundedField.
bool	operator== (BoundedField const &rhs) const override
	BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.
double	evaluate (double x, double y) const
	Evaluate the field at the given point.
virtual double	integrate () const
	Compute the integral of this function over its bounding-box.
virtual double	mean () const
	Compute the mean of this function over its bounding-box.
lsst::geom::Box2I	getBBox () const
	Return the bounding box that defines the region where the field is valid.
template<typename T >
void	fillImage (image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
	Assign the field to an image, overwriting values already present.
template<typename T >
void	addToImage (image::Image< T > &image, double scaleBy=1.0, bool overlapOnly=false, int xStep=1, int yStep=1) const
	Add the field or a constant multiple of it to an image in-place.
template<typename T >
void	multiplyImage (image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
	Multiply an image by the field in-place.
template<typename T >
void	divideImage (image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
	Divide an image by the field in-place.
std::shared_ptr< BoundedField >	operator/ (double scale) const
bool	operator!= (BoundedField const &rhs) const
	BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file.
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory.
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object.

Static Public Member Functions
static std::shared_ptr< BoundedField >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< BoundedField >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< BoundedField >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< BoundedField >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Protected Member Functions
std::string	getPersistenceName () const override
	Return the unique name used to persist this object and look up its factory.
std::string	getPythonModule () const override
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.
void	write (OutputArchiveHandle &handle) const override
	Write the object to one or more catalogs.

Private Member Functions
std::string	toString () const override

Detailed Description

A BoundedField that evaluate the pixel area of a SkyWcs in angular units.

Typically used to move an image or source flux between surface brightness and fluence.

Definition at line 47 of file PixelAreaBoundedField.h.

Member Typedef Documentation

OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

PixelAreaBoundedField() [1/3]

lsst::afw::math::PixelAreaBoundedField::PixelAreaBoundedField	(	lsst::geom::Box2I const &	bbox,
		std::shared_ptr< geom::SkyWcs const >	skyWcs,
		lsst::geom::AngleUnit const &	unit = lsst::geom::radians,
		double	scaling = 1.0 )

Create a PixelAreaBoundedField from a SkyWcs.

Parameters

[in]	bbox	Pixel bounding box over which the WCS is valid.
[in]	skyWcs	WCS that maps pixels to and from sky coordinates.
[in]	unit	Angular unit that is used (squared) for the fields values.
[in]	scaling	Factor all field values should be scaled by.

Exceptions

pex::exception::InvalidParameterError

Thrown if skyWcs is null.

Definition at line 46 of file PixelAreaBoundedField.cc.

  : BoundedField(bbox),
    _skyWcs(skyWcs),
    _scaling(scaling)
{
    if (_skyWcs == nullptr) {
        throw LSST_EXCEPT(
            pex::exceptions::InvalidParameterError,
            "SkyWcs passed to PixelAreaBoundedField is null."
        );
    }
    _scaling /= std::pow((1.0*unit).asRadians(), 2);
}

~PixelAreaBoundedField()

lsst::afw::math::PixelAreaBoundedField::~PixelAreaBoundedField ( )

overridedefault

PixelAreaBoundedField() [2/3]

lsst::afw::math::PixelAreaBoundedField::PixelAreaBoundedField ( PixelAreaBoundedField const & )

default

PixelAreaBoundedField() [3/3]

lsst::afw::math::PixelAreaBoundedField::PixelAreaBoundedField ( PixelAreaBoundedField && )

default

Member Function Documentation

addToImage()

template<typename T >

template void lsst::afw::math::BoundedField::addToImage ( image::Image< T > & image, double scaleBy = 1.0, bool overlapOnly = false, int xStep = 1, int yStep = 1 ) const

inherited

Add the field or a constant multiple of it to an image in-place.

Parameters

[out]	image	Image to add to.
[in]	scaleBy	Multiply the field by this before adding it to the image.
[in]	overlapOnly	If true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]	xStep	Distance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]	yStep	Distance between grid points in Y to evaluate; values between grid points will be linearly interpolated.

Exceptions

pex::exceptions::RuntimeError

if the bounding boxes do not overlap and overlapOnly=false.

Definition at line 264 of file BoundedField.cc.

                                               {
    applyToImage(*this, img, ScaledAdd(scaleBy), overlapOnly, xStep, yStep);
}

divideImage()

template<typename T >

template void lsst::afw::math::BoundedField::divideImage ( image::Image< T > & image, bool overlapOnly = false, int xStep = 1, int yStep = 1 ) const

inherited

Divide an image by the field in-place.

Parameters

[out]	image	Image to fill.
[in]	overlapOnly	If true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]	xStep	Distance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]	yStep	Distance between grid points in Y to evaluate; values between grid points will be linearly interpolated.

Exceptions

pex::exceptions::RuntimeError

if the bounding boxes do not overlap and overlapOnly=false.

Definition at line 275 of file BoundedField.cc.

                                                                                               {
    applyToImage(*this, img, Divide(), overlapOnly, xStep, yStep);
}

dynamicCast()

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< BoundedField >::dynamicCast ( std::shared_ptr< Persistable > const & ptr )

staticinherited

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

evaluate() [1/3]

double lsst::afw::math::BoundedField::evaluate ( double x, double y ) const

inlineinherited

Evaluate the field at the given point.

This delegates to the evaluate() method that takes lsst::geom::Point2D.

There is no bounds-checking on the given position; this is the responsibility of the user, who can almost always do it more efficiently.

Definition at line 75 of file BoundedField.h.

{ return evaluate(lsst::geom::Point2D(x, y)); }

evaluate() [2/3]

double lsst::afw::math::PixelAreaBoundedField::evaluate ( lsst::geom::Point2D const & position ) const

overridevirtual

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 64 of file PixelAreaBoundedField.cc.

                                                                            {
    return std::pow(_skyWcs->getPixelScale(position).asRadians(), 2) * _scaling;
}

evaluate() [3/3]

ndarray::Array< double, 1, 1 > lsst::afw::math::PixelAreaBoundedField::evaluate ( ndarray::Array< double const, 1 > const & x, ndarray::Array< double const, 1 > const & y ) const

overridevirtual

Evaluate the field at multiple arbitrary points.

Parameters

[in]	x	array of x coordinates, same shape as y
[in]	y	array of y coordinates, same shape as x

Returns

an array of output values, same shape as x and y

There is no bounds-checking on the given positions; this is the responsibility of the user, who can almost always do it more efficiently.

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

Definition at line 68 of file PixelAreaBoundedField.cc.

        {
    if (x.getShape() != y.getShape()) {
        throw LSST_EXCEPT(
            pex::exceptions::InvalidParameterError,
            (boost::format("Inconsistent shapes in evaluate; %s != %s.") % x.getShape() % y.getShape()).str()
        );
    }
    // Compute _skyWcs->pixelToSky at all of the given points in a single
    // vectorized call, along with points one pixel away in x and y.
    double constexpr side = 1.0;
    std::size_t const n = x.size();
    std::vector<lsst::geom::Point2D> pixPoints;
    pixPoints.reserve(n*3);
    for (std::size_t i = 0; i < n; ++i) {
        pixPoints.emplace_back(x[i], y[i]);
        pixPoints.emplace_back(x[i] + side, y[i]);
        pixPoints.emplace_back(x[i], y[i] + side);
    }
    auto skyPoints = _skyWcs->pixelToSky(pixPoints);
    // Work in 3-space to avoid RA wrapping and pole issues.
    ndarray::Array<double, 1, 1> z = ndarray::allocate(x.getShape());
    for (std::size_t i = 0; i < n; ++i) {
        std::size_t j = i*3;
        auto skyLL = skyPoints[j].getVector();
        auto skyDx = skyPoints[j + 1].getVector() - skyLL;
        auto skyDy = skyPoints[j + 2].getVector() - skyLL;
        double skyAreaSq = skyDx.cross(skyDy).getSquaredNorm();
        z[i] = _scaling * std::sqrt(skyAreaSq) / (side*side);
    }
    return z;
}

fillImage()

template<typename T >

template void lsst::afw::math::BoundedField::fillImage ( image::Image< T > & image, bool overlapOnly = false, int xStep = 1, int yStep = 1 ) const

inherited

Assign the field to an image, overwriting values already present.

Parameters

[out]	image	Image to fill.
[in]	overlapOnly	If true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]	xStep	Distance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]	yStep	Distance between grid points in Y to evaluate; values between grid points will be linearly interpolated.

Exceptions

pex::exceptions::RuntimeError

if the bounding boxes do not overlap and overlapOnly=false.

Definition at line 259 of file BoundedField.cc.

                                                                                             {
    applyToImage(*this, img, Assign(), overlapOnly, xStep, yStep);
}

getBBox()

lsst::geom::Box2I lsst::afw::math::BoundedField::getBBox ( ) const

inlineinherited

Return the bounding box that defines the region where the field is valid.

Because this is an integer bounding box, its minimum and maximum positions are the centers of the pixels where the field is valid, but the field can be assumed to be valid to the edges of those pixels, which is the boundary you'd get by converting the returned lsst::geom::Box2I into a lsst::geom::Box2D.

Definition at line 112 of file BoundedField.h.

{ return _bbox; }

getPersistenceName()

std::string lsst::afw::math::PixelAreaBoundedField::getPersistenceName ( ) const

overrideprotectedvirtual

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 179 of file PixelAreaBoundedField.cc.

                                                          {
    return getPixelAreaBoundedFieldPersistenceName();
}

getPythonModule()

std::string lsst::afw::math::PixelAreaBoundedField::getPythonModule ( ) const

overrideprotectedvirtual

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 183 of file PixelAreaBoundedField.cc.

{ return "lsst.afw.math"; }

integrate()

double lsst::afw::math::BoundedField::integrate ( ) const

virtualinherited

Compute the integral of this function over its bounding-box.

Returns

The value of the integral.

Reimplemented in lsst::afw::math::ChebyshevBoundedField.

Definition at line 49 of file BoundedField.cc.

{ throw LSST_EXCEPT(pex::exceptions::LogicError, "Not Implemented"); }

isPersistable()

bool lsst::afw::math::PixelAreaBoundedField::isPersistable ( ) const

overridevirtualnoexcept

PixelAreaBoundedField is persistable if and only if the nested SkyWcs is.

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

Definition at line 103 of file PixelAreaBoundedField.cc.

                                                         {
    return _skyWcs->isPersistable();
}

mean()

double lsst::afw::math::BoundedField::mean ( ) const

virtualinherited

Compute the mean of this function over its bounding-box.

Returns

The value of the mean.

Reimplemented in lsst::afw::math::ChebyshevBoundedField.

Definition at line 51 of file BoundedField.cc.

{ throw LSST_EXCEPT(pex::exceptions::LogicError, "Not Implemented"); }

multiplyImage()

template<typename T >

template void lsst::afw::math::BoundedField::multiplyImage ( image::Image< T > & image, bool overlapOnly = false, int xStep = 1, int yStep = 1 ) const

inherited

Multiply an image by the field in-place.

Parameters

[out]	image	Image to fill.
[in]	overlapOnly	If true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]	xStep	Distance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]	yStep	Distance between grid points in Y to evaluate; values between grid points will be linearly interpolated.

Exceptions

pex::exceptions::RuntimeError

if the bounding boxes do not overlap and overlapOnly=false.

Definition at line 270 of file BoundedField.cc.

                                                                                                 {
    applyToImage(*this, img, Multiply(), overlapOnly, xStep, yStep);
}

operator!=()

bool lsst::afw::math::BoundedField::operator!= ( BoundedField const & rhs ) const

inlineinherited

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

Definition at line 195 of file BoundedField.h.

{ return !(*this == rhs); };

operator*()

std::shared_ptr< BoundedField > lsst::afw::math::PixelAreaBoundedField::operator* ( double const scale ) const

overridevirtual

Return a scaled BoundedField.

Parameters

[in]

scale

Scaling factor

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

Definition at line 107 of file PixelAreaBoundedField.cc.

                                                                                     {
    return std::make_shared<PixelAreaBoundedField>(getBBox(), _skyWcs, lsst::geom::radians, _scaling*scale);
}

operator/()

std::shared_ptr< BoundedField > lsst::afw::math::BoundedField::operator/ ( double scale ) const

inlineinherited

Definition at line 190 of file BoundedField.h.

{ return (*this) * (1.0 / scale); }

operator=() [1/2]

PixelAreaBoundedField & lsst::afw::math::PixelAreaBoundedField::operator= ( PixelAreaBoundedField && )

delete

operator=() [2/2]

PixelAreaBoundedField & lsst::afw::math::PixelAreaBoundedField::operator= ( PixelAreaBoundedField const & )

delete

operator==()

bool lsst::afw::math::PixelAreaBoundedField::operator== ( BoundedField const & rhs ) const

overridevirtual

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

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

Definition at line 111 of file PixelAreaBoundedField.cc.

                                                                    {
    auto rhsCasted = dynamic_cast<PixelAreaBoundedField const *>(&rhs);
    if (!rhsCasted) return false;
 
    return getBBox() == rhsCasted->getBBox() && *_skyWcs == *rhsCasted->_skyWcs &&
        _scaling == rhsCasted->_scaling;
}

readFits() [1/3]

static std::shared_ptr< BoundedField > lsst::afw::table::io::PersistableFacade< BoundedField >::readFits ( fits::Fits & fitsfile )

inlinestaticinherited

Read an object from an already open FITS object.

Parameters

[in]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

readFits() [2/3]

static std::shared_ptr< BoundedField > lsst::afw::table::io::PersistableFacade< BoundedField >::readFits ( fits::MemFileManager & manager, int hdu = fits::DEFAULT_HDU )

inlinestaticinherited

Read an object from a FITS file in memory.

Parameters

[in]	manager	Manager for the memory to read from.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

readFits() [3/3]

static std::shared_ptr< BoundedField > lsst::afw::table::io::PersistableFacade< BoundedField >::readFits ( std::string const & fileName, int hdu = fits::DEFAULT_HDU )

inlinestaticinherited

Read an object from a regular FITS file.

Parameters

[in]	fileName	Name of the file to read.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

toString()

std::string lsst::afw::math::PixelAreaBoundedField::toString ( ) const

overrideprivatevirtual

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

Definition at line 119 of file PixelAreaBoundedField.cc.

                                                {
    std::ostringstream os;
    os << "PixelAreaBoundedField(" << (*_skyWcs) << ", scaling=" << _scaling << ")";
    return os.str();
}

write()

void lsst::afw::math::PixelAreaBoundedField::write ( OutputArchiveHandle & handle ) const

overrideprotectedvirtual

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 185 of file PixelAreaBoundedField.cc.

                                                                   {
    auto const & keys = PersistenceHelper::get();
    table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
    std::shared_ptr<table::BaseRecord> record = catalog.addNew();
    record->set(keys.bbox, getBBox());
    record->set(keys.wcs, handle.put(_skyWcs));
    record->set(keys.scaling, _scaling);
    handle.saveCatalog(catalog);
}

writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits & fitsfile ) const

inherited

Write the object to an already-open FITS object.

Parameters

[in]

fitsfile

Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                    {
    OutputArchive archive;
    archive.put(this);
    archive.writeFits(fitsfile);
}

writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager & manager, std::string const & mode = "w" ) const

inherited

Write the object to a FITS image in memory.

Parameters

[in]	manager	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

                                                                                    {
    fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const & fileName, std::string const & mode = "w" ) const

inherited

Write the object to a regular FITS file.

Parameters

[in]	fileName	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

                                                                                  {
    fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/math/PixelAreaBoundedField.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/math/PixelAreaBoundedField.cc