itkSubsamplerBase.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 itkSubsamplerBase_h
#define itkSubsamplerBase_h
 
#include "itkObject.h"
#include "itkSample.h"
#include "itkSubsample.h"
 
namespace itk::Statistics
{
 
template <typename TSample>
class ITK_TEMPLATE_EXPORT SubsamplerBase : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SubsamplerBase);

  using Self = SubsamplerBase;
  using Superclass = Object;
  using Baseclass = Self;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(SubsamplerBase);

  itkCloneMacro(Self);

  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 SeedType = unsigned int;

  itkSetConstObjectMacro(Sample, SampleType);
  itkGetConstObjectMacro(Sample, SampleType);

  itkSetMacro(CanSelectQuery, bool);
  itkGetConstReferenceMacro(CanSelectQuery, bool);
  itkBooleanMacro(CanSelectQuery);

  itkSetMacro(Seed, SeedType);
  itkGetConstReferenceMacro(Seed, SeedType);

  virtual void
  RequestMaximumNumberOfResults()
  {
    if (!this->m_RequestMaximumNumberOfResults)
    {
      this->m_RequestMaximumNumberOfResults = true;
      this->Modified();
    }
  }

  virtual void
  Search(const InstanceIdentifier & query, SubsamplePointer & results) = 0;
 
protected:
  typename LightObject::Pointer
  InternalClone() const override;
 
  SubsamplerBase();
  ~SubsamplerBase() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  SampleConstPointer m_Sample{};
  bool               m_RequestMaximumNumberOfResults{};
  bool               m_CanSelectQuery{};
  SeedType           m_Seed{};
}; // end of class SubsamplerBase
 
} // namespace itk::Statistics
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSubsamplerBase.hxx"
#endif
 
#endif