itkPipelineMonitorImageFilter.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 itkPipelineMonitorImageFilter_h
#define itkPipelineMonitorImageFilter_h

#include "itkImageToImageFilter.h"

namespace itk
{

 template <typename TImageType>
 class ITK_TEMPLATE_EXPORT PipelineMonitorImageFilter :
  public ImageToImageFilter< TImageType, TImageType>
 {
 public:

   using Self = PipelineMonitorImageFilter;
   using Superclass = ImageToImageFilter<TImageType, TImageType>;
   using Pointer = SmartPointer<Self>;
   using ConstPointer = SmartPointer<const Self>;

   using PointType = typename TImageType::PointType;
   using DirectionType = typename TImageType::DirectionType;
   using SpacingType = typename TImageType::SpacingType;
   using InputImagePointer = typename TImageType::Pointer;
   using InputImageConstPointer = typename TImageType::ConstPointer;
   using ImageRegionType = typename Superclass::InputImageRegionType;

   using RegionVectorType = std::vector<typename TImageType::RegionType>;

   itkNewMacro(Self);

   itkTypeMacro(PipelineMonitorImageFilter,InPlaceImageFilter);

   itkSetMacro( ClearPipelineOnGenerateOutputInformation, bool );
   itkGetMacro( ClearPipelineOnGenerateOutputInformation, bool );
   itkBooleanMacro( ClearPipelineOnGenerateOutputInformation );


   bool VerifyAllInputCanStream(int expectedNumber);


   bool VerifyAllInputCanNotStream();

   bool VerifyAllNoUpdate();

   bool VerifyDownStreamFilterExecutedPropagation();

   bool VerifyInputFilterExecutedStreaming(int expectedNumber);

   bool VerifyInputFilterMatchedUpdateOutputInformation();

   bool VerifyInputFilterBufferedRequestedRegions();

   bool VerifyInputFilterMatchedRequestedRegions();

   bool VerifyInputFilterRequestedLargestRegion();


   unsigned int GetNumberOfUpdates() const { return m_NumberOfUpdates; }
   RegionVectorType GetOutputRequestedRegions() const {return m_OutputRequestedRegions;}
   RegionVectorType GetInputRequestedRegions() const {return m_InputRequestedRegions;}
   RegionVectorType GetUpdatedBufferedRegions() const {return m_UpdatedBufferedRegions; }
   RegionVectorType GetUpdatedRequestedRegions() const {return m_UpdatedRequestedRegions; }

   itkGetConstMacro(UpdatedOutputOrigin, PointType);
   itkGetConstMacro(UpdatedOutputDirection, DirectionType);
   itkGetConstMacro(UpdatedOutputSpacing, SpacingType);
   itkGetConstMacro(UpdatedOutputLargestPossibleRegion, ImageRegionType);

   void ClearPipelineSavedInformation();


   void GenerateOutputInformation() override;
   void PropagateRequestedRegion(DataObject *output) override;
   void EnlargeOutputRequestedRegion( DataObject *output) override;
   void GenerateInputRequestedRegion() override;
   void GenerateData() override;

 protected:

   PipelineMonitorImageFilter();

   // ~PipelineMonitorImageFilter() { } default implementation OK

   void PrintSelf(std::ostream &os, Indent indent) const override;
 private:

   PipelineMonitorImageFilter(const PipelineMonitorImageFilter &) = delete;
   void operator=(const PipelineMonitorImageFilter &) = delete;

   bool m_ClearPipelineOnGenerateOutputInformation;

   unsigned int m_NumberOfUpdates;

   unsigned int m_NumberOfClearPipeline;

   RegionVectorType m_OutputRequestedRegions;
   RegionVectorType m_InputRequestedRegions;
   RegionVectorType m_UpdatedBufferedRegions;
   RegionVectorType m_UpdatedRequestedRegions;

   PointType       m_UpdatedOutputOrigin;
   DirectionType   m_UpdatedOutputDirection;
   SpacingType     m_UpdatedOutputSpacing;
   ImageRegionType m_UpdatedOutputLargestPossibleRegion;
 };

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkPipelineMonitorImageFilter.hxx"
#endif

#endif //itkPipelineMonitorImageFilter_hxx