mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
Loading...
Searching...
No Matches
mx::improc::precalcKernel< kernelT > Struct Template Reference

template<class kernelT>
struct mx::improc::precalcKernel< kernelT >

A kernel that is pre-calculated for the entire image, useful for repeated applications.

Use this for spatially variable kernels. It is not needed for, e.g., the symmetric Gaussian.

Template Parameters
kernelTis the kernel type. See above for the requirements on kernelT.

Definition at line 315 of file imageFilters.hpp.

#include <improc/imageFilters.hpp>

Public Member Functions

 precalcKernel (const kernelT &kernel, uint32_t rows, uint32_t cols, arithT xcen, arithT ycen)
 
error_t setKernel (arithT x, arithT y, arrayT &kernel) const
 

Constructor & Destructor Documentation

◆ precalcKernel()

template<class kernelT >
mx::improc::precalcKernel< kernelT >::precalcKernel ( const kernelT &  kernel,
uint32_t  rows,
uint32_t  cols,
arithT  xcen,
arithT  ycen 
)
inline
Parameters
[in]kernelA fully initialized kernel. Is copied.
[in]rowsThe rows in the images to be filtered
[in]colsThe columns in the images to be filtered
[in]xcenThe pixel x-coordinate of the center of the image
[in]ycenThe pixel y-coordinate of the center of the image

Definition at line 334 of file imageFilters.hpp.

Member Function Documentation

◆ setKernel()

template<class kernelT >
error_t mx::improc::precalcKernel< kernelT >::setKernel ( arithT  x,
arithT  y,
arrayT &  kernel 
) const
inline
Parameters
[in]xx-coordinate relative to image center
[in]yx-coordinate relative to image center
[in]kernelthe array to populate with the kernel, resized

Definition at line 361 of file imageFilters.hpp.

References mx::invalidarg, mx::invalidconfig, and mx::noerror.


The documentation for this struct was generated from the following file: