itkSpatialNeighborSubsampler.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 itkSpatialNeighborSubsampler_h
#define itkSpatialNeighborSubsampler_h
 
#include "itkRegionConstrainedSubsampler.h"
#include "itkImageHelper.h"
 
namespace itk::Statistics
{
 
template <typename TSample, typename TRegion>
class ITK_TEMPLATE_EXPORT SpatialNeighborSubsampler : public RegionConstrainedSubsampler<TSample, TRegion>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SpatialNeighborSubsampler);

  using Self = SpatialNeighborSubsampler<TSample, TRegion>;
  using Superclass = RegionConstrainedSubsampler<TSample, TRegion>;
  using Baseclass = typename Superclass::Baseclass;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(SpatialNeighborSubsampler);

  itkNewMacro(Self);

  using typename Superclass::SampleType;
  using typename Superclass::SampleConstPointer;
  using typename Superclass::MeasurementVectorType;
  using typename Superclass::InstanceIdentifier;
 
  using typename Superclass::SubsampleType;
  using typename Superclass::SubsamplePointer;
  using typename Superclass::SubsampleConstIterator;
  using typename Superclass::InstanceIdentifierHolder;

  using typename Superclass::RegionType;
  using typename Superclass::IndexType;
  using typename Superclass::IndexValueType;
  using typename Superclass::SizeType;
  using RadiusType = typename RegionType::SizeType;
 
  static constexpr unsigned int ImageDimension = RegionType::ImageDimension;
  using ImageHelperType = ImageHelper<Self::ImageDimension, Self::ImageDimension>;

  void
  SetRadius(const RadiusType & radius);
  void
  SetRadius(unsigned int radius);
  itkGetConstReferenceMacro(Radius, RadiusType);

  itkGetConstReferenceMacro(RadiusInitialized, bool);

  void
  Search(const InstanceIdentifier & query, SubsamplePointer & results) override;
 
protected:
  [[nodiscard]] typename LightObject::Pointer
  InternalClone() const override;
 
  SpatialNeighborSubsampler();
  ~SpatialNeighborSubsampler() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  RadiusType m_Radius{};
  bool       m_RadiusInitialized{};
}; // end of class SpatialNeighborSubsampler
 
} // namespace itk::Statistics
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSpatialNeighborSubsampler.hxx"
#endif
 
#endif