itkImageSamplerBase.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 __ImageSamplerBase_h
#define __ImageSamplerBase_h
 
#include "itkImageToVectorContainerFilter.h"
#include "itkImageSample.h"
#include "itkVectorDataContainer.h"
#include "itkSpatialObject.h"
 
namespace itk
{
template< class TInputImage >
class ImageSamplerBase :
  public ImageToVectorContainerFilter< TInputImage,
  VectorDataContainer< std::size_t, ImageSample< TInputImage > > >
{
public:
 
  typedef ImageSamplerBase Self;
  typedef ImageToVectorContainerFilter<
    TInputImage, VectorDataContainer<
    std::size_t, ImageSample< TInputImage > > > Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( ImageSamplerBase, ImageToVectorContainerFilter );
 
  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;
 
  itkStaticConstMacro( InputImageDimension, unsigned int,
    InputImageType::ImageDimension );
 
  typedef ImageSample< InputImageType >                         ImageSampleType;
  typedef VectorDataContainer< std::size_t, ImageSampleType >   ImageSampleContainerType;
  typedef typename ImageSampleContainerType::Pointer            ImageSampleContainerPointer;
  typedef typename InputImageType::SizeType                     InputImageSizeType;
  typedef typename InputImageType::IndexType                    InputImageIndexType;
  typedef typename InputImageType::PointType                    InputImagePointType;
  typedef typename InputImagePointType::ValueType               InputImagePointValueType;
  typedef typename ImageSampleType::RealType                    ImageSampleValueType;
  typedef SpatialObject< Self::InputImageDimension >            MaskType;
  typedef typename MaskType::Pointer                            MaskPointer;
  typedef typename MaskType::ConstPointer                       MaskConstPointer;
  typedef std::vector< MaskConstPointer >                       MaskVectorType;
  typedef std::vector< InputImageRegionType >                   InputImageRegionVectorType;
 
  virtual void SetMask( const MaskType * _arg, unsigned int pos );
 
  virtual void SetMask( const MaskType * _arg )
  {
    this->SetMask( _arg, 0 );
  }
 
 
  virtual const MaskType * GetMask( unsigned int pos ) const;
 
  virtual const MaskType * GetMask( void ) const
  {
    return this->GetMask( 0 );
  }
 
 
  virtual void SetNumberOfMasks( const unsigned int _arg );
 
  itkGetConstMacro( NumberOfMasks, unsigned int );
 
  virtual void SetInputImageRegion( const InputImageRegionType _arg, unsigned int pos );
 
  virtual void SetInputImageRegion( const InputImageRegionType _arg )
  {
    this->SetInputImageRegion( _arg, 0 );
  }
 
 
  virtual const InputImageRegionType & GetInputImageRegion( unsigned int pos ) const;
 
  virtual const InputImageRegionType & GetInputImageRegion( void ) const
  {
    return this->GetInputImageRegion( 0 );
  }
 
 
  virtual void SetNumberOfInputImageRegions( const unsigned int _arg );
 
  itkGetConstMacro( NumberOfInputImageRegions, unsigned int );
 
  virtual bool SelectNewSamplesOnUpdate( void );
 
  virtual bool SelectingNewSamplesOnUpdateSupported( void ) const
  {
    return true;
  }
 
 
  itkGetConstReferenceMacro( CroppedInputImageRegion, InputImageRegionType );
 
  itkSetClampMacro( NumberOfSamples, unsigned long, 1, NumericTraits< unsigned long >::max() );
  itkGetConstMacro( NumberOfSamples, unsigned long );
 
  itkSetMacro( UseMultiThread, bool );
 
protected:
 
  ImageSamplerBase();
 
  ~ImageSamplerBase() override {}
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  void GenerateInputRequestedRegion( void ) override;
 
  virtual bool IsInsideAllMasks( const InputImagePointType & point ) const;
 
  virtual void UpdateAllMasks( void );
 
  virtual bool CheckInputImageRegions( void );
 
  void CropInputImageRegion( void );
 
  void BeforeThreadedGenerateData( void ) override;
 
  void AfterThreadedGenerateData( void ) override;
 
  /***/
  unsigned long                              m_NumberOfSamples;
  std::vector< ImageSampleContainerPointer > m_ThreaderSampleContainer;
 
  //tmp?
  bool m_UseMultiThread;
 
private:
 
  ImageSamplerBase( const Self & );          // purposely not implemented
  void operator=( const Self & );            // purposely not implemented
 
  MaskConstPointer           m_Mask;
  MaskVectorType             m_MaskVector;
  unsigned int               m_NumberOfMasks;
  InputImageRegionType       m_InputImageRegion;
  InputImageRegionVectorType m_InputImageRegionVector;
  unsigned int               m_NumberOfInputImageRegions;
 
  InputImageRegionType m_CroppedInputImageRegion;
  InputImageRegionType m_DummyInputImageRegion;
 
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageSamplerBase.hxx"
#endif
 
#endif // end #ifndef __ImageSamplerBase_h