---

vtkImageClip Class Reference

Reduces the image extent of the input. More...

#include <vtkImageClip.h>

Inheritance diagram for vtkImageClip:

[legend]Collaboration diagram for vtkImageClip:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetOutputWholeExtent (int extent[6])
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 ()
void	SetOutputWholeExtent (int piece, int numPieces)
Static Public Methods
vtkImageClip *	New ()
int	IsTypeOf (const char *type)
vtkImageClip *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImageClip ()
	~vtkImageClip ()
	vtkImageClip (const vtkImageClip &)
void	operator= (const vtkImageClip &)
void	ExecuteInformation (vtkImageData *inData, vtkImageData *outData)
void	ExecuteInformation ()
void	CopyData (vtkImageData *inData, vtkImageData *outData, int *ext)
void	Execute (vtkImageData *inData, vtkImageData *outData)
void	Execute ()
void	Execute (vtkImageData *output)
int	SplitExtentTmp (int piece, int numPieces, int *ext)
Protected Attributes
vtkTimeStamp	CTime
int	Initialized
int	OutputWholeExtent [6]
int	ClipData

---

Detailed Description

Reduces the image extent of the input.

Date:

2000/12/10 20:09:04

Revision:

1.27

Thanks:

Thanks to C. Charles Law who developed this class.

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.

Examples:

vtkImageClip (examples)

Definition at line 67 of file vtkImageClip.h.

---

Constructor & Destructor Documentation

vtkImageClip::vtkImageClip (    )  [protected]

vtkImageClip::~vtkImageClip (    )  [inline, protected]

Definition at line 95 of file vtkImageClip.h.

vtkImageClip::vtkImageClip (  const vtkImageClip &    )  [inline, protected]

Definition at line 96 of file vtkImageClip.h.

---

Member Function Documentation

vtkImageClip* vtkImageClip::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkImageToImageFilter.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageToImageFilter.

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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageToImageFilter.

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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageToImageFilter.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageToImageFilter.

void vtkImageClip::PrintSelf (  ostream &    os, vtkIndent    indent )  [virtual]

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 vtkImageToImageFilter.

void vtkImageClip::SetOutputWholeExtent (  int    extent[6] )

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 79 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

void vtkImageClip::operator= (  const vtkImageClip &    )  [inline, protected]

Definition at line 97 of file vtkImageClip.h.

void vtkImageClip::ExecuteInformation (  vtkImageData *    inData, vtkImageData *    outData )  [protected, virtual]

Reimplemented from vtkImageToImageFilter.

void vtkImageClip::ExecuteInformation (    )  [inline, protected, virtual]

Reimplemented from vtkImageToImageFilter. Definition at line 107 of file vtkImageClip.h.

void vtkImageClip::CopyData (  vtkImageData *    inData, vtkImageData *    outData, int *    ext )  [protected]

void vtkImageClip::Execute (  vtkImageData *    inData, vtkImageData *    outData )  [protected, virtual]

Reimplemented from vtkImageToImageFilter.

void vtkImageClip::Execute (    )  [inline, protected, virtual]

Reimplemented from vtkImageToImageFilter. Definition at line 111 of file vtkImageClip.h.

void vtkImageClip::Execute (  vtkImageData *    output )  [inline, protected, virtual]

Reimplemented from vtkImageToImageFilter. Definition at line 112 of file vtkImageClip.h.

int vtkImageClip::SplitExtentTmp (  int    piece, int    numPieces, int *    ext )  [protected]

---

Member Data Documentation

vtkTimeStamp vtkImageClip::CTime [protected]

Definition at line 100 of file vtkImageClip.h.

int vtkImageClip::Initialized [protected]

Definition at line 101 of file vtkImageClip.h.

int vtkImageClip::OutputWholeExtent[6] [protected]

Definition at line 102 of file vtkImageClip.h.

int vtkImageClip::ClipData [protected]

Definition at line 104 of file vtkImageClip.h.

---

The documentation for this class was generated from the following file:

• imaging/vtkImageClip.h

---