NumCpp  2.12.1
A Templatized Header Only C++ Implementation of the Python NumPy Library
nc::imageProcessing::ClusterMaker< dtype > Class Template Reference

Clusters exceedance data into contiguous groups. More...

#include <ClusterMaker.hpp>

Public Types

using const_iterator = typename std::vector< Cluster< dtype > >::const_iterator
 

Public Member Functions

 ClusterMaker (const NdArray< bool > *const inXcdArrayPtr, const NdArray< dtype > *const inIntensityArrayPtr, uint8 inBorderWidth=0)
 
const Cluster< dtype > & at (uint32 inIndex) const
 
const_iterator begin () const noexcept
 
const_iterator end () const noexcept
 
const Cluster< dtype > & operator[] (uint32 inIndex) const noexcept
 
uint32 size () noexcept
 

Detailed Description

template<typename dtype>
class nc::imageProcessing::ClusterMaker< dtype >

Clusters exceedance data into contiguous groups.

Member Typedef Documentation

◆ const_iterator

template<typename dtype >
using nc::imageProcessing::ClusterMaker< dtype >::const_iterator = typename std::vector<Cluster<dtype> >::const_iterator

Constructor & Destructor Documentation

◆ ClusterMaker()

template<typename dtype >
nc::imageProcessing::ClusterMaker< dtype >::ClusterMaker ( const NdArray< bool > *const  inXcdArrayPtr,
const NdArray< dtype > *const  inIntensityArrayPtr,
uint8  inBorderWidth = 0 
)
inline

constructor

Parameters
inXcdArrayPtrpointer to exceedance array
inIntensityArrayPtrpointer to intensity array
inBorderWidthborder to apply around exceedance pixels post clustering (default 0)

Member Function Documentation

◆ at()

template<typename dtype >
const Cluster< dtype > & nc::imageProcessing::ClusterMaker< dtype >::at ( uint32  inIndex) const
inline

access method with bounds checking

Parameters
inIndex
Returns
Cluster

◆ begin()

template<typename dtype >
const_iterator nc::imageProcessing::ClusterMaker< dtype >::begin ( ) const
inlinenoexcept

returns in iterator to the beginning cluster of the container

Returns
const_iterator

◆ end()

template<typename dtype >
const_iterator nc::imageProcessing::ClusterMaker< dtype >::end ( ) const
inlinenoexcept

returns in iterator to the 1 past the end cluster of the container

Returns
const_iterator

◆ operator[]()

template<typename dtype >
const Cluster< dtype > & nc::imageProcessing::ClusterMaker< dtype >::operator[] ( uint32  inIndex) const
inlinenoexcept

access operator, no bounds checking

Parameters
inIndex
Returns
Cluster

◆ size()

template<typename dtype >
uint32 nc::imageProcessing::ClusterMaker< dtype >::size ( )
inlinenoexcept

returns the number of clusters in the frame

Returns
number of clusters

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