itkMaskFeaturePointSelectionFilter.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 itkMaskFeaturePointSelectionFilter_h
#define itkMaskFeaturePointSelectionFilter_h
 
#include "itkImageToMeshFilter.h"
#include "itkDefaultDynamicMeshTraits.h"
#include "itkImage.h"
#include "itkPointSet.h"
#include "itkImageRegionConstIterator.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkMatrix.h"
#include "itkConceptChecking.h"
#include <vector>
 
 
namespace itk
{
 
template <typename TImage,
          typename TMask = TImage,
          typename TFeatures = PointSet<Matrix<SpacePrecisionType, TImage::ImageDimension, TImage::ImageDimension>,
                                        TImage::ImageDimension>>
class ITK_TEMPLATE_EXPORT MaskFeaturePointSelectionFilter : public ImageToMeshFilter<TImage, TFeatures>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MaskFeaturePointSelectionFilter);

  using Superclass = ImageToMeshFilter<TImage, TFeatures>;
  using Self = MaskFeaturePointSelectionFilter;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MaskFeaturePointSelectionFilter);
 
  static constexpr unsigned int ImageDimension = 3u;

  using RegionType = ImageRegion<ImageDimension>;
  using SizeType = Size<ImageDimension>;
  using IndexType = Index<ImageDimension>;
  using OffsetType = Offset<ImageDimension>;

  using ImageType = TImage;
  using ImageConstPointer = typename ImageType::ConstPointer;
  using ImagePixelType = typename ImageType::PixelType;

  using MaskType = TMask;
  using MaskConstPointer = typename MaskType::ConstPointer;
  using MaskPixelType = typename MaskType::PixelType;

  using FeaturePointsType = TFeatures;
  using FeaturePointsPointer = typename FeaturePointsType::Pointer;
  using StructureTensorType = typename FeaturePointsType::PixelType;
  using PointType = typename FeaturePointsType::PointType;

  enum
  {
    VERTEX_CONNECTIVITY = 0,
    EDGE_CONNECTIVITY = 1,
    FACE_CONNECTIVITY = 2
  };

  itkSetMacro(NonConnectivity, unsigned int);
  itkGetMacro(NonConnectivity, unsigned int);

  itkSetInputMacro(MaskImage, MaskType);
  itkGetInputMacro(MaskImage, MaskType);

  itkSetMacro(BlockRadius, SizeType);
  itkGetConstReferenceMacro(BlockRadius, SizeType);

  itkSetMacro(ComputeStructureTensors, bool);
  itkGetMacro(ComputeStructureTensors, bool);
  itkBooleanMacro(ComputeStructureTensors);

  itkSetClampMacro(SelectFraction, double, 0, 1);
  itkGetMacro(SelectFraction, double);
 
  itkConceptMacro(ImageDimensionShouldBe3, (Concept::SameDimension<TImage::ImageDimension, 3u>));
  itkConceptMacro(MaskDimensionShouldBe3, (Concept::SameDimension<TMask::ImageDimension, 3u>));
  itkConceptMacro(PointDimensionShouldBe3, (Concept::SameDimension<TFeatures::PointType::PointDimension, 3u>));
 
protected:
  MaskFeaturePointSelectionFilter();
  ~MaskFeaturePointSelectionFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateData() override;

  void
  ComputeConnectivityOffsets();
 
private:
  unsigned int            m_NonConnectivity{};
  std::vector<OffsetType> m_NonConnectivityOffsets{};
  SizeType                m_BlockRadius{};
  double                  m_SelectFraction{};
  bool                    m_ComputeStructureTensors{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMaskFeaturePointSelectionFilter.hxx"
#endif
 
#endif