itkRegionConstrainedSubsampler.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 __itkRegionConstrainedSubsampler_h
#define __itkRegionConstrainedSubsampler_h

#include "itkSubsamplerBase.h"
#include "itkImageRegion.h"

namespace itk {
namespace Statistics {
template < class TSample, class TRegion >
class ITK_EXPORT RegionConstrainedSubsampler : public SubsamplerBase<TSample>
{
public:
  typedef RegionConstrainedSubsampler<TSample, TRegion>  Self;
  typedef SubsamplerBase<TSample>                        Superclass;
  typedef typename Superclass::Baseclass                 Baseclass;
  typedef SmartPointer<Self>                             Pointer;
  typedef SmartPointer<const Self>                       ConstPointer;

  itkTypeMacro(RegionConstrainedSubsampler, SubsamplerBase);

  typedef TSample                                          SampleType;
  typedef typename SampleType::ConstPointer                SampleConstPointer;
  typedef typename TSample::MeasurementVectorType          MeasurementVectorType;
  typedef typename TSample::InstanceIdentifier             InstanceIdentifier;

  typedef Subsample<TSample>                               SubsampleType;
  typedef typename SubsampleType::Pointer                  SubsamplePointer;
  typedef typename SubsampleType::ConstIterator            SubsampleConstIterator;
  typedef typename SubsampleType::InstanceIdentifierHolder InstanceIdentifierHolder;

  typedef TRegion                              RegionType;
  typedef typename RegionType::IndexType       IndexType;
  typedef typename IndexType::IndexValueType   IndexValueType;
  typedef typename RegionType::SizeType        SizeType;

  void SetSampleRegion(const RegionType& region);

  itkGetConstReferenceMacro( SampleRegion, RegionType );

  itkGetConstReferenceMacro(SampleRegionInitialized, bool);

  void SetRegionConstraint(const RegionType& region);

  itkGetConstReferenceMacro( RegionConstraint, RegionType );

  itkGetConstReferenceMacro(RegionConstraintInitialized, bool);

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

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

  RegionConstrainedSubsampler();
  virtual ~RegionConstrainedSubsampler() {};

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

  RegionType m_RegionConstraint;
  bool       m_RegionConstraintInitialized;
  RegionType m_SampleRegion;
  bool       m_SampleRegionInitialized;

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

}; // end of class RegionConstrainedSubsampler

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

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

#endif