vtkBlankStructuredGridWithImage Class Reference

#include <vtkBlankStructuredGridWithImage.h>

Inheritance diagram for vtkBlankStructuredGridWithImage:

[legend]

Collaboration diagram for vtkBlankStructuredGridWithImage:

[legend]

List of all members.

---

Detailed Description

blank a structured grid with an image

This filter can be used to set the blanking in a structured grid with an image. The filter takes two inputs: the structured grid to blank, and the image used to set the blanking. Make sure that the dimensions of both the image and the structured grid are identical.

Note that the image is interpreted as follows: zero values indicate that the structured grid point is blanked; non-zero values indicate that the structured grid point is visible. The blanking data must be unsigned char.

See also:

vtkStructuredGrid

Tests:

vtkBlankStructuredGridWithImage (Tests)

Definition at line 41 of file vtkBlankStructuredGridWithImage.h.

Public Types
typedef vtkStructuredGridAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetBlankingInput (vtkImageData *input)
vtkImageData *	GetBlankingInput ()
Static Public Member Functions
static vtkBlankStructuredGridWithImage *	New ()
static int	IsTypeOf (const char *type)
static vtkBlankStructuredGridWithImage *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkBlankStructuredGridWithImage ()
	~vtkBlankStructuredGridWithImage ()
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	FillInputPortInformation (int port, vtkInformation *info)

---

Member Typedef Documentation

typedef vtkStructuredGridAlgorithm vtkBlankStructuredGridWithImage::Superclass

Reimplemented from vtkStructuredGridAlgorithm.

Definition at line 45 of file vtkBlankStructuredGridWithImage.h.

---

Constructor & Destructor Documentation

vtkBlankStructuredGridWithImage::vtkBlankStructuredGridWithImage

(

)

[protected]

vtkBlankStructuredGridWithImage::~vtkBlankStructuredGridWithImage

(

)

[protected]

---

Member Function Documentation

static vtkBlankStructuredGridWithImage* vtkBlankStructuredGridWithImage::New

(

)

[static]

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

Reimplemented from vtkStructuredGridAlgorithm.

virtual const char* vtkBlankStructuredGridWithImage::GetClassName

(

)

[virtual]

Reimplemented from vtkStructuredGridAlgorithm.

static int vtkBlankStructuredGridWithImage::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkStructuredGridAlgorithm.

virtual int vtkBlankStructuredGridWithImage::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkStructuredGridAlgorithm.

static vtkBlankStructuredGridWithImage* vtkBlankStructuredGridWithImage::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkStructuredGridAlgorithm.

void vtkBlankStructuredGridWithImage::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 vtkStructuredGridAlgorithm.

void vtkBlankStructuredGridWithImage::SetBlankingInput

(

vtkImageData *

input

)

Set / get the input image used to perform the blanking.

vtkImageData* vtkBlankStructuredGridWithImage::GetBlankingInput

(

)

Set / get the input image used to perform the blanking.

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

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

Reimplemented from vtkStructuredGridAlgorithm.

virtual int vtkBlankStructuredGridWithImage::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			[protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkStructuredGridAlgorithm.

---

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

• dox/Graphics/vtkBlankStructuredGridWithImage.h