ALPHALINUX5/util/ALPHALINUX5/include/vtk/vtkImageDifference.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkImageDifference.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:35:48 $
   7   Version:   $Revision: 1.1.1.1 $
   8
   9
  10 Copyright (c) 1993-1998 Ken Martin, Will Schroeder, Bill Lorensen.
  11
  12 This software is copyrighted by Ken Martin, Will Schroeder and Bill Lorensen.
  13 The following terms apply to all files associated with the software unless
  14 explicitly disclaimed in individual files. This copyright specifically does
  15 not apply to the related textbook "The Visualization Toolkit" ISBN
  16 013199837-4 published by Prentice Hall which is covered by its own copyright.
  17
  18 The authors hereby grant permission to use, copy, and distribute this
  19 software and its documentation for any purpose, provided that existing
  20 copyright notices are retained in all copies and that this notice is included
  21 verbatim in any distributions. Additionally, the authors grant permission to
  22 modify this software and its documentation for any purpose, provided that
  23 such modifications are not distributed without the explicit consent of the
  24 authors and that existing copyright notices are retained in all copies. Some
  25 of the algorithms implemented by this software are patented, observe all
  26 applicable patent law.
  27
  28 IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY FOR
  29 DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
  30 OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY DERIVATIVES THEREOF,
  31 EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32
  33 THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
  34 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  35 PARTICULAR PURPOSE, AND NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN
  36 "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE
  37 MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  38
  39
  40 =========================================================================*/
  41 // .NAME vtkImageDifference - select piece (e.g., volume of interest) and/or subsample structured points dataset
  42
  43 // .SECTION Description
  44 // vtkImageDifference is a filter that selects a portion of an input structured points
  45 // dataset, or subsamples an input dataset. (The selected portion of interested is
  46 // referred toas the Volume Of Interest, or VOI.) The output of this filter is a
  47 // structured points dataset. The filter treats input data of any topological
  48 // dimension (i.e., point, line, image, or volume) and can generate output data
  49 // of any topological dimension.
  50 //
  51 // To use this filter set the VOI ivar which are i-j-k min/max indices that specify
  52 // a rectangular region in the data. (Note that these are 0-offset.) You can also
  53 // specify a sampling rate to subsample the data.
  54 //
  55 // Typical applications of this filter are to extract a slice from a volume for
  56 // image processing, subsampling large volumes to reduce data size, or extracting
  57 // regions of a volume with interesting data.
  58
  59 // .SECTION See Also
  60 // vtkGeometryFilter vtkExtractGeometry vtkExtractGrid
  61
  62 #ifndef __vtkImageDifference_h
  63 #define __vtkImageDifference_h
  64
  65 #include "vtkStructuredPointsToStructuredPointsFilter.h"
  66
  67 class VTK_EXPORT vtkImageDifference : public vtkStructuredPointsToStructuredPointsFilter
  68 {
  69 public:
  70   vtkImageDifference();
  71   static vtkImageDifference *New() {return new vtkImageDifference;};
  72   const char *GetClassName() {return "vtkImageDifference";};
  73   void PrintSelf(ostream& os, vtkIndent indent);
  74
  75   void Update();
  76
  77   // Description:
  78   // Specify the Image to compare the input to.
  79   vtkSetObjectMacro(Image,vtkStructuredPoints);
  80   vtkGetObjectMacro(Image,vtkStructuredPoints);
  81   void SetImage(vtkImageCache *cache)
  82     {this->SetImage(cache->GetImageToStructuredPoints()->GetOutput());}
  83
  84   // Description:
  85   // Return the error in comparing the two images.
  86   vtkGetMacro(Error,float);
  87
  88   // Description:
  89   // Return the thresholded error in comparing the two images.
  90   vtkGetMacro(ThresholdedError,float);
  91
  92   // Description:
  93   // Specify a threshold tolorance for pixel differences.
  94   vtkSetMacro(Threshold,int);
  95   vtkGetMacro(Threshold,int);
  96
  97   // Description:
  98   // Specify whether the comparison will allow a shift of one
  99   // pixel between the images.  If set, then the minimum difference
 100   // between input images will be used to determine the difference.
 101   // Otherwise, the difference is computed directly between pixels
 102   // of identical row/column values.
 103
 104   vtkSetMacro(AllowShift,int);
 105   vtkGetMacro(AllowShift,int);
 106   vtkBooleanMacro(AllowShift,int);
 107
 108
 109 protected:
 110   void Execute();
 111   vtkStructuredPoints *Image;
 112   float Error;
 113   float ThresholdedError;
 114   int AllowShift;
 115   int Threshold;
 116 };
 117
 118 #endif
 119
 120