LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | List of all members
lsst::afw::math::detail::RowOfKernelImagesForRegion Class Referencefinal

A row of KernelImagesForRegion. More...

#include <Convolve.h>

Public Types

using RegionList = std::vector< std::shared_ptr< KernelImagesForRegion > >
 
using Iterator = RegionList::iterator
 
using ConstIterator = RegionList::const_iterator
 

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< KernelImagesForRegionfront ()
 Return the first region in the list. More...
 
std::shared_ptr< KernelImagesForRegionback ()
 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

Definition at line 338 of file Convolve.h.

◆ Iterator

Definition at line 337 of file Convolve.h.

◆ 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
nxnumber of columns
nynumber of rows

Definition at line 221 of file KernelImagesForRegion.cc.

222  : _nx(nx), _ny(ny), _yInd(-1), _regionList(nx) {
223  if ((nx < 1) || (ny < 1)) {
225  os << "nx = " << nx << " and/or ny = " << ny << " < 1";
227  };
228 }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
std::ostream * os
Definition: Schema.cc:557
Reports invalid arguments.
Definition: Runtime.h:66

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.

370 { return _regionList.back(); };
T back(T... args)

◆ 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.

358 { return _regionList.begin(); };
T begin(T... args)

◆ 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.

350 { 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.

362 { return _regionList.end(); };
T end(T... args)

◆ 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.

354 { 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.

366 { return _regionList.front(); };
T front(T... args)

◆ getNX()

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

Definition at line 371 of file Convolve.h.

371 { return _nx; };

◆ getNY()

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

Definition at line 372 of file Convolve.h.

372 { 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_errorif ind out of range

Definition at line 379 of file Convolve.h.

379 { return _regionList.at(ind); };
T at(T... args)

◆ getYInd()

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

Definition at line 373 of file Convolve.h.

373 { return _yInd; };

◆ hasData()

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

Definition at line 380 of file Convolve.h.

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

◆ incrYInd()

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

Definition at line 382 of file Convolve.h.

382 { return ++_yInd; };

◆ isLastRow()

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

Definition at line 381 of file Convolve.h.

381 { return _yInd + 1 >= _ny; };

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