lsst.afw gd599963eb3+914da4f383
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.

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.

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

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

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

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

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

◆ getNX()

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

Definition at line 371 of file Convolve.h.

◆ getNY()

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

Definition at line 372 of file Convolve.h.

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

◆ getYInd()

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

Definition at line 373 of file Convolve.h.

◆ hasData()

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

Definition at line 380 of file Convolve.h.

◆ incrYInd()

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

Definition at line 382 of file Convolve.h.

◆ isLastRow()

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

Definition at line 381 of file Convolve.h.


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