itkImageGridSampler.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 __ImageGridSampler_h
#define __ImageGridSampler_h
 
#include "itkImageSamplerBase.h"
 
namespace itk
{
 
template< class TInputImage >
class ImageGridSampler :
  public ImageSamplerBase< TInputImage >
{
public:
 
  typedef ImageGridSampler                Self;
  typedef ImageSamplerBase< TInputImage > Superclass;
  typedef SmartPointer< Self >            Pointer;
  typedef SmartPointer< const Self >      ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( ImageGridSampler, ImageSamplerBase );
 
  typedef typename Superclass::DataObjectPointer            DataObjectPointer;
  typedef typename Superclass::OutputVectorContainerType    OutputVectorContainerType;
  typedef typename Superclass::OutputVectorContainerPointer OutputVectorContainerPointer;
  typedef typename Superclass::InputImageType               InputImageType;
  typedef typename Superclass::InputImagePointer            InputImagePointer;
  typedef typename Superclass::InputImageConstPointer       InputImageConstPointer;
  typedef typename Superclass::InputImageRegionType         InputImageRegionType;
  typedef typename Superclass::InputImagePixelType          InputImagePixelType;
  typedef typename Superclass::ImageSampleType              ImageSampleType;
  typedef typename Superclass::ImageSampleContainerType     ImageSampleContainerType;
  typedef typename Superclass::ImageSampleContainerPointer  ImageSampleContainerPointer;
  typedef typename Superclass::MaskType                     MaskType;
 
  itkStaticConstMacro( InputImageDimension, unsigned int,
    Superclass::InputImageDimension );
 
  typedef typename Superclass::InputImageIndexType InputImageIndexType;
  //typedef typename Superclass::InputImageSpacingType        InputImageSpacingType;
  typedef typename Superclass::InputImagePointType InputImagePointType;
 
  typedef typename InputImageType::OffsetType             SampleGridSpacingType;
  typedef typename SampleGridSpacingType::OffsetValueType SampleGridSpacingValueType;
  typedef typename InputImageType::SizeType               SampleGridSizeType;
  typedef InputImageIndexType                             SampleGridIndexType;
  typedef typename InputImageType::SizeType               InputImageSizeType;
 
  void SetSampleGridSpacing( const SampleGridSpacingType & arg );
 
  itkGetConstReferenceMacro( SampleGridSpacing, SampleGridSpacingType );
 
  void SetNumberOfSamples( unsigned long nrofsamples ) override;
 
  bool SelectNewSamplesOnUpdate( void ) override
  {
    return false;
  }
 
 
  bool SelectingNewSamplesOnUpdateSupported( void ) const override
  {
    return false;
  }
 
 
protected:
 
  ImageGridSampler();
 
  ~ImageGridSampler() override {}
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  void GenerateData( void ) override;
 
  SampleGridSpacingType m_SampleGridSpacing;
 
  unsigned long m_RequestedNumberOfSamples;
 
private:
 
  ImageGridSampler( const Self & );    // purposely not implemented
  void operator=( const Self & );      // purposely not implemented
 
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageGridSampler.hxx"
#endif
 
#endif // end #ifndef __ImageGridSampler_h