itkSpatialNeighborSubsampler.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 {
namespace Statistics {
template < class TSample, class TRegion >
  class ITK_EXPORT SpatialNeighborSubsampler : public RegionConstrainedSubsampler<TSample, TRegion>
{
public:
  typedef SpatialNeighborSubsampler<TSample, TRegion>    Self;
  typedef RegionConstrainedSubsampler<TSample, TRegion>  Superclass;
  typedef typename Superclass::Baseclass                 Baseclass;
  typedef SmartPointer<Self>                             Pointer;
  typedef SmartPointer<const Self>                       ConstPointer;

  itkTypeMacro(SpatialNeighborSubsampler, RegionConstrainedSubsampler);

  itkNewMacro(Self);

  typedef typename Superclass::SampleType                  SampleType;
  typedef typename Superclass::SampleConstPointer          SampleConstPointer;
  typedef typename Superclass::MeasurementVectorType       MeasurementVectorType;
  typedef typename Superclass::InstanceIdentifier          InstanceIdentifier;

  typedef typename Superclass::SubsampleType            SubsampleType;
  typedef typename Superclass::SubsamplePointer         SubsamplePointer;
  typedef typename Superclass::SubsampleConstIterator   SubsampleConstIterator;
  typedef typename Superclass::InstanceIdentifierHolder InstanceIdentifierHolder;

  typedef typename Superclass::RegionType     RegionType;
  typedef typename Superclass::IndexType      IndexType;
  typedef typename Superclass::IndexValueType IndexValueType;
  typedef typename Superclass::SizeType       SizeType;
  typedef typename RegionType::SizeType       RadiusType;

  itkStaticConstMacro(ImageDimension, unsigned int, RegionType::ImageDimension);
  typedef ImageHelper<itkGetStaticConstMacro(ImageDimension),
                      itkGetStaticConstMacro(ImageDimension)> ImageHelperType;

  void SetRadius(const RadiusType& radius);
  void SetRadius(unsigned int radius);

  itkGetConstReferenceMacro(Radius, RadiusType);

  itkGetConstReferenceMacro(RadiusInitialized, bool);

  virtual void Search(const InstanceIdentifier& query,
                      SubsamplePointer& results);

protected:
  virtual typename LightObject::Pointer InternalClone() const;

  SpatialNeighborSubsampler();
  virtual ~SpatialNeighborSubsampler() {};

  virtual void PrintSelf(std::ostream& os, Indent indent) const;

  RadiusType m_Radius;
  bool       m_RadiusInitialized;

private:
  SpatialNeighborSubsampler(const Self&); // purposely not implemented
  void operator=(const Self&); // purposely not implemented

}; // end of class SpatialNeighborSubsampler

} // end of namespace Statistics
} // end of namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSpatialNeighborSubsampler.hxx"
#endif

#endif