SGI/util/SGI/include/imaging/vtkImageGradient.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkImageGradient.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:30:50 $
   7   Version:   $Revision: 1.1.1.1 $
   8   Thanks:    Thanks to C. Charles Law who developed this class.
   9
  10 Copyright (c) 1993-1995 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 vtkImageGradient - Computes the gradient vector.
  42 // .SECTION Description
  43 // vtkImageGradient computes the gradient
  44 // vector of an image.  The vector results are placed along the
  45 // component axis.  Setting the FilteredAxes determines whether the gradient
  46 // computed on 1D lines, 2D images, 3D volumes or higher dimensional
  47 // images.  The default is two dimensional XY images.  OutputScalarType
  48 // is always float.  Gradient is computed using central differences.
  49
  50
  51
  52 #ifndef __vtkImageGradient_h
  53 #define __vtkImageGradient_h
  54
  55
  56 #include "vtkImageFilter.h"
  57
  58 class VTK_EXPORT vtkImageGradient : public vtkImageFilter
  59 {
  60 public:
  61   vtkImageGradient();
  62   static vtkImageGradient *New() {return new vtkImageGradient;};
  63   const char *GetClassName() {return "vtkImageGradient";};
  64   void PrintSelf(ostream& os, vtkIndent indent);
  65
  66   // Description:
  67   // Determines how the input is interpreted (set of 2d slices ...)
  68   vtkSetClampMacro(Dimensionality,int,2,3);
  69   vtkGetMacro(Dimensionality,int);
  70
  71   // Description:
  72   // If "HandleBoundariesOn" then boundary pixels are duplicated
  73   // So central differences can get values.
  74   vtkSetMacro(HandleBoundaries, int);
  75   vtkGetMacro(HandleBoundaries, int);
  76   vtkBooleanMacro(HandleBoundaries, int);
  77
  78 protected:
  79   int HandleBoundaries;
  80   int Dimensionality;
  81
  82   void ExecuteImageInformation();
  83   void ComputeRequiredInputUpdateExtent(int inExt[6], int outExt[6]);
  84   void ThreadedExecute(vtkImageData *inData, vtkImageData *outData,
  85                        int extent[6], int id);
  86 };
  87
  88 #endif
  89
  90
  91