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

#include <vtkImageClip.h>

Inheritance diagram for vtkImageClip:

Collaboration diagram for vtkImageClip:

Public Types
typedef vtkImageAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkImageClip *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	ResetOutputWholeExtent ()
void	SetOutputWholeExtent (int piece, int numPieces)

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 ()

virtual void	SetClipData (int)
virtual int	GetClipData ()
virtual void	ClipDataOn ()
virtual void	ClipDataOff ()
Static Public Member Functions
static vtkImageClip *	New ()
static int	IsTypeOf (const char *type)
static vtkImageClip *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageClip ()
	~vtkImageClip ()
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
void	CopyData (vtkImageData inData, vtkImageData outData, int *ext)
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
Protected Attributes
vtkTimeStamp	CTime
int	Initialized
int	OutputWholeExtent [6]
int	ClipData

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.

Examples:: vtkImageClip (Examples)

Tests:: vtkImageClip (Tests)

Definition at line 42 of file vtkImageClip.h.

Member Typedef Documentation

typedef vtkImageAlgorithm vtkImageClip::Superclass

Reimplemented from vtkImageAlgorithm.

Definition at line 46 of file vtkImageClip.h.

Constructor & Destructor Documentation

vtkImageClip::vtkImageClip ( ) [protected]

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

Definition at line 74 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.

static int vtkImageClip::IsTypeOf ( const char * name ) [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 vtkImageAlgorithm.

virtual int vtkImageClip::IsA ( const char * name ) [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 vtkImageAlgorithm.

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

Reimplemented from vtkImageAlgorithm.

virtual vtkObjectBase* vtkImageClip::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkImageAlgorithm.

vtkImageClip* vtkImageClip::NewInstance ( ) const

Reimplemented from vtkImageAlgorithm.

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

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

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

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

int* vtkImageClip::GetOutputWholeExtent ( ) [inline]

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

Definition at line 55 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]

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 void vtkImageClip::ClipDataOn ( ) [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 void vtkImageClip::ClipDataOff ( ) [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.

void vtkImageClip::SetOutputWholeExtent	(	int	piece,
		int	numPieces
	)

Hack set output by piece

virtual int vtkImageClip::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		`[protected, virtual]`

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

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

virtual int vtkImageClip::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		`[protected, virtual]`

This is called in response to a REQUEST_DATA request from the executive. Subclasses should override either this method or the ExecuteDataWithInformation method in order to generate data for their outputs. For images, the output arrays will already be allocated, so all that is necessary is to fill in the voxel values.

Reimplemented from vtkImageAlgorithm.