vtkImageAppend Class Reference

#include <vtkImageAppend.h>

Inheritance diagram for vtkImageAppend:

Inheritance graph
[legend]
Collaboration diagram for vtkImageAppend:

Collaboration graph
[legend]

List of all members.


Detailed Description

Collects data from multiple inputs into one image.

vtkImageAppend takes the components from multiple inputs and merges them into one output. The output images are append along the "AppendAxis". Except for the append axis, all inputs must have the same extent. All inputs must have the same number of scalar components. A future extension might be to pad or clip inputs to have the same extent. The output has the same origin and spacing as the first input. The origin and spacing of all other inputs are ignored. All inputs must have the same scalar type.

Tests:
vtkImageAppend (Tests)

Definition at line 36 of file vtkImageAppend.h.


Public Types

typedef vtkThreadedImageAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void ReplaceNthInputConnection (int idx, vtkAlgorithmOutput *input)
int GetNumberOfInputs ()
void SetInput (int num, vtkDataObject *input)
void SetInput (vtkDataObject *input)
vtkDataObjectGetInput (int num)
vtkDataObjectGetInput ()
virtual void SetAppendAxis (int)
virtual int GetAppendAxis ()
virtual void SetPreserveExtents (int)
virtual int GetPreserveExtents ()
virtual void PreserveExtentsOn ()
virtual void PreserveExtentsOff ()

Static Public Member Functions

static vtkImageAppendNew ()
static int IsTypeOf (const char *type)
static vtkImageAppendSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageAppend ()
 ~vtkImageAppend ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int ext[6], int id)
virtual int FillInputPortInformation (int, vtkInformation *)
void InitOutput (int outExt[6], vtkImageData *outData)
void InternalComputeInputUpdateExtent (int *inExt, int *outExt, int *inWextent, int whichInput)

Protected Attributes

int PreserveExtents
int AppendAxis
int * Shifts

Member Typedef Documentation

Reimplemented from vtkThreadedImageAlgorithm.

Definition at line 40 of file vtkImageAppend.h.


Constructor & Destructor Documentation

vtkImageAppend::vtkImageAppend (  )  [protected]

vtkImageAppend::~vtkImageAppend (  )  [protected]


Member Function Documentation

static vtkImageAppend* vtkImageAppend::New (  )  [static]

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

Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkThreadedImageAlgorithm.

static int vtkImageAppend::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 vtkThreadedImageAlgorithm.

virtual int vtkImageAppend::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 vtkThreadedImageAlgorithm.

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

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageAppend::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 vtkThreadedImageAlgorithm.

virtual void vtkImageAppend::ReplaceNthInputConnection ( int  idx,
vtkAlgorithmOutput input 
) [virtual]

Replace one of the input connections with a new input. You can only replace input connections that you previously created with AddInputConnection() or, in the case of the first input, with SetInputConnection().

void vtkImageAppend::SetInput ( int  num,
vtkDataObject input 
)

Set an Input of this filter. This method is only for support of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.

Reimplemented from vtkImageAlgorithm.

void vtkImageAppend::SetInput ( vtkDataObject input  )  [inline]

Set an Input of this filter. This method is only for support of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.

Reimplemented from vtkImageAlgorithm.

Definition at line 55 of file vtkImageAppend.h.

vtkDataObject* vtkImageAppend::GetInput ( int  num  ) 

Get one input to this filter. This method is only for support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetInputConnection(0, num).

Reimplemented from vtkImageAlgorithm.

vtkDataObject* vtkImageAppend::GetInput (  )  [inline]

Get one input to this filter. This method is only for support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetInputConnection(0, num).

Reimplemented from vtkImageAlgorithm.

Definition at line 63 of file vtkImageAppend.h.

int vtkImageAppend::GetNumberOfInputs (  )  [inline]

Get the number of inputs to this filter. This method is only for support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetNumberOfInputConnections(0).

Definition at line 69 of file vtkImageAppend.h.

virtual void vtkImageAppend::SetAppendAxis ( int   )  [virtual]

This axis is expanded to hold the multiple images. The default AppendAxis is the X axis. If you want to create a volue from a series of XY images, then you should set the AppendAxis to 2 (Z axis).

virtual int vtkImageAppend::GetAppendAxis (  )  [virtual]

This axis is expanded to hold the multiple images. The default AppendAxis is the X axis. If you want to create a volue from a series of XY images, then you should set the AppendAxis to 2 (Z axis).

virtual void vtkImageAppend::SetPreserveExtents ( int   )  [virtual]

By default "PreserveExtents" is off and the append axis is used. When "PreseveExtents" is on, the extent of the inputs is used to place the image in the output. The whole extent of the output is the union of the input whole extents. Any portion of the output not covered by the inputs is set to zero. The origin and spacing is taken from the first input.

virtual int vtkImageAppend::GetPreserveExtents (  )  [virtual]

By default "PreserveExtents" is off and the append axis is used. When "PreseveExtents" is on, the extent of the inputs is used to place the image in the output. The whole extent of the output is the union of the input whole extents. Any portion of the output not covered by the inputs is set to zero. The origin and spacing is taken from the first input.

virtual void vtkImageAppend::PreserveExtentsOn (  )  [virtual]

By default "PreserveExtents" is off and the append axis is used. When "PreseveExtents" is on, the extent of the inputs is used to place the image in the output. The whole extent of the output is the union of the input whole extents. Any portion of the output not covered by the inputs is set to zero. The origin and spacing is taken from the first input.

virtual void vtkImageAppend::PreserveExtentsOff (  )  [virtual]

By default "PreserveExtents" is off and the append axis is used. When "PreseveExtents" is on, the extent of the inputs is used to place the image in the output. The whole extent of the output is the union of the input whole extents. Any portion of the output not covered by the inputs is set to zero. The origin and spacing is taken from the first input.

virtual int vtkImageAppend::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

virtual int vtkImageAppend::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

void vtkImageAppend::ThreadedRequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector,
vtkImageData ***  inData,
vtkImageData **  outData,
int  extent[6],
int  threadId 
) [protected, virtual]

If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that the thread functions can call this method.

Reimplemented from vtkThreadedImageAlgorithm.

virtual int vtkImageAppend::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 vtkImageAlgorithm.

void vtkImageAppend::InitOutput ( int  outExt[6],
vtkImageData outData 
) [protected]

void vtkImageAppend::InternalComputeInputUpdateExtent ( int *  inExt,
int *  outExt,
int *  inWextent,
int  whichInput 
) [protected]


Member Data Documentation

Definition at line 95 of file vtkImageAppend.h.

int vtkImageAppend::AppendAxis [protected]

Definition at line 96 of file vtkImageAppend.h.

int* vtkImageAppend::Shifts [protected]

Definition at line 98 of file vtkImageAppend.h.


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

Generated on Sat Dec 27 13:28:57 2008 for VTK by  doxygen 1.5.6