LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
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.
 
RegionList::const_iterator begin () const
 Return the begin iterator for the list.
 
RegionList::const_iterator end () const
 Return the end iterator for the list.
 
RegionList::iterator begin ()
 Return the begin iterator for the list.
 
RegionList::iterator end ()
 Return the end iterator for the list.
 
std::shared_ptr< KernelImagesForRegionfront ()
 Return the first region in the list.
 
std::shared_ptr< KernelImagesForRegionback ()
 Return the last region in the list.
 
int getNX () const
 
int getNY () const
 
int getYInd () const
 
std::shared_ptr< KernelImagesForRegion const > getRegion (int ind) const
 get the specified region (range-checked)
 
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: