---

vtkImageDataStreamer Class Reference

Initiates streaming on image data. More...

#include <vtkImageDataStreamer.h>

Inheritance diagram for vtkImageDataStreamer:

[legend]Collaboration diagram for vtkImageDataStreamer:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetMemoryLimit (unsigned long)
virtual unsigned long	GetMemoryLimit ()
void	SetSplitModeToBlock ()
void	SetSplitModeToXSlab ()
void	SetSplitModeToYSlab ()
void	SetSplitModeToZSlab ()
void	UpdateInformation ()
void	UpdateData (vtkDataObject *out)
void	TriggerAsynchronousUpdate ()
virtual void	SetIncrementalUpdate (int)
virtual int	GetIncrementalUpdate ()
virtual void	IncrementalUpdateOn ()
virtual void	IncrementalUpdateOff ()
Static Public Methods
vtkImageDataStreamer *	New ()
int	IsTypeOf (const char *type)
vtkImageDataStreamer *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImageDataStreamer ()
	~vtkImageDataStreamer ()
	vtkImageDataStreamer (const vtkImageDataStreamer &)
void	operator= (const vtkImageDataStreamer &)
Protected Attributes
unsigned long	MemoryLimit
int	SplitMode
int	IncrementalUpdate
int	ProcessExtent [6]
int	DataWasPassed
vtkImageDataStreamerExtentStack	ExtentStack

---

Detailed Description

Initiates streaming on image data.

Date:

2000/12/10 20:09:05

Revision:

1.14

To satisfy a request, this filter calls update on its input many times with smaller update extents. All processing up stream streams smaller pieces.

Examples:

vtkImageDataStreamer (examples)

Definition at line 94 of file vtkImageDataStreamer.h.

---

Constructor & Destructor Documentation

vtkImageDataStreamer::vtkImageDataStreamer (    )  [protected]

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

Definition at line 139 of file vtkImageDataStreamer.h.

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

Definition at line 140 of file vtkImageDataStreamer.h.

---

Member Function Documentation

vtkImageDataStreamer* vtkImageDataStreamer::New (    )  [static]

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

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

vtkImageDataStreamer* vtkImageDataStreamer::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 vtkImageDataStreamer::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.

virtual void vtkImageDataStreamer::SetMemoryLimit (  unsigned    long )  [virtual]

Set / Get the memory limit in kilobytes.

virtual unsigned long vtkImageDataStreamer::GetMemoryLimit (    )  [virtual]

void vtkImageDataStreamer::SetSplitModeToBlock (    )  [inline]

How should the streamer break up extents. Block mode tries to break an extent up into cube blocks. It always chooses the largest axis to split. Slab mode first breaks up the Z axis. If it gets to one slice, then it starts breaking up other axes. Definition at line 109 of file vtkImageDataStreamer.h.

void vtkImageDataStreamer::SetSplitModeToXSlab (    )  [inline]

Definition at line 111 of file vtkImageDataStreamer.h.

void vtkImageDataStreamer::SetSplitModeToYSlab (    )  [inline]

Definition at line 113 of file vtkImageDataStreamer.h.

void vtkImageDataStreamer::SetSplitModeToZSlab (    )  [inline]

Definition at line 115 of file vtkImageDataStreamer.h.

void vtkImageDataStreamer::UpdateInformation (    )  [virtual]

Need to override since this is where the check for incremental will be done Reimplemented from vtkSource.

void vtkImageDataStreamer::UpdateData (  vtkDataObject *    out )  [virtual]

Need to override since this is where streaming will be done Reimplemented from vtkSource.

void vtkImageDataStreamer::TriggerAsynchronousUpdate (    )  [virtual]

Need to override and do nothing since it should be triggered during the update data pass due to streaming Reimplemented from vtkSource.

virtual void vtkImageDataStreamer::SetIncrementalUpdate (  int    )  [virtual]

Is this an incremental streamer? If yes, then each update of this filter will produce another chunk of the output - update must be called multiple times to generate the whole output. If no, then one update produces all of the output.

virtual int vtkImageDataStreamer::GetIncrementalUpdate (    )  [virtual]

virtual void vtkImageDataStreamer::IncrementalUpdateOn (    )  [virtual]

virtual void vtkImageDataStreamer::IncrementalUpdateOff (    )  [virtual]

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

Definition at line 141 of file vtkImageDataStreamer.h.

---

Member Data Documentation

unsigned long vtkImageDataStreamer::MemoryLimit [protected]

Definition at line 143 of file vtkImageDataStreamer.h.

int vtkImageDataStreamer::SplitMode [protected]

Definition at line 144 of file vtkImageDataStreamer.h.

int vtkImageDataStreamer::IncrementalUpdate [protected]

Definition at line 145 of file vtkImageDataStreamer.h.

int vtkImageDataStreamer::ProcessExtent[6] [protected]

Definition at line 146 of file vtkImageDataStreamer.h.

int vtkImageDataStreamer::DataWasPassed [protected]

Definition at line 147 of file vtkImageDataStreamer.h.

vtkImageDataStreamerExtentStack vtkImageDataStreamer::ExtentStack [protected]

Definition at line 149 of file vtkImageDataStreamer.h.

---

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

• imaging/vtkImageDataStreamer.h

---