ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation > Class Template Reference

#include <itkNeighborhoodInnerProduct.h>

Detailed Description

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
class itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >

Defines the inner product operation between an Neighborhood and a NeighborhoodOperator.

This class defines the inner product operation between an itk::Neighborhood and an itk::NeighborhoodOperator. The operator() method is overloaded to support various types of neighborhoods as well as inner products with slices of neighborhoods.

Template Parameters
TImageType of image on which the class operates.
TOperatorThe value type of the operator (defaults to the image pixel type).
TComputationThe value type used as the return type of the inner product calculation (defaults to the operator type).

Definition at line 48 of file itkNeighborhoodInnerProduct.h.

Public Types

using ImagePixelType = typename TImage::PixelType
 
using NeighborhoodType = Neighborhood< ImagePixelType, Self::ImageDimension >
 
using OperatorPixelType = TOperator
 
using OperatorType = Neighborhood< OperatorPixelType, Self::ImageDimension >
 
using OutputPixelType = TComputation
 
using Self = NeighborhoodInnerProduct
 

Public Member Functions

OutputPixelType operator() (const ConstNeighborhoodIterator< TImage > &it, const OperatorType &op) const
 
OutputPixelType operator() (const NeighborhoodType &N, const OperatorType &op) const
 
OutputPixelType operator() (const std::slice &s, const ConstNeighborhoodIterator< TImage > &it, const OperatorType &op) const
 
OutputPixelType operator() (const std::slice &s, const NeighborhoodType &N, const OperatorType &op) const
 

Static Public Member Functions

static OutputPixelType Compute (const ConstNeighborhoodIterator< TImage > &it, const OperatorType &op, const unsigned int start=0, const unsigned int stride=1)
 
static OutputPixelType Compute (const NeighborhoodType &N, const OperatorType &op, const unsigned int start=0, const unsigned int stride=1)
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TImage::ImageDimension
 

Member Typedef Documentation

◆ ImagePixelType

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
using itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::ImagePixelType = typename TImage::PixelType

Capture some type alias from the template parameters.

Definition at line 55 of file itkNeighborhoodInnerProduct.h.

◆ NeighborhoodType

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
using itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::NeighborhoodType = Neighborhood<ImagePixelType, Self::ImageDimension>

Definition at line 65 of file itkNeighborhoodInnerProduct.h.

◆ OperatorPixelType

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
using itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::OperatorPixelType = TOperator

Definition at line 56 of file itkNeighborhoodInnerProduct.h.

◆ OperatorType

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
using itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::OperatorType = Neighborhood<OperatorPixelType, Self::ImageDimension>

Operator type alias

Definition at line 63 of file itkNeighborhoodInnerProduct.h.

◆ OutputPixelType

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
using itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::OutputPixelType = TComputation

Definition at line 57 of file itkNeighborhoodInnerProduct.h.

◆ Self

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
using itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::Self = NeighborhoodInnerProduct

Standard type alias

Definition at line 52 of file itkNeighborhoodInnerProduct.h.

Member Function Documentation

◆ Compute() [1/2]

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
static OutputPixelType itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::Compute ( const ConstNeighborhoodIterator< TImage > &  it,
const OperatorType op,
const unsigned int  start = 0,
const unsigned int  stride = 1 
)
static

◆ Compute() [2/2]

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
static OutputPixelType itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::Compute ( const NeighborhoodType N,
const OperatorType op,
const unsigned int  start = 0,
const unsigned int  stride = 1 
)
static

◆ operator()() [1/4]

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
OutputPixelType itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::operator() ( const ConstNeighborhoodIterator< TImage > &  it,
const OperatorType op 
) const
inline

Definition at line 87 of file itkNeighborhoodInnerProduct.h.

◆ operator()() [2/4]

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
OutputPixelType itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::operator() ( const NeighborhoodType N,
const OperatorType op 
) const
inline

Definition at line 99 of file itkNeighborhoodInnerProduct.h.

◆ operator()() [3/4]

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
OutputPixelType itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::operator() ( const std::slice &  s,
const ConstNeighborhoodIterator< TImage > &  it,
const OperatorType op 
) const
inline

Reference oeprator.

Definition at line 81 of file itkNeighborhoodInnerProduct.h.

◆ operator()() [4/4]

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
OutputPixelType itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::operator() ( const std::slice &  s,
const NeighborhoodType N,
const OperatorType op 
) const
inline

Definition at line 93 of file itkNeighborhoodInnerProduct.h.

Member Data Documentation

◆ ImageDimension

template<typename TImage, typename TOperator = typename TImage::PixelType, typename TComputation = TOperator>
constexpr unsigned int itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::ImageDimension = TImage::ImageDimension
staticconstexpr

Capture some type alias from the template parameters.

Definition at line 60 of file itkNeighborhoodInnerProduct.h.


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