itkImageToListSampleFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkImageToListSampleFilter_h
#define itkImageToListSampleFilter_h
 
#include "itkListSample.h"
#include "itkPixelTraits.h"
#include "itkProcessObject.h"
#include "itkDataObjectDecorator.h"
 
namespace itk
{
namespace Statistics
{
template <typename TImage, typename TMaskImage = TImage>
class ITK_TEMPLATE_EXPORT ImageToListSampleFilter : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImageToListSampleFilter);

  using Self = ImageToListSampleFilter;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ImageToListSampleFilter);

  itkNewMacro(Self);

  using ImageType = TImage;
  using ImagePointer = typename ImageType::Pointer;
  using ImageConstPointer = typename ImageType::ConstPointer;
  using PixelType = typename ImageType::PixelType;
  using MeasurementVectorType = typename MeasurementVectorPixelTraits<PixelType>::MeasurementVectorType;

  using MaskImageType = TMaskImage;
  using MaskImagePointer = typename MaskImageType::Pointer;
  using MaskImageConstPointer = typename MaskImageType::ConstPointer;
  using MaskPixelType = typename MaskImageType::PixelType;

  using ListSampleType = ListSample<MeasurementVectorType>;

  unsigned int
  GetMeasurementVectorSize() const;

  using Superclass::SetInput;
  void
  SetInput(const ImageType * image);
 
  const ImageType *
  GetInput() const;

  void
  SetMaskImage(const MaskImageType * image);
 
  const MaskImageType *
  GetMaskImage() const;

  const ListSampleType *
  GetOutput() const;

  itkSetMacro(MaskValue, MaskPixelType);
  itkGetConstMacro(MaskValue, MaskPixelType);
 
protected:
  ImageToListSampleFilter();
  ~ImageToListSampleFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  using DataObjectPointer = DataObject::Pointer;
  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer
  MakeOutput(DataObjectPointerArraySizeType idx) override;

  void
  GenerateData() override;

  void
  GenerateInputRequestedRegion() override;
 
  void
  GenerateOutputInformation() override;
 
private:
  MaskPixelType m_MaskValue{};
}; // end of class ImageToListSampleFilter
} // end of namespace Statistics
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageToListSampleFilter.hxx"
#endif
 
#endif