itkImageRandomCoordinateSampler.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 __ImageRandomCoordinateSampler_h
#define __ImageRandomCoordinateSampler_h
 
#include "itkImageRandomSamplerBase.h"
#include "itkInterpolateImageFunction.h"
#include "itkBSplineInterpolateImageFunction.h"
#include "itkMersenneTwisterRandomVariateGenerator.h"
 
namespace itk
{
 
template< class TInputImage >
class ImageRandomCoordinateSampler :
  public ImageRandomSamplerBase< TInputImage >
{
public:
 
  typedef ImageRandomCoordinateSampler          Self;
  typedef ImageRandomSamplerBase< TInputImage > Superclass;
  typedef SmartPointer< Self >                  Pointer;
  typedef SmartPointer< const Self >            ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( ImageRandomCoordinateSampler, ImageRandomSamplerBase );
 
  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;
  typedef typename Superclass::InputImageSizeType           InputImageSizeType;
  typedef typename InputImageType::SpacingType              InputImageSpacingType;
  typedef typename Superclass::InputImageIndexType          InputImageIndexType;
  typedef typename Superclass::InputImagePointType          InputImagePointType;
  typedef typename Superclass::InputImagePointValueType     InputImagePointValueType;
  typedef typename Superclass::ImageSampleValueType         ImageSampleValueType;
 
  itkStaticConstMacro( InputImageDimension, unsigned int,
    Superclass::InputImageDimension );
 
  typedef double CoordRepType;
  typedef InterpolateImageFunction<
    InputImageType, CoordRepType >                            InterpolatorType;
  typedef typename InterpolatorType::Pointer InterpolatorPointer;
  typedef BSplineInterpolateImageFunction<
    InputImageType, CoordRepType, double >                    DefaultInterpolatorType;
 
  typedef itk::Statistics::MersenneTwisterRandomVariateGenerator RandomGeneratorType;
  typedef typename RandomGeneratorType::Pointer                  RandomGeneratorPointer;
 
  itkSetObjectMacro( Interpolator, InterpolatorType );
  itkGetModifiableObjectMacro( Interpolator, InterpolatorType );
 
  itkSetMacro( SampleRegionSize, InputImageSpacingType );
  itkGetConstReferenceMacro( SampleRegionSize, InputImageSpacingType );
 
  itkGetConstMacro( UseRandomSampleRegion, bool );
  itkSetMacro( UseRandomSampleRegion, bool );
 
protected:
 
  typedef typename InterpolatorType::ContinuousIndexType InputImageContinuousIndexType;
 
  ImageRandomCoordinateSampler();
  ~ImageRandomCoordinateSampler() override {}
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  void GenerateData( void ) override;
 
  void BeforeThreadedGenerateData( void ) override;
 
  void ThreadedGenerateData(
    const InputImageRegionType & inputRegionForThread,
    ThreadIdType threadId ) override;
 
  virtual void GenerateRandomCoordinate(
    const InputImageContinuousIndexType & smallestContIndex,
    const InputImageContinuousIndexType & largestContIndex,
    InputImageContinuousIndexType &       randomContIndex );
 
  InterpolatorPointer    m_Interpolator;
  RandomGeneratorPointer m_RandomGenerator;
  InputImageSpacingType  m_SampleRegionSize;
 
  virtual void GenerateSampleRegion(
    const InputImageContinuousIndexType & smallestImageContIndex,
    const InputImageContinuousIndexType & largestImageContIndex,
    InputImageContinuousIndexType & smallestContIndex,
    InputImageContinuousIndexType & largestContIndex );
 
private:
 
  ImageRandomCoordinateSampler( const Self & );   // purposely not implemented
  void operator=( const Self & );                 // purposely not implemented
 
  bool m_UseRandomSampleRegion;
 
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageRandomCoordinateSampler.hxx"
#endif
 
#endif // end #ifndef __ImageRandomCoordinateSampler_h