vtkImageStencilData.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkImageStencilData.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 vtkImageStencilData_h
#define vtkImageStencilData_h


#include "vtkImagingCoreModule.h" // For export macro
#include "vtkDataObject.h"

class VTKIMAGINGCORE_EXPORT vtkImageStencilData : public vtkDataObject
{
public:
  static vtkImageStencilData *New();
  vtkTypeMacro(vtkImageStencilData, vtkDataObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Initialize() override;
  void DeepCopy(vtkDataObject *o) override;
  void ShallowCopy(vtkDataObject *f) override;
  void InternalImageStencilDataCopy(vtkImageStencilData *s);

  int GetDataObjectType() override { return VTK_DATA_OBJECT; }

  int GetExtentType() override { return VTK_3D_EXTENT; };

  int GetNextExtent(int &r1, int &r2, int xMin, int xMax,
                    int yIdx, int zIdx, int &iter);

  int IsInside(int xIdx, int yIdx, int zIdx);

  void InsertNextExtent(int r1, int r2, int yIdx, int zIdx);

  void InsertAndMergeExtent(int r1, int r2, int yIdx, int zIdx);

  void RemoveExtent(int r1, int r2, int yIdx, int zIdx);


  vtkSetVector3Macro(Spacing, double);
  vtkGetVector3Macro(Spacing, double);


  vtkSetVector3Macro(Origin, double);
  vtkGetVector3Macro(Origin, double);


  void SetExtent(const int extent[6]);
  void SetExtent(int x1, int x2, int y1, int y2, int z1, int z2);
  vtkGetVector6Macro(Extent, int);

  void AllocateExtents();

  void Fill();


  void CopyInformationFromPipeline(vtkInformation *info) override;
  void CopyInformationToPipeline(vtkInformation *info) override;


  static vtkImageStencilData* GetData(vtkInformation* info);
  static vtkImageStencilData* GetData(vtkInformationVector* v, int i=0);

  virtual void Add(vtkImageStencilData *);

  virtual void Subtract(vtkImageStencilData *);

  virtual void Replace(vtkImageStencilData *);

  virtual int Clip(int extent[6]);

protected:
  vtkImageStencilData();
  ~vtkImageStencilData() override;

  enum Operation { Merge, Erase };

  void LogicalOperationExtent(
    int r1, int r2, int yIdx, int zIdx, Operation operation);

  void LogicalOperationInPlace(
    vtkImageStencilData *stencil, Operation operation);

  void ChangeExtent(const int extent[6]);

  void CopyOriginAndSpacingFromPipeline(vtkInformation *info);


  double Spacing[3];
  double Origin[3];

  int Extent[6];


  int NumberOfExtentEntries;
  int *ExtentListLengths;
  int **ExtentLists;

private:
  vtkImageStencilData(const vtkImageStencilData&) = delete;
  void operator=(const vtkImageStencilData&) = delete;

  friend class vtkImageStencilIteratorFriendship;
};

class VTKIMAGINGCORE_EXPORT vtkImageStencilRaster
{
public:
  vtkImageStencilRaster(const int wholeExtent[2]);

  ~vtkImageStencilRaster();

  void PrepareForNewData(const int allocateExtent[2] = nullptr);


  void InsertLine(const double p1[2], const double p2[2]);
  VTK_LEGACY(void InsertLine(const double[2], const double[2], bool, bool));

  void FillStencilData(vtkImageStencilData *data, const int extent[6],
                       int xj = 0, int yj = 1);

  void SetTolerance(double tol) { this->Tolerance = tol; }
  double GetTolerance() { return this->Tolerance; }

protected:
  void PrepareExtent(int ymin, int ymax);

  void InsertPoint(int y, double x, int i);

  int Extent[2];
  int UsedExtent[2];
  double **Raster;
  double Tolerance;

private:
  vtkImageStencilRaster(const vtkImageStencilRaster&) = delete;
  void operator=(const vtkImageStencilRaster&) = delete;
};

#endif