vtkImagePointDataIterator.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkImagePointDataIterator.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkImagePointDataIterator_h
#define vtkImagePointDataIterator_h
 
#include "vtkImagingCoreModule.h" // for export macro
#include "vtkSystemIncludes.h"
 
class vtkDataArray;
class vtkImageData;
class vtkImageStencilData;
class vtkAlgorithm;
 
class VTKIMAGINGCORE_EXPORT vtkImagePointDataIterator
{
public:
  vtkImagePointDataIterator();
 
  vtkImagePointDataIterator(vtkImageData* image, const int extent[6] = nullptr,
    vtkImageStencilData* stencil = nullptr, vtkAlgorithm* algorithm = nullptr, int threadId = 0)
  {
    this->Initialize(image, extent, stencil, algorithm, threadId);
  }
 
  void Initialize(vtkImageData* image, const int extent[6] = nullptr,
    vtkImageStencilData* stencil = nullptr, vtkAlgorithm* algorithm = nullptr, int threadId = 0);
 
  void NextSpan();
 
  bool IsAtEnd() { return (this->Id == this->End); }
 
  bool IsInStencil() { return this->InStencil; }
 
 
  void GetIndex(int result[3])
  {
    result[0] = this->Index[0];
    result[1] = this->Index[1];
    result[2] = this->Index[2];
  }
 
  const int* GetIndex() VTK_SIZEHINT(3) { return this->Index; }
 
  vtkIdType GetId() { return this->Id; }
 
  vtkIdType SpanEndId() { return this->SpanEnd; }
 
  static void* GetVoidPointer(vtkImageData* image, vtkIdType i = 0, int* pixelIncrement = nullptr);
 
  static void* GetVoidPointer(vtkDataArray* array, vtkIdType i = 0, int* pixelIncrement = nullptr);
 
protected:
  void SetSpanState(int idX);
 
  void ReportProgress();
 
  vtkIdType Id;       // the current point Id
  vtkIdType SpanEnd;  // end of current span
  vtkIdType RowEnd;   // end of current row
  vtkIdType SliceEnd; // end of current slice
  vtkIdType End;      // end of data
 
  // Increments
  vtkIdType RowIncrement;      // to same position in next row
  vtkIdType SliceIncrement;    // to same position in next slice
  vtkIdType RowEndIncrement;   // from end of row to start of next row
  vtkIdType SliceEndIncrement; // from end of slice to start of next slice
 
  // The extent, adjusted for the stencil
  int Extent[6];
 
  // Index-related items
  int Index[3];
  int StartY;
 
  // Stencil-related items
  bool HasStencil;
  bool InStencil;
  int SpanSliceEndIncrement;
  int SpanSliceIncrement;
  int SpanIndex;
  int* SpanCountPointer;
  int** SpanListPointer;
 
  // Progress-related items
  vtkAlgorithm* Algorithm;
  vtkIdType Count;
  vtkIdType Target;
  int ThreadId;
};
 
#endif
// VTK-HeaderTest-Exclude: vtkImagePointDataIterator.h