mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
mx::improc::azBoxKernel< _arrayT, _kernW > Struct Template Reference

template<typename _arrayT, size_t _kernW = 2>
struct mx::improc::azBoxKernel< _arrayT, _kernW >

Azimuthally variable boxcare kernel.

Averages the image in a boxcare defined by a radial and azimuthal extent.

Definition at line 90 of file imageFilters.hpp.

#include <improc/imageFilters.hpp>

Public Member Functions

 azBoxKernel (arithT radWidth, arithT azWidth)
 
 azBoxKernel (arithT radWidth, arithT azWidth, arithT maxAz)
 
void setMaxWidth ()
 Sets the max width based on the configured az and rad widths. More...
 

Public Attributes

arithT m_radWidth {0}
 the half-width of the averaging box, in the radial direction, in pixels. More...
 
arithT m_azWidth {0}
 the half-width of the averaging box, in the azimuthal direction, in pixels. More...
 
arithT m_maxAz {0}
 the maximum half-width of the averging box in the azimuthal direction, in degrees. >= 0. If 0 or >= 180, then no maximum is enforced. More...
 

Constructor & Destructor Documentation

◆ azBoxKernel() [1/2]

template<typename _arrayT , size_t _kernW = 2>
mx::improc::azBoxKernel< _arrayT, _kernW >::azBoxKernel ( arithT  radWidth,
arithT  azWidth 
)
inline
Parameters
[in]radWidththe half-width of the averaging box, in the radial direction, in pixels.
[in]azWidththe half-width of the averaging box, in the azimuthal direction, in pixels.

Definition at line 103 of file imageFilters.hpp.

References mx::improc::azBoxKernel< _arrayT, _kernW >::setMaxWidth().

◆ azBoxKernel() [2/2]

template<typename _arrayT , size_t _kernW = 2>
mx::improc::azBoxKernel< _arrayT, _kernW >::azBoxKernel ( arithT  radWidth,
arithT  azWidth,
arithT  maxAz 
)
inline
Parameters
[in]radWidththe half-width of the averaging box, in the radial direction, in pixels.
[in]azWidththe half-width of the averaging box, in the azimuthal direction, in pixels.
[in]maxAzthe maximum half-width of the averging box in the azimuthal direction, in degrees. >= 0. If 0 or >= 180, then no maximum is enforced.

Definition at line 110 of file imageFilters.hpp.

References mx::math::dtor(), mx::improc::azBoxKernel< _arrayT, _kernW >::m_maxAz, and mx::improc::azBoxKernel< _arrayT, _kernW >::setMaxWidth().

Member Function Documentation

◆ setMaxWidth()

template<typename _arrayT , size_t _kernW = 2>
void mx::improc::azBoxKernel< _arrayT, _kernW >::setMaxWidth ( )
inline

Sets the max width based on the configured az and rad widths.

Definition at line 125 of file imageFilters.hpp.

References mx::improc::azBoxKernel< _arrayT, _kernW >::m_azWidth, and mx::improc::azBoxKernel< _arrayT, _kernW >::m_radWidth.

Referenced by mx::improc::azBoxKernel< _arrayT, _kernW >::azBoxKernel().

Member Data Documentation

◆ m_azWidth

template<typename _arrayT , size_t _kernW = 2>
arithT mx::improc::azBoxKernel< _arrayT, _kernW >::m_azWidth {0}

the half-width of the averaging box, in the azimuthal direction, in pixels.

Definition at line 98 of file imageFilters.hpp.

Referenced by mx::improc::azBoxKernel< _arrayT, _kernW >::setMaxWidth().

◆ m_maxAz

template<typename _arrayT , size_t _kernW = 2>
arithT mx::improc::azBoxKernel< _arrayT, _kernW >::m_maxAz {0}

the maximum half-width of the averging box in the azimuthal direction, in degrees. >= 0. If 0 or >= 180, then no maximum is enforced.

Definition at line 99 of file imageFilters.hpp.

Referenced by mx::improc::azBoxKernel< _arrayT, _kernW >::azBoxKernel().

◆ m_radWidth

template<typename _arrayT , size_t _kernW = 2>
arithT mx::improc::azBoxKernel< _arrayT, _kernW >::m_radWidth {0}

the half-width of the averaging box, in the radial direction, in pixels.

Definition at line 97 of file imageFilters.hpp.

Referenced by mx::improc::azBoxKernel< _arrayT, _kernW >::setMaxWidth().


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