---

vtkBlankStructuredGridWithImage Class Reference

blank a structured grid with an image. More...

#include <vtkBlankStructuredGridWithImage.h>

Inheritance diagram for vtkBlankStructuredGridWithImage:

[legend]Collaboration diagram for vtkBlankStructuredGridWithImage:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetBlankingInput (vtkImageData *input)
vtkImageData *	GetBlankingInput ()
Static Public Methods
vtkBlankStructuredGridWithImage *	New ()
int	IsTypeOf (const char *type)
vtkBlankStructuredGridWithImage *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkBlankStructuredGridWithImage ()
	~vtkBlankStructuredGridWithImage ()
void	Execute ()

---

Detailed Description

blank a structured grid with an image.

Date:

2001/10/11 13:36:44

Revision:

1.4

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 69 of file vtkBlankStructuredGridWithImage.h.

---

Constructor & Destructor Documentation

vtkBlankStructuredGridWithImage::vtkBlankStructuredGridWithImage (    )  [inline, protected]

Definition at line 83 of file vtkBlankStructuredGridWithImage.h.

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

Definition at line 84 of file vtkBlankStructuredGridWithImage.h.

---

Member Function Documentation

vtkBlankStructuredGridWithImage* vtkBlankStructuredGridWithImage::New (    )  [static]

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

virtual const char* vtkBlankStructuredGridWithImage::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 vtkStructuredGridToStructuredGridFilter.

int vtkBlankStructuredGridWithImage::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 vtkStructuredGridToStructuredGridFilter.

virtual int vtkBlankStructuredGridWithImage::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 vtkStructuredGridToStructuredGridFilter.

vtkBlankStructuredGridWithImage* vtkBlankStructuredGridWithImage::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 vtkStructuredGridToStructuredGridFilter.

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

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.

void vtkBlankStructuredGridWithImage::Execute (    )  [protected, virtual]

This method is the old style execute method Reimplemented from vtkSource.

---

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

• Graphics/vtkBlankStructuredGridWithImage.h

---