VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkWindowToImageFilter Class Reference

Use a vtkWindow as input to image pipeline. More...

#include <vtkWindowToImageFilter.h>

Inheritance diagram for vtkWindowToImageFilter:
[legend]
Collaboration diagram for vtkWindowToImageFilter:
[legend]

Public Types

typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetInput (vtkWindow *input)
 
vtkImageDataGetOutput ()
 
virtual vtkWindowGetInput ()
 
virtual void SetMagnification (int)
 
virtual int GetMagnification ()
 
virtual void SetFixBoundary (bool)
 
virtual bool GetFixBoundary ()
 
virtual void FixBoundaryOn ()
 
virtual void FixBoundaryOff ()
 
virtual void ReadFrontBufferOn ()
 
virtual void ReadFrontBufferOff ()
 
virtual int GetReadFrontBuffer ()
 
virtual void SetReadFrontBuffer (int)
 
virtual void ShouldRerenderOn ()
 
virtual void ShouldRerenderOff ()
 
virtual void SetShouldRerender (int)
 
virtual int GetShouldRerender ()
 
virtual void SetViewport (double, double, double, double)
 
virtual void SetViewport (double[4])
 
virtual double * GetViewport ()
 
virtual void GetViewport (double data[4])
 
virtual void SetInputBufferType (int)
 
virtual int GetInputBufferType ()
 
void SetInputBufferTypeToRGB ()
 
void SetInputBufferTypeToRGBA ()
 
void SetInputBufferTypeToZBuffer ()
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
virtual void Update ()
 
virtual void UpdateInformation ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkWindowToImageFilterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkWindowToImageFilterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkWindowToImageFilter ()
 
 ~vtkWindowToImageFilter ()
 
void RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual void RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
void Rescale2DActors ()
 
void Shift2DActors (int x, int y)
 
void Restore2DActors ()
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
virtual void SetErrorCode (unsigned long)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkWindowInput
 
int Magnification
 
int ReadFrontBuffer
 
int ShouldRerender
 
double Viewport [4]
 
int InputBufferType
 
bool FixBoundary
 
vtkWTI2DHelperClass * StoredData
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 
- Friends inherited from vtkObject

Detailed Description

Use a vtkWindow as input to image pipeline.

vtkWindowToImageFilter provides methods needed to read the data in a vtkWindow and use it as input to the imaging pipeline. This is useful for saving an image to a file for example. The window can be read as either RGB or RGBA pixels; in addition, the depth buffer can also be read. RGB and RGBA pixels are of type unsigned char, while Z-Buffer data is returned as floats. Use this filter to convert RenderWindows or ImageWindows to an image format.

Warning
A vtkWindow doesn't behave like other parts of the VTK pipeline: its modification time doesn't get updated when an image is rendered. As a result, naive use of vtkWindowToImageFilter will produce an image of the first image that the window rendered, but which is never updated on subsequent window updates. This behavior is unexpected and in general undesirable.
To force an update of the output image, call vtkWindowToImageFilter's Modified method after rendering to the window.
In VTK versions 4 and later, this filter is part of the canonical way to output an image of a window to a file (replacing the obsolete SaveImageAsPPM method for vtkRenderWindows that existed in 3.2 and earlier). Connect this filter to the output of the window, and filter's output to a writer such as vtkPNGWriter.
Reading back alpha planes is dependent on the correct operation of the render window's GetRGBACharPixelData method, which in turn is dependent on the configuration of the window's alpha planes. As of VTK 4.4+, machine-independent behavior is not automatically assured because of these dependencies.
See Also
vtkWindow vtkRenderLargeImage
Examples:
vtkWindowToImageFilter (Examples)
Tests:
vtkWindowToImageFilter (Tests)

Definition at line 74 of file vtkWindowToImageFilter.h.

Member Typedef Documentation

Definition at line 79 of file vtkWindowToImageFilter.h.

Constructor & Destructor Documentation

