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

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

  itkOverrideGetNameOfClassMacro(RegionConstrainedSubsampler);

  using SampleType = TSample;
  using SampleConstPointer = typename SampleType::ConstPointer;
  using MeasurementVectorType = typename TSample::MeasurementVectorType;
  using InstanceIdentifier = typename TSample::InstanceIdentifier;
 
  using SubsampleType = Subsample<TSample>;
  using SubsamplePointer = typename SubsampleType::Pointer;
  using SubsampleConstIterator = typename SubsampleType::ConstIterator;
  using InstanceIdentifierHolder = typename SubsampleType::InstanceIdentifierHolder;

  using RegionType = TRegion;
  using IndexType = typename RegionType::IndexType;
  using IndexValueType = typename IndexType::IndexValueType;
  using SizeType = typename RegionType::SizeType;

  void
  SetSampleRegion(const RegionType & region);

  itkGetConstReferenceMacro(SampleRegion, RegionType);

  itkGetConstReferenceMacro(SampleRegionInitialized, bool);

  void
  SetRegionConstraint(const RegionType & region);

  itkGetConstReferenceMacro(RegionConstraint, RegionType);

  itkGetConstReferenceMacro(RegionConstraintInitialized, bool);

  void
  Search(const InstanceIdentifier & query, SubsamplePointer & results) override = 0;
 
protected:
  [[nodiscard]] typename LightObject::Pointer
  InternalClone() const override;
 
  RegionConstrainedSubsampler();
  ~RegionConstrainedSubsampler() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  RegionType m_RegionConstraint{};
  bool       m_RegionConstraintInitialized{};
  RegionType m_SampleRegion{};
  bool       m_SampleRegionInitialized{};
}; // end of class RegionConstrainedSubsampler
 
} // namespace itk::Statistics
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkRegionConstrainedSubsampler.hxx"
#endif
 
#endif