Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkImageClip Class Reference

#include <vtkImageClip.h>

Inheritance diagram for vtkImageClip:

Inheritance graph
Collaboration diagram for vtkImageClip:

Collaboration graph
List of all members.

Detailed Description

Reduces the image extent of the input.

vtkImageClip will make an image smaller. The output must have an image extent which is the subset of the input. The filter has two modes of operation: 1: By default, the data is not copied in this filter. Only the whole extent is modified. 2: If ClipDataOn is set, then you will get no more that the clipped extent.

vtkImageClip (Examples)
vtkImageClip (Tests)

Definition at line 41 of file vtkImageClip.h.

Public Types

typedef vtkImageAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void SetOutputWholeExtent (int piece, int numPieces)
void PrintSelf (ostream &os, vtkIndent indent)
void SetOutputWholeExtent (int extent[6], vtkInformation *outInfo=0)
void SetOutputWholeExtent (int minX, int maxX, int minY, int maxY, int minZ, int maxZ)
void GetOutputWholeExtent (int extent[6])
int * GetOutputWholeExtent ()
void ResetOutputWholeExtent ()
virtual void SetClipData (int)
virtual int GetClipData ()
virtual void ClipDataOn ()
virtual void ClipDataOff ()

Static Public Member Functions

static vtkImageClipNew ()
static int IsTypeOf (const char *type)
static vtkImageClipSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageClip ()
 ~vtkImageClip ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void CopyData (vtkImageData *inData, vtkImageData *outData, int *ext)
int SplitExtentTmp (int piece, int numPieces, int *ext)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

vtkTimeStamp CTime
int Initialized
int OutputWholeExtent [6]
int ClipData

Member Typedef Documentation

typedef vtkImageAlgorithm vtkImageClip::Superclass

Reimplemented from vtkImageAlgorithm.

Definition at line 45 of file vtkImageClip.h.

Constructor & Destructor Documentation

vtkImageClip::vtkImageClip  )  [protected]

vtkImageClip::~vtkImageClip  )  [inline, protected]

Definition at line 73 of file vtkImageClip.h.

Member Function Documentation

static vtkImageClip* vtkImageClip::New  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual const char* vtkImageClip::GetClassName  )  [virtual]

Reimplemented from vtkImageAlgorithm.

static int vtkImageClip::IsTypeOf const char *  type  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

virtual int vtkImageClip::IsA const char *  type  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

static vtkImageClip* vtkImageClip::SafeDownCast vtkObject o  )  [static]

Reimplemented from vtkImageAlgorithm.

void vtkImageClip::PrintSelf ostream &  os,
vtkIndent  indent

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageAlgorithm.

void vtkImageClip::SetOutputWholeExtent int  extent[6],
vtkInformation outInfo = 0

The whole extent of the output has to be set explicitly.

void vtkImageClip::SetOutputWholeExtent int  minX,
int  maxX,
int  minY,
int  maxY,
int  minZ,
int  maxZ

void vtkImageClip::GetOutputWholeExtent int  extent[6]  ) 

int* vtkImageClip::GetOutputWholeExtent  )  [inline]

Definition at line 54 of file vtkImageClip.h.

void vtkImageClip::ResetOutputWholeExtent  ) 

virtual void vtkImageClip::SetClipData int   )  [virtual]

By default, ClipData is off, and only the WholeExtent is modified. the data's extent may actually be larger. When this flag is on, the data extent will be no more than the OutputWholeExtent.

virtual int vtkImageClip::GetClipData  )  [virtual]

virtual void vtkImageClip::ClipDataOn  )  [virtual]

virtual void vtkImageClip::ClipDataOff  )  [virtual]

void vtkImageClip::SetOutputWholeExtent int  piece,
int  numPieces

Hack set output by piece

virtual int vtkImageClip::RequestInformation vtkInformation ,
vtkInformationVector **  ,
[protected, virtual]

Reimplemented from vtkImageAlgorithm.

void vtkImageClip::CopyData vtkImageData inData,
vtkImageData outData,
int *  ext

int vtkImageClip::SplitExtentTmp int  piece,
int  numPieces,
int *  ext

virtual int vtkImageClip::RequestData vtkInformation ,
vtkInformationVector **  ,
[protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkImageAlgorithm.

Member Data Documentation

vtkTimeStamp vtkImageClip::CTime [protected]

Definition at line 73 of file vtkImageClip.h.

int vtkImageClip::Initialized [protected]

Definition at line 77 of file vtkImageClip.h.

int vtkImageClip::OutputWholeExtent[6] [protected]

Definition at line 78 of file vtkImageClip.h.

int vtkImageClip::ClipData [protected]

Definition at line 80 of file vtkImageClip.h.

The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:48:52 2008 for VTK by  doxygen 1.4.3-20050530