HP/util/HP/include/vtk/vtkImageSubsample3D.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkImageSubsample3D.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:33:23 $
   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 vtkImageSubsample3D - Subsamples an image with an interger stride.
  42 // .SECTION Description
  43 // vtkImageSubsample3D shrinks an image by sub sampling on a
  44 // uniform grid (integer multiples).  The shrink factors indicate
  45 // the strides taken along the filtered axes.  If the ShrinkFactor
  46 // for an axis is 1, then the spacing along that axis is not changed.
  47 // vtkImageGaussian and vtkImageMean can also Subsample, and
  48 // vtkImageResample can change the spacing in non integer multiples
  49 // of the original spacing.
  50
  51
  52 #ifndef __vtkImageSubsample3D_h
  53 #define __vtkImageSubsample3D_h
  54
  55
  56 #include "vtkImageFilter.h"
  57
  58 class VTK_EXPORT vtkImageSubsample3D : public vtkImageFilter
  59 {
  60 public:
  61   vtkImageSubsample3D();
  62   static vtkImageSubsample3D *New() {return new vtkImageSubsample3D;};
  63   const char *GetClassName() {return "vtkImageSubsample3D";};
  64   void PrintSelf(ostream& os, vtkIndent indent);
  65
  66   // Description:
  67   // Set/Get the shrink factors of the FilteredAxes
  68   vtkSetVector3Macro(ShrinkFactors,int);
  69   vtkGetVector3Macro(ShrinkFactors,int);
  70
  71   // Description:
  72   // Set/Get the pixel to use as origin.
  73   vtkSetVector3Macro(Shift,int);
  74   vtkGetVector3Macro(Shift,int);
  75
  76   // Description:
  77   // Specify which axes will contribute to the gradient.
  78   // This also determines the NumberOfScalarComponents in the output.
  79   void SetFilteredAxes(int axis0, int axis1, int axis2);
  80   vtkGetVector3Macro(FilteredAxes, int);
  81
  82 protected:
  83   int ShrinkFactors[3];
  84   int Shift[3];
  85   int Averaging;
  86
  87   void ExecuteImageInformation();
  88   void ComputeRequiredInputUpdateExtent();
  89   void Execute(vtkImageRegion *inRegion, vtkImageRegion *outRegion);
  90 };
  91
  92 #endif
  93
  94
  95