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 <class TImageType>
 class PipelineMonitorImageFilter :
  public ImageToImageFilter< TImageType, TImageType>
 {
 public:

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

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

   typedef std::vector<typename TImageType::RegionType> RegionVectorType;

   itkNewMacro(Self);

   itkTypeMacro(PipelineMonitorImageFilter,InPlaceImageFilter);

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


   bool VerifyAllInputCanStream(int expectedNumber);


   bool VerifyAllInputCanNotStream(void);

   bool VerifyAllNoUpdate(void);

   bool VerifyDownStreamFilterExecutedPropagation(void);

   bool VerifyInputFilterExecutedStreaming(int expectedNumber);

   bool VerifyInputFilterMatchedUpdateOutputInformation(void);

   bool VerifyInputFilterBufferedRequestedRegions(void);

   bool VerifyInputFilterMatchedRequestedRegions(void);

   bool VerifyInputFilterRequestedLargestRegion(void);


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


   void ClearPipelineSavedInformation(void);


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

 protected:

   PipelineMonitorImageFilter(void);

   // ~PipelineMonitorImageFilter() { } default implementation OK

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

   PipelineMonitorImageFilter(const PipelineMonitorImageFilter &); // not implemented
   void operator=(const PipelineMonitorImageFilter &); // not implemented

   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