vtkWindowToImageFilter::vtkWindowToImageFilter ( )
protected
vtkWindowToImageFilter::~vtkWindowToImageFilter ( )
protected

Member Function Documentation

static vtkWindowToImageFilter* vtkWindowToImageFilter::New ( )
static
virtual const char* vtkWindowToImageFilter::GetClassName ( )
virtual

Reimplemented from vtkAlgorithm.

static int vtkWindowToImageFilter::IsTypeOf ( const char *  type)
static
virtual int vtkWindowToImageFilter::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 vtkAlgorithm.

static vtkWindowToImageFilter* vtkWindowToImageFilter::SafeDownCast ( vtkObject o)
static
void vtkWindowToImageFilter::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 vtkAlgorithm.

void vtkWindowToImageFilter::SetInput ( vtkWindow input)

Indicates what renderer to get the pixel data from. Initial value is 0.

virtual vtkWindow* vtkWindowToImageFilter::GetInput ( )
virtual

Returns which renderer is being used as the source for the pixel data. Initial value is 0.

virtual void vtkWindowToImageFilter::SetMagnification ( int  )
virtual

The magnification of the current render window. Initial value is 1.

virtual int vtkWindowToImageFilter::GetMagnification ( )
virtual

The magnification of the current render window. Initial value is 1.

virtual void vtkWindowToImageFilter::SetFixBoundary ( bool  )
virtual

When this->Magnification > 1, this class render the full image in tiles. Sometimes that results in artificial artifacts at internal tile seams. To overcome this issue, set this flag to true.

virtual bool vtkWindowToImageFilter::GetFixBoundary ( )
virtual

When this->Magnification > 1, this class render the full image in tiles. Sometimes that results in artificial artifacts at internal tile seams. To overcome this issue, set this flag to true.

virtual void vtkWindowToImageFilter::FixBoundaryOn ( )
virtual

When this->Magnification > 1, this class render the full image in tiles. Sometimes that results in artificial artifacts at internal tile seams. To overcome this issue, set this flag to true.

virtual void vtkWindowToImageFilter::FixBoundaryOff ( )
virtual

When this->Magnification > 1, this class render the full image in tiles. Sometimes that results in artificial artifacts at internal tile seams. To overcome this issue, set this flag to true.

virtual void vtkWindowToImageFilter::ReadFrontBufferOn ( )
virtual

Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.

virtual void vtkWindowToImageFilter::ReadFrontBufferOff ( )
virtual

Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.

virtual int vtkWindowToImageFilter::GetReadFrontBuffer ( )
virtual

Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.

virtual void vtkWindowToImageFilter::SetReadFrontBuffer ( int  )
virtual

Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.

virtual void vtkWindowToImageFilter::ShouldRerenderOn ( )
virtual

Set/get whether to re-render the input window. Initial value is true. (This option makes no difference if Magnification > 1.)

virtual void vtkWindowToImageFilter::ShouldRerenderOff ( )
virtual

Set/get whether to re-render the input window. Initial value is true. (This option makes no difference if Magnification > 1.)

virtual void vtkWindowToImageFilter::SetShouldRerender ( int  )
virtual

Set/get whether to re-render the input window. Initial value is true. (This option makes no difference if Magnification > 1.)

virtual int vtkWindowToImageFilter::GetShouldRerender ( )
virtual

Set/get whether to re-render the input window. Initial value is true. (This option makes no difference if Magnification > 1.)

virtual void vtkWindowToImageFilter::SetViewport ( double  ,
double  ,
double  ,
double   
)
virtual

Set/get the extents to be used to generate the image. Initial value is {0,0,1,1} (This option does not work if Magnification > 1.)

virtual void vtkWindowToImageFilter::SetViewport ( double  [4])
virtual

Set/get the extents to be used to generate the image. Initial value is {0,0,1,1} (This option does not work if Magnification > 1.)

