itkBinaryCrossStructuringElement.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkBinaryCrossStructuringElement_h
#define itkBinaryCrossStructuringElement_h
 
#include "itkNeighborhood.h"
 
namespace itk
{
 
template <typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
class ITK_TEMPLATE_EXPORT BinaryCrossStructuringElement : public Neighborhood<TPixel, VDimension, TAllocator>
{
public:
  using Self = BinaryCrossStructuringElement;
  using Superclass = Neighborhood<TPixel, VDimension, TAllocator>;

  using AllocatorType = TAllocator;

  static constexpr unsigned int NeighborhoodDimension = VDimension;

  using PixelType = TPixel;

  using Iterator = typename AllocatorType::iterator;
  using ConstIterator = typename AllocatorType::const_iterator;

  using typename Superclass::SizeType;
  using typename Superclass::SizeValueType;

  using typename Superclass::OffsetType;
  using OffsetValueType = typename OffsetType::OffsetValueType;

  using typename Superclass::RadiusType;

  using SliceIteratorType = SliceIterator<TPixel, Self>;

  BinaryCrossStructuringElement()
  {
    // Default structuring element is defined to be 3x3x3...
    constexpr auto radius = MakeFilled<RadiusType>(1);
    Self::SetRadius(radius);
    Self::CreateStructuringElement();
  }


  ~BinaryCrossStructuringElement() override = default;

  BinaryCrossStructuringElement(const Self & other)
    : Neighborhood<TPixel, VDimension, TAllocator>(other)
  {}

  Self &
  operator=(const Self & other)
  {
    Superclass::operator=(other);
    return *this;
  }


  void
  CreateStructuringElement();
 
protected:
private:
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBinaryCrossStructuringElement.hxx"
#endif
 
#endif