itkAdvancedImageMomentsCalculator.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 itkAdvancedImageMomentsCalculator_h
#define itkAdvancedImageMomentsCalculator_h
 
#include "itkInPlaceImageFilter.h"
#include "itkBinaryThresholdImageFilter.h"
#include "itkAffineTransform.h"
#include "itkImage.h"
#include "itkImageMaskSpatialObject.h"
#include "itkImageGridSampler.h"
#include "itkImageFullSampler.h"
 
#include <vnl/vnl_vector_fixed.h>
#include <vnl/vnl_matrix_fixed.h>
#include <vnl/vnl_diag_matrix.h>
 
#include "itkMultiThreaderBase.h"
 
#include <vector>
 
namespace itk
{
template <typename TImage>
class ITK_TEMPLATE_EXPORT AdvancedImageMomentsCalculator : public Object
{
public:
  using Self = AdvancedImageMomentsCalculator<TImage>;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(AdvancedImageMomentsCalculator, Object);
 
  itkStaticConstMacro(ImageDimension, unsigned int, TImage::ImageDimension);
 
  using ScalarType = double;
 
  using VectorType = Vector<ScalarType, Self::ImageDimension>;
 
  using SpatialObjectType = ImageMaskSpatialObject<Self::ImageDimension>;
 
  using SpatialObjectPointer = typename SpatialObjectType::Pointer;
  using SpatialObjectConstPointer = typename SpatialObjectType::ConstPointer;
 
  using MatrixType = Matrix<ScalarType, Self::ImageDimension, Self::ImageDimension>;
 
  using ImageType = TImage;
 
  using ImagePointer = typename ImageType::Pointer;
  using ImageConstPointer = typename ImageType::ConstPointer;
 
  using AffineTransformType = AffineTransform<double, Self::ImageDimension>;
  using AffineTransformPointer = typename AffineTransformType::Pointer;
 
  virtual void
  SetImage(const ImageType * image)
  {
    if (m_Image != image)
    {
      m_Image = image;
      this->Modified();
      m_Valid = false;
    }
  }
 
  virtual void
  SetSpatialObjectMask(const ImageMaskSpatialObject<Self::ImageDimension> * so)
  {
    if (m_SpatialObjectMask != so)
    {
      m_SpatialObjectMask = so;
      this->Modified();
      m_Valid = false;
    }
  }
 
  void
  Compute();
 
  void
  ComputeSingleThreaded();
  ScalarType
  GetTotalMass() const;
 
  VectorType
  GetFirstMoments() const;
 
  MatrixType
  GetSecondMoments() const;
 
  VectorType
  GetCenterOfGravity() const;
 
  MatrixType
  GetCentralMoments() const;
 
  VectorType
  GetPrincipalMoments() const;
 
  MatrixType
  GetPrincipalAxes() const;
 
  AffineTransformPointer
  GetPrincipalAxesToPhysicalAxesTransform() const;
 
  AffineTransformPointer
  GetPhysicalAxesToPrincipalAxesTransform() const;
 
  void
  SetNumberOfWorkUnits(ThreadIdType numberOfThreads)
  {
    this->m_Threader->SetNumberOfWorkUnits(numberOfThreads);
  }
 
  virtual void
  BeforeThreadedCompute();
 
  virtual void
  AfterThreadedCompute();
 
  using ImageGridSamplerType = itk::ImageGridSampler<ImageType>;
  //  using ImageGridSamplerType = itk::ImageFullSampler< ImageType >    ;
  using ImageGridSamplerPointer = typename ImageGridSamplerType::Pointer;
  using ImageSampleContainerType = typename ImageGridSamplerType ::ImageSampleContainerType;
  using ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer;
 
  virtual void
  SampleImage(ImageSampleContainerPointer & sampleContainer);
 
  using BinaryThresholdImageFilterType = itk::BinaryThresholdImageFilter<TImage, TImage>;
  using InputPixelType = typename TImage::PixelType;
 
  itkSetMacro(NumberOfSamplesForCenteredTransformInitialization, SizeValueType);
  itkSetMacro(LowerThresholdForCenterGravity, InputPixelType);
  itkSetMacro(CenterOfGravityUsesLowerThreshold, bool);
 
protected:
  AdvancedImageMomentsCalculator();
  ~AdvancedImageMomentsCalculator() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  using ThreadInfoType = MultiThreaderBase::WorkUnitInfo;
 
  void
  LaunchComputeThreaderCallback() const;
 
  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION
  ComputeThreaderCallback(void * arg);
 
  virtual void
  ThreadedCompute(ThreadIdType threadID);
 
  virtual void
  InitializeThreadingParameters();
 
  struct MultiThreaderParameterType
  {
    Self * st_Self;
  };
 
  struct ComputePerThreadStruct
  {
    ScalarType    st_M0; // Zeroth moment for threading
    VectorType    st_M1; // First moments about origin for threading
    MatrixType    st_M2; // Second moments about origin for threading
    VectorType    st_Cg; // Center of gravity (physical units) for threading
    MatrixType    st_Cm; // Second central moments (physical) for threading
    SizeValueType st_NumberOfPixelsCounted;
  };
  itkPadStruct(ITK_CACHE_LINE_ALIGNMENT, ComputePerThreadStruct, PaddedComputePerThreadStruct);
  itkAlignedTypedef(ITK_CACHE_LINE_ALIGNMENT, PaddedComputePerThreadStruct, AlignedComputePerThreadStruct);
 
  using ThreadRegionType = typename ImageType::RegionType;
 
private:
  void
  DoPostProcessing();
 
  AdvancedImageMomentsCalculator(const Self &);
  void
  operator=(const Self &);
 
  MultiThreaderBase::Pointer m_Threader{};
 
  mutable MultiThreaderParameterType m_ThreaderParameters{};
 
  mutable std::vector<AlignedComputePerThreadStruct> m_ComputePerThreadVariables{};
  bool                                               m_UseMultiThread{};
  SizeValueType                                      m_NumberOfPixelsCounted{};
 
  SizeValueType               m_NumberOfSamplesForCenteredTransformInitialization{};
  InputPixelType              m_LowerThresholdForCenterGravity{};
  bool                        m_CenterOfGravityUsesLowerThreshold{};
  ImageSampleContainerPointer m_SampleContainer{};
 
  bool       m_Valid{}; // Have moments been computed yet?
  ScalarType m_M0{};    // Zeroth moment
  VectorType m_M1{};    // First moments about origin
  MatrixType m_M2{};    // Second moments about origin
  VectorType m_Cg{};    // Center of gravity (physical units)
  MatrixType m_Cm{};    // Second central moments (physical)
  VectorType m_Pm{};    // Principal moments (physical)
  MatrixType m_Pa{};    // Principal axes (physical)
 
  ImageConstPointer         m_Image{};
  SpatialObjectConstPointer m_SpatialObjectMask{};
 
}; // class AdvancedImageMomentsCalculator
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkAdvancedImageMomentsCalculator.hxx"
#endif
 
#endif /* itkAdvancedImageMomentsCalculator_h */