virtual double* vtkWindowToImageFilter::GetViewport ( )
virtual

Set/get the extents to be used to generate the image. Initial value is {0,0,1,1} (This option does not work if Magnification > 1.)

virtual void vtkWindowToImageFilter::GetViewport ( double  data[4])
virtual

Set/get the extents to be used to generate the image. Initial value is {0,0,1,1} (This option does not work if Magnification > 1.)

virtual void vtkWindowToImageFilter::SetInputBufferType ( int  )
virtual

Set/get the window buffer from which data will be read. Choices include VTK_RGB (read the color image from the window), VTK_RGBA (same, but include the alpha channel), and VTK_ZBUFFER (depth buffer, returned as a float array). Initial value is VTK_RGB.

virtual int vtkWindowToImageFilter::GetInputBufferType ( )
virtual

Set/get the window buffer from which data will be read. Choices include VTK_RGB (read the color image from the window), VTK_RGBA (same, but include the alpha channel), and VTK_ZBUFFER (depth buffer, returned as a float array). Initial value is VTK_RGB.

void vtkWindowToImageFilter::SetInputBufferTypeToRGB ( )
inline

Set/get the window buffer from which data will be read. Choices include VTK_RGB (read the color image from the window), VTK_RGBA (same, but include the alpha channel), and VTK_ZBUFFER (depth buffer, returned as a float array). Initial value is VTK_RGB.

Definition at line 137 of file vtkWindowToImageFilter.h.

void vtkWindowToImageFilter::SetInputBufferTypeToRGBA ( )
inline

Set/get the window buffer from which data will be read. Choices include VTK_RGB (read the color image from the window), VTK_RGBA (same, but include the alpha channel), and VTK_ZBUFFER (depth buffer, returned as a float array). Initial value is VTK_RGB.

Definition at line 138 of file vtkWindowToImageFilter.h.

void vtkWindowToImageFilter::SetInputBufferTypeToZBuffer ( )
inline

Set/get the window buffer from which data will be read. Choices include VTK_RGB (read the color image from the window), VTK_RGBA (same, but include the alpha channel), and VTK_ZBUFFER (depth buffer, returned as a float array). Initial value is VTK_RGB.

Definition at line 139 of file vtkWindowToImageFilter.h.

vtkImageData* vtkWindowToImageFilter::GetOutput ( )

Get the output data object for a port on this algorithm.

virtual int vtkWindowToImageFilter::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
virtual

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

void vtkWindowToImageFilter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protected
virtual void vtkWindowToImageFilter::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual
virtual int vtkWindowToImageFilter::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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

Reimplemented from vtkAlgorithm.

void vtkWindowToImageFilter::Rescale2DActors ( )
protected
void vtkWindowToImageFilter::Shift2DActors ( int  x,
int  y 
)
protected
void vtkWindowToImageFilter::Restore2DActors ( )
protected

Member Data Documentation

vtkWindow* vtkWindowToImageFilter::Input
protected

Definition at line 158 of file vtkWindowToImageFilter.h.

int vtkWindowToImageFilter::Magnification
protected

Definition at line 159 of file vtkWindowToImageFilter.h.

int vtkWindowToImageFilter::ReadFrontBuffer
protected

Definition at line 160 of file vtkWindowToImageFilter.h.

int vtkWindowToImageFilter::ShouldRerender
protected

Definition at line 161 of file vtkWindowToImageFilter.h.

double vtkWindowToImageFilter::Viewport[4]
protected

Definition at line 162 of file vtkWindowToImageFilter.h.

int vtkWindowToImageFilter::InputBufferType
protected

Definition at line 163 of file vtkWindowToImageFilter.h.

bool vtkWindowToImageFilter::FixBoundary
protected

Definition at line 164 of file vtkWindowToImageFilter.h.

vtkWTI2DHelperClass* vtkWindowToImageFilter::StoredData
protected

Definition at line 180 of file vtkWindowToImageFilter.h.


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