cmtkVolumeClipping.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2011 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2752 $
//
//  $LastChangedDate: 2011-01-17 11:33:31 -0800 (Mon, 17 Jan 2011) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkVolumeClipping_h_included_
#define __cmtkVolumeClipping_h_included_

#include <cmtkconfig.h>

#include <Base/cmtkTypes.h>
#include <Base/cmtkVector3D.h>
#include <Base/cmtkUniformVolume.h>

namespace
cmtk
{


class VolumeClipping 
{
public:
  void SetClippingBoundaries( const UniformVolume::CoordinateRegionType& region  );

  void SetDeltaX( const Vector3D& deltaX ) 
  {
    this->DeltaX = deltaX;
  }

  void SetDeltaY( const Vector3D& deltaY ) 
  {
    this->DeltaY = deltaY;
  }
  
  void SetDeltaZ( const Vector3D& deltaZ ) 
  {
    this->DeltaZ = deltaZ;
  }

  int ClipX ( Types::Coordinate& fromFactor, Types::Coordinate& toFactor,
              const Vector3D& offset,
              const Types::Coordinate initFromFactor = 0,
              const Types::Coordinate initToFactor = 1,
              const bool lowerClosed = false,
              const bool upperClosed = false ) const;
  
  int ClipY ( Types::Coordinate& fromFactor, Types::Coordinate& toFactor,
              const Vector3D& offset, 
              const Types::Coordinate initFromFactor = 0,
              const Types::Coordinate initToFactor = 1 ) const;
  
  int ClipZ ( Types::Coordinate& fromFactor, Types::Coordinate& toFactor,
              const Vector3D& offset,
              const Types::Coordinate initFromFactor = 0,
              const Types::Coordinate initToFactor = 1 ) const;
  
private:
  UniformVolume::CoordinateRegionType m_ClippingRegion;

  Vector3D DeltaX;

  Vector3D DeltaY;

  Vector3D DeltaZ;

};


} // namespace cmtk

#endif // #ifndef __cmtkVolumeClipping_h_included_