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

A row of KernelImagesForRegion. More...

#include <Convolve.h>

Public Types
typedef std::vector< std::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...
std::shared_ptr< KernelImagesForRegion >	front ()
	Return the first region in the list. More...
std::shared_ptr< KernelImagesForRegion >	back ()
	Return the last region in the list. More...
int	getNX () const
int	getNY () const
int	getYInd () const
std::shared_ptr< KernelImagesForRegion const >	getRegion (int ind) const
	get the specified region (range-checked) More...
bool	hasData () const
bool	isLastRow () const
int	incrYInd ()

Detailed Description

A row of KernelImagesForRegion.

Intended for iterating over subregions of a KernelImagesForRegion using computeNextRow.

Definition at line 334 of file Convolve.h.

Member Typedef Documentation

ConstIterator

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

Definition at line 338 of file Convolve.h.

Iterator

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

Definition at line 337 of file Convolve.h.

RegionList

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

Definition at line 336 of file Convolve.h.

Constructor & Destructor Documentation

RowOfKernelImagesForRegion()

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 227 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

back()

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

inline

Return the last region in the list.

Definition at line 370 of file Convolve.h.

{ return _regionList.back(); };

begin() [1/2]

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

inline

Return the begin iterator for the list.

Definition at line 358 of file Convolve.h.

{ return _regionList.begin(); };

begin() [2/2]

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

inline

Return the begin iterator for the list.

Definition at line 350 of file Convolve.h.

{ return _regionList.begin(); };

end() [1/2]

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

inline

Return the end iterator for the list.

Definition at line 362 of file Convolve.h.

{ return _regionList.end(); };

end() [2/2]

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

inline

Return the end iterator for the list.

Definition at line 354 of file Convolve.h.

{ return _regionList.end(); };

front()

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

inline

Return the first region in the list.

Definition at line 366 of file Convolve.h.

{ return _regionList.front(); };

getNX()

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

inline

Definition at line 371 of file Convolve.h.

{ return _nx; };

getNY()

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

inline

Definition at line 372 of file Convolve.h.

{ return _ny; };

getRegion()

std::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 379 of file Convolve.h.

{ return _regionList.at(ind); };

getYInd()

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

inline

Definition at line 373 of file Convolve.h.

{ return _yInd; };

hasData()

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

inline

Definition at line 380 of file Convolve.h.

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

incrYInd()

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

inline

Definition at line 382 of file Convolve.h.

{ return ++_yInd; };

isLastRow()

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

inline

Definition at line 381 of file Convolve.h.

{ return _yInd + 1 >= _ny; };

---

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

• /j/snowflake/release/lsstsw/stack/0.4.3/Linux64/afw/21.0.0-25-g1d57be3cd+e73869a214/include/lsst/afw/math/detail/Convolve.h
• /j/snowflake/release/lsstsw/stack/0.4.3/Linux64/afw/21.0.0-25-g1d57be3cd+e73869a214/src/math/detail/KernelImagesForRegion.cc