lsst::afw::math::detail::RowOfKernelImagesForRegion Class Reference

A row of KernelImagesForRegion. More...

#include <Convolve.h>

Public Types
typedef std::vector < boost::shared_ptr < KernelImagesForRegion > >	RegionList
typedef RegionList::iterator	Iterator
typedef RegionList::const_iterator	ConstIterator

Public Member Functions
	RowOfKernelImagesForRegion (int nx, int ny)
	Construct a RowOfKernelImagesForRegion. More...
RegionList::const_iterator	begin () const
	Return the begin iterator for the list. More...
RegionList::const_iterator	end () const
	Return the end iterator for the list. More...
RegionList::iterator	begin ()
	Return the begin iterator for the list. More...
RegionList::iterator	end ()
	Return the end iterator for the list. More...
boost::shared_ptr < KernelImagesForRegion >	front ()
	Return the first region in the list. More...
boost::shared_ptr < KernelImagesForRegion >	back ()
	Return the last region in the list. More...
int	getNX () const
int	getNY () const
int	getYInd () const
boost::shared_ptr < KernelImagesForRegion const >	getRegion (int ind) const
	get the specified region (range-checked) More...
bool	hasData () const
bool	isLastRow () const
int	incrYInd ()

Private Attributes
int	_nx
int	_ny
int	_yInd
RegionList	_regionList

Detailed Description

A row of KernelImagesForRegion.

Intended for iterating over subregions of a KernelImagesForRegion using computeNextRow.

Definition at line 205 of file Convolve.h.

Member Typedef Documentation

typedef RegionList::const_iterator lsst::afw::math::detail::RowOfKernelImagesForRegion::ConstIterator

Definition at line 209 of file Convolve.h.

typedef RegionList::iterator lsst::afw::math::detail::RowOfKernelImagesForRegion::Iterator

Definition at line 208 of file Convolve.h.

typedef std::vector<boost::shared_ptr< KernelImagesForRegion > > lsst::afw::math::detail::RowOfKernelImagesForRegion::RegionList

Definition at line 207 of file Convolve.h.

Constructor & Destructor Documentation

lsst::afw::math::detail::RowOfKernelImagesForRegion::RowOfKernelImagesForRegion	(	int	nx,
		int	ny
	)

Construct a RowOfKernelImagesForRegion.

Parameters

nx	number of columns
ny	number of rows

Definition at line 335 of file KernelImagesForRegion.cc.

:
    _nx(nx),
    _ny(ny),
    _yInd(-1),
    _regionList(nx)
{
    if ((nx < 1) || (ny < 1)) {
        std::ostringstream os;
        os << "nx = " << nx << " and/or ny = " << ny << " < 1";
        throw LSST_EXCEPT(pexExcept::InvalidParameterError, os.str());
    };
}

Member Function Documentation

boost::shared_ptr< KernelImagesForRegion > lsst::afw::math::detail::RowOfKernelImagesForRegion::back ( )

inline

Return the last region in the list.

Definition at line 235 of file Convolve.h.

{ return _regionList.back(); };

RegionList::const_iterator lsst::afw::math::detail::RowOfKernelImagesForRegion::begin ( ) const

inline

Return the begin iterator for the list.

Definition at line 215 of file Convolve.h.

{ return _regionList.begin(); };

RegionList::iterator lsst::afw::math::detail::RowOfKernelImagesForRegion::begin ( )

inline

Return the begin iterator for the list.

Definition at line 223 of file Convolve.h.

{ return _regionList.begin(); };

RegionList::const_iterator lsst::afw::math::detail::RowOfKernelImagesForRegion::end ( ) const

inline

Return the end iterator for the list.

Definition at line 219 of file Convolve.h.

{ return _regionList.end(); };

RegionList::iterator lsst::afw::math::detail::RowOfKernelImagesForRegion::end ( )

inline

Return the end iterator for the list.

Definition at line 227 of file Convolve.h.

{ return _regionList.end(); };

boost::shared_ptr< KernelImagesForRegion > lsst::afw::math::detail::RowOfKernelImagesForRegion::front ( )

inline

Return the first region in the list.

Definition at line 231 of file Convolve.h.

{ return _regionList.front(); };

int lsst::afw::math::detail::RowOfKernelImagesForRegion::getNX ( ) const

inline

Definition at line 236 of file Convolve.h.

{ return _nx; };

int lsst::afw::math::detail::RowOfKernelImagesForRegion::getNY ( ) const

inline

Definition at line 237 of file Convolve.h.

{ return _ny; };

boost::shared_ptr< KernelImagesForRegion const> lsst::afw::math::detail::RowOfKernelImagesForRegion::getRegion ( int  ind ) const

inline

get the specified region (range-checked)

Exceptions

std::range_error

if ind out of range

Definition at line 244 of file Convolve.h.

{ return _regionList.at(ind); };

int lsst::afw::math::detail::RowOfKernelImagesForRegion::getYInd ( ) const

inline

Definition at line 238 of file Convolve.h.

{ return _yInd; };

bool lsst::afw::math::detail::RowOfKernelImagesForRegion::hasData ( ) const

inline

Definition at line 245 of file Convolve.h.

{ return static_cast<bool>(_regionList[0]); };

int lsst::afw::math::detail::RowOfKernelImagesForRegion::incrYInd ( )

inline

Definition at line 247 of file Convolve.h.

{ return ++_yInd; };

bool lsst::afw::math::detail::RowOfKernelImagesForRegion::isLastRow ( ) const

inline

Definition at line 246 of file Convolve.h.

{ return _yInd + 1 >= _ny; };

Member Data Documentation

int lsst::afw::math::detail::RowOfKernelImagesForRegion::_nx

private

Definition at line 247 of file Convolve.h.

int lsst::afw::math::detail::RowOfKernelImagesForRegion::_ny

private

Definition at line 251 of file Convolve.h.

RegionList lsst::afw::math::detail::RowOfKernelImagesForRegion::_regionList

private

Definition at line 253 of file Convolve.h.

int lsst::afw::math::detail::RowOfKernelImagesForRegion::_yInd

private

Definition at line 252 of file Convolve.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/math/detail/Convolve.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/math/detail/KernelImagesForRegion.cc