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

2D image display More...

#include <vtkImageMapper.h>

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

Public Types

typedef vtkMapper2D Superclass
- Public Types inherited from vtkMapper2D
typedef vtkAbstractMapper Superclass
- Public Types inherited from vtkAbstractMapper
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)
unsigned long int GetMTime ()
void RenderStart (vtkViewport *viewport, vtkActor2D *actor)
virtual void RenderData (vtkViewport *, vtkImageData *, vtkActor2D *)=0
virtual void SetColorWindow (double)
virtual double GetColorWindow ()
virtual void SetColorLevel (double)
virtual double GetColorLevel ()
virtual void SetZSlice (int)
virtual int GetZSlice ()
int GetWholeZMin ()
int GetWholeZMax ()
double GetColorShift ()
double GetColorScale ()
virtual void SetInput (vtkImageData *input)
vtkImageDataGetInput ()
virtual void SetRenderToRectangle (int)
virtual int GetRenderToRectangle ()
virtual void RenderToRectangleOn ()
virtual void RenderToRectangleOff ()
virtual void SetUseCustomExtents (int)
virtual int GetUseCustomExtents ()
virtual void UseCustomExtentsOn ()
virtual void UseCustomExtentsOff ()
virtual void SetCustomDisplayExtents (int data[])
virtual int * GetCustomDisplayExtents ()
virtual void GetCustomDisplayExtents (int data[4])
- Public Member Functions inherited from vtkMapper2D
virtual void RenderOverlay (vtkViewport *, vtkActor2D *)
virtual void RenderOpaqueGeometry (vtkViewport *, vtkActor2D *)
virtual void RenderTranslucentPolygonalGeometry (vtkViewport *, vtkActor2D *)
virtual int HasTranslucentPolygonalGeometry ()
- Public Member Functions inherited from vtkAbstractMapper
virtual void ReleaseGraphicsResources (vtkWindow *)
void SetClippingPlanes (vtkPlanes *planes)
void ShallowCopy (vtkAbstractMapper *m)
virtual double GetTimeToDraw ()
void AddClippingPlane (vtkPlane *plane)
void RemoveClippingPlane (vtkPlane *plane)
void RemoveAllClippingPlanes ()
virtual void SetClippingPlanes (vtkPlaneCollection *)
virtual vtkPlaneCollectionGetClippingPlanes ()
- 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 ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
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 ()
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 int IsTypeOf (const char *type)
static vtkImageMapperSafeDownCast (vtkObject *o)
static vtkImageMapperNew ()

Public Attributes

int DisplayExtent [6]

Protected Member Functions

 vtkImageMapper ()
 ~vtkImageMapper ()
virtual int FillInputPortInformation (int, vtkInformation *)
- Protected Member Functions inherited from vtkMapper2D
 vtkMapper2D ()
 ~vtkMapper2D ()
