vtkImageStash.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkImageStash.h,v $

  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 __vtkImageStash_h
#define __vtkImageStash_h

#include "vtkSlicerEditorLibModuleLogicExport.h"

// VTK includes
#include <vtkImageData.h>
#include <vtkMultiThreader.h>
#include <vtkUnsignedCharArray.h>
#include <vtkZLibDataCompressor.h>

class VTK_SLICER_EDITORLIB_MODULE_LOGIC_EXPORT vtkImageStash : public vtkObject
{
public:
  static vtkImageStash *New();
  vtkTypeRevisionMacro(vtkImageStash,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  vtkSetObjectMacro(StashImage, vtkImageData);
  vtkGetObjectMacro(StashImage, vtkImageData);

  vtkSetObjectMacro(StashedScalars, vtkUnsignedCharArray);
  vtkGetObjectMacro(StashedScalars, vtkUnsignedCharArray);

  // Description:
  // To keep track of original number of tuples in scalar data
  vtkSetMacro(NumberOfTuples, vtkIdType);
  vtkGetMacro(NumberOfTuples, vtkIdType);

  vtkSetObjectMacro(MultiThreader, vtkMultiThreader);
  vtkGetObjectMacro(MultiThreader, vtkMultiThreader);
  
  void Stash();

  void ThreadedStash();

  void Unstash();

  // Description:
  // Get/Set the compression level.
  vtkSetClampMacro(CompressionLevel, int, 0, 9);
  vtkGetMacro(CompressionLevel, int);

  // Description:
  // Get/Set the compressor if needed
  vtkSetObjectMacro(Compressor, vtkZLibDataCompressor);
  vtkGetObjectMacro(Compressor, vtkZLibDataCompressor);

  // Description:
  // Check if compression thread is finished
  vtkSetMacro(Stashing, int);
  vtkGetMacro(Stashing, int);
 
protected:
  vtkImageStash();
  ~vtkImageStash();

  vtkImageData *StashImage;
  vtkUnsignedCharArray *StashedScalars;
  vtkMultiThreader *MultiThreader;
  vtkIdType NumberOfTuples;
  vtkZLibDataCompressor *Compressor;
  int CompressionLevel;
  int Stashing;

private:
  int StashingThreadID;

  vtkImageStash(const vtkImageStash&);  
  void operator=(const vtkImageStash&);  
};



#endif