- Protected Member Functions inherited from vtkAbstractMapper
 vtkAbstractMapper ()
 ~vtkAbstractMapper ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillOutputPortInformation (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

double ColorWindow
double ColorLevel
int PositionAdjustment [2]
int ZSlice
int UseCustomExtents
int CustomDisplayExtents [4]
int RenderToRectangle

Additional Inherited Members

- 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

2D image display

vtkImageMapper provides 2D image display support for vtk. It is a Mapper2D subclass that can be associated with an Actor2D and placed within a RenderWindow or ImageWindow.

See Also
vtkMapper2D vtkActor2D
Tests:
vtkImageMapper (Tests)

Definition at line 39 of file vtkImageMapper.h.

Member Typedef Documentation

Definition at line 42 of file vtkImageMapper.h.

Constructor & Destructor Documentation

vtkImageMapper::vtkImageMapper ( )
protected
vtkImageMapper::~vtkImageMapper ( )
protected

Member Function Documentation

virtual const char* vtkImageMapper::GetClassName ( )
virtual

Reimplemented from vtkMapper2D.

Reimplemented in vtkOpenGLImageMapper, and vtkMesaImageMapper.

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

Reimplemented from vtkMapper2D.

Reimplemented in vtkOpenGLImageMapper, and vtkMesaImageMapper.

virtual int vtkImageMapper::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 vtkMapper2D.

Reimplemented in vtkOpenGLImageMapper, and vtkMesaImageMapper.

static vtkImageMapper* vtkImageMapper::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkMapper2D.

Reimplemented in vtkOpenGLImageMapper, and vtkMesaImageMapper.

static vtkImageMapper* vtkImageMapper::New ( )
static

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

Reimplemented from vtkAlgorithm.

Reimplemented in vtkOpenGLImageMapper, and vtkMesaImageMapper.

void vtkImageMapper::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 vtkMapper2D.

Reimplemented in vtkOpenGLImageMapper, and vtkMesaImageMapper.

unsigned long int vtkImageMapper::GetMTime ( )
virtual

Override Modifiedtime as we have added a lookuptable

Reimplemented from vtkAbstractMapper.

virtual void vtkImageMapper::SetColorWindow ( double  )
virtual

Set/Get the window value for window/level

virtual double vtkImageMapper::GetColorWindow ( )
virtual

Set/Get the window value for window/level

virtual void vtkImageMapper::SetColorLevel ( double  )
virtual

Set/Get the level value for window/level

virtual double vtkImageMapper::GetColorLevel ( )
virtual

Set/Get the level value for window/level

virtual void vtkImageMapper::SetZSlice ( int  )
virtual

Set/Get the current slice number. The axis Z in ZSlice does not necessarily have any relation to the z axis of the data on disk. It is simply the axis orthogonal to the x,y, display plane. GetWholeZMax and Min are convenience methods for obtaining the number of slices that can be displayed. Again the number of slices is in reference to the display z axis, which is not necessarily the z axis on disk. (due to reformatting etc)

virtual int vtkImageMapper::GetZSlice ( )
virtual

Set/Get the current slice number. The axis Z in ZSlice does not necessarily have any relation to the z axis of the data on disk. It is simply the axis orthogonal to the x,y, display plane. GetWholeZMax and Min are convenience methods for obtaining the number of slices that can be displayed. Again the number of slices is in reference to the display z axis, which is not necessarily the z axis on disk. (due to reformatting etc)

int vtkImageMapper::GetWholeZMin ( )

Set/Get the current slice number. The axis Z in ZSlice does not necessarily have any relation to the z axis of the data on disk. It is simply the axis orthogonal to the x,y, display plane. GetWholeZMax and Min are convenience methods for obtaining the number of slices that can be displayed. Again the number of slices is in reference to the display z axis, which is not necessarily the z axis on disk. (due to reformatting etc)

int vtkImageMapper::GetWholeZMax ( )

Set/Get the current slice number. The axis Z in ZSlice does not necessarily have any relation to the z axis of the data on disk. It is simply the axis orthogonal to the x,y, display plane. GetWholeZMax and Min are convenience methods for obtaining the number of slices that can be displayed. Again the number of slices is in reference to the display z axis, which is not necessarily the z axis on disk. (due to reformatting etc)

void vtkImageMapper::RenderStart ( vtkViewport viewport,
vtkActor2D actor 
)

Draw the image to the screen.

virtual void vtkImageMapper::RenderData ( vtkViewport ,
vtkImageData ,
vtkActor2D  
)
pure virtual

Function called by Render to actually draw the image to to the screen

Implemented in vtkOpenGLImageMapper, and vtkMesaImageMapper.

double vtkImageMapper::GetColorShift ( )

Methods used internally for performing the Window/Level mapping.

double vtkImageMapper::GetColorScale ( )

Methods used internally for performing the Window/Level mapping.

virtual void vtkImageMapper::SetInput ( vtkImageData input)
virtual

Set the Input of a filter.

vtkImageData* vtkImageMapper::GetInput ( )

Set the Input of a filter.

virtual void vtkImageMapper::SetRenderToRectangle ( int  )
virtual

If RenderToRectangle is set (by default not), then the imagemapper will render the image into the rectangle supplied by the Actor2D's PositionCoordinate and Position2Coordinate

virtual int vtkImageMapper::GetRenderToRectangle ( )
virtual

If RenderToRectangle is set (by default not), then the imagemapper will render the image into the rectangle supplied by the Actor2D's PositionCoordinate and Position2Coordinate

virtual void vtkImageMapper::RenderToRectangleOn ( )
virtual

If RenderToRectangle is set (by default not), then the imagemapper will render the image into the rectangle supplied by the Actor2D's PositionCoordinate and Position2Coordinate

virtual void vtkImageMapper::RenderToRectangleOff ( )
virtual

If RenderToRectangle is set (by default not), then the imagemapper will render the image into the rectangle supplied by the Actor2D's PositionCoordinate and Position2Coordinate

virtual void vtkImageMapper::SetUseCustomExtents ( int  )
virtual

Usually, the entire image is displayed, if UseCustomExtents is set (by default not), then the region supplied in the CustomDisplayExtents is used in preference. Note that the Custom extents are x,y only and the zslice is still applied

virtual int vtkImageMapper::GetUseCustomExtents ( )
virtual

Usually, the entire image is displayed, if UseCustomExtents is set (by default not), then the region supplied in the CustomDisplayExtents is used in preference. Note that the Custom extents are x,y only and the zslice is still applied

virtual void vtkImageMapper::UseCustomExtentsOn ( )
virtual

Usually, the entire image is displayed, if UseCustomExtents is set (by default not), then the region supplied in the CustomDisplayExtents is used in preference. Note that the Custom extents are x,y only and the zslice is still applied

virtual void vtkImageMapper::UseCustomExtentsOff ( )
virtual

Usually, the entire image is displayed, if UseCustomExtents is set (by default not), then the region supplied in the CustomDisplayExtents is used in preference. Note that the Custom extents are x,y only and the zslice is still applied

virtual void vtkImageMapper::SetCustomDisplayExtents ( int  data[])
virtual

The image extents which should be displayed with UseCustomExtents Note that the Custom extents are x,y only and the zslice is still applied

virtual int* vtkImageMapper::GetCustomDisplayExtents ( )
virtual

The image extents which should be displayed with UseCustomExtents Note that the Custom extents are x,y only and the zslice is still applied

virtual void vtkImageMapper::GetCustomDisplayExtents ( int  data[4])
virtual

The image extents which should be displayed with UseCustomExtents Note that the Custom extents are x,y only and the zslice is still applied

virtual int vtkImageMapper::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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

Member Data Documentation

int vtkImageMapper::DisplayExtent[6]

Definition at line 88 of file vtkImageMapper.h.

double vtkImageMapper::ColorWindow
protected

Definition at line 127 of file vtkImageMapper.h.

double vtkImageMapper::ColorLevel
protected

Definition at line 128 of file vtkImageMapper.h.

int vtkImageMapper::PositionAdjustment[2]
protected

Definition at line 130 of file vtkImageMapper.h.

int vtkImageMapper::ZSlice
protected

Definition at line 131 of file vtkImageMapper.h.

int vtkImageMapper::UseCustomExtents
protected

Definition at line 132 of file vtkImageMapper.h.

int vtkImageMapper::CustomDisplayExtents[4]
protected

Definition at line 133 of file vtkImageMapper.h.

int vtkImageMapper::RenderToRectangle
protected

Definition at line 134 of file vtkImageMapper.h.


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