vtkImageStencilData Class Reference

#include <vtkImageStencilData.h>

Inheritance diagram for vtkImageStencilData:

[legend]Collaboration diagram for vtkImageStencilData:

[legend]List of all members.

Detailed Description

efficient description of an image stencil

vtkImageStencilData describes an image stencil in a manner which is efficient both in terms of speed and storage space. The stencil extents are stored for each x-row across the image (multiple extents per row if necessary) and can be retrieved via the GetNextExtent() method.

See also:: vtkImageStencilSource vtkImageStencil

Created by:

Gobbi, David

CVS contributions (if > 5%):

Gobbi, David (76%)
King, Brad (13%)
Martin, Ken (6%)

CVS logs (CVSweb):

.cxx (/Imaging/vtkImageStencilData.cxx)
.h (/Imaging/vtkImageStencilData.h)

Definition at line 44 of file vtkImageStencilData.h.

Public Types

typedef vtkDataObject Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

void Initialize ()

void DeepCopy (vtkDataObject *o)

void ShallowCopy (vtkDataObject *f)

void InternalImageStencilDataCopy (vtkImageStencilData *s)

int GetDataObjectType ()

int GetExtentType ()

void InsertNextExtent (int r1, int r2, int yIdx, int zIdx)

void AllocateExtents ()

void UpdateData ()

void PropagateUpdateExtent ()

void TriggerAsynchronousUpdate ()

int GetNextExtent (int &r1, int &r2, int xMin, int xMax, int yIdx, int zIdx, int &iter)

virtual void SetSpacing (double, double, double)

virtual void SetSpacing (double[3])

virtual double * GetSpacing ()

virtual void GetSpacing (double &, double &, double &)

virtual void GetSpacing (double[3])

virtual void SetOrigin (double, double, double)

virtual void SetOrigin (double[3])

virtual double * GetOrigin ()

virtual void GetOrigin (double &, double &, double &)

virtual void GetOrigin (double[3])

void SetExtent (int extent[6])

void SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)

int * GetExtent ()

void GetExtent (int &x1, int &x2, int &y1, int &y2, int &z1, int &z2)

void GetExtent (int *extent)

virtual void SetOldSpacing (double, double, double)

virtual void SetOldSpacing (double[3])

virtual double * GetOldSpacing ()

virtual void GetOldSpacing (double &, double &, double &)

virtual void GetOldSpacing (double[3])

virtual void SetOldOrigin (double, double, double)

virtual void SetOldOrigin (double[3])

virtual double * GetOldOrigin ()

virtual void GetOldOrigin (double &, double &, double &)

virtual void GetOldOrigin (double[3])

Static Public Member Functions

vtkImageStencilData * New ()

int IsTypeOf (const char *type)

vtkImageStencilData * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkImageStencilData ()

~vtkImageStencilData ()

int SpacingOrOriginHasChanged ()

Protected Attributes

double OldSpacing [3]

double OldOrigin [3]

double Spacing [3]

double Origin [3]

int NumberOfExtentEntries

int * ExtentListLengths

int ** ExtentLists

Member Typedef Documentation

typedef vtkDataObject vtkImageStencilData::Superclass

Reimplemented from vtkDataObject.
Definition at line 48 of file vtkImageStencilData.h.

Constructor & Destructor Documentation

vtkImageStencilData::vtkImageStencilData ( ) [protected]

vtkImageStencilData::~vtkImageStencilData ( ) [protected]

Member Function Documentation

vtkImageStencilData* vtkImageStencilData::New ( ) [static]

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

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

Reimplemented from vtkDataObject.

int vtkImageStencilData::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataObject.

virtual int vtkImageStencilData::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataObject.

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

Reimplemented from vtkDataObject.

void vtkImageStencilData::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 vtkDataObject.

void vtkImageStencilData::Initialize ( ) [virtual]

Restore data object to initial state,
Reimplemented from vtkDataObject.

void vtkImageStencilData::DeepCopy ( vtkDataObject * o ) [virtual]

Shallow and Deep copy. These copy the data, but not any of the pipeline connections.
Reimplemented from vtkDataObject.

void vtkImageStencilData::ShallowCopy ( vtkDataObject * f ) [virtual]

Shallow and Deep copy. These copy the data, but not any of the pipeline connections.
Reimplemented from vtkDataObject.

void vtkImageStencilData::InternalImageStencilDataCopy ( vtkImageStencilData * s )

int vtkImageStencilData::GetDataObjectType ( ) [inline, virtual]

Get the data type as an integer (this will return VTK_DATA_OBJECT for now, maybe a proper type constant will be reserved later).
Reimplemented from vtkDataObject.
Definition at line 58 of file vtkImageStencilData.h.

int vtkImageStencilData::GetExtentType ( ) [inline, virtual]

The extent type is 3D, just like vtkImageData.
Reimplemented from vtkDataObject.
Definition at line 61 of file vtkImageStencilData.h.

int vtkImageStencilData::GetNextExtent ( int & r1,

int & r2,

int xMin,

int xMax,

int yIdx,

int zIdx,

int & iter

)

Given the total output x extent [xMin,xMax] and the current y, z indices, return each sub-extent [r1,r2] that lies within within the unclipped region in sequence. A value of '0' is returned if no more sub-extents are available. The variable 'iter' must be initialized to zero before the first call, unless you want the complementary sub-extents in which case you must initialize 'iter' to -1. The variable 'iter' is used internally to keep track of which sub-extent should be returned next.

void vtkImageStencilData::InsertNextExtent ( int r1,

int r2,

int yIdx,

int zIdx

)

This method is used by vtkImageStencilDataSource to add an x sub extent [r1,r2] for the x row (yIdx,zIdx). The specified sub extent must not intersect any other sub extents along the same x row. As well, r1 and r2 must both be within the total x extent [Extent[0],Extent[1]].

virtual void vtkImageStencilData::SetSpacing ( double ,

double ,

double

) [virtual]

Set the desired spacing for the stencil. This must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.

virtual void vtkImageStencilData::SetSpacing ( double [3] ) [virtual]

Set the desired spacing for the stencil. This must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.

virtual double* vtkImageStencilData::GetSpacing ( ) [virtual]

Set the desired spacing for the stencil. This must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.

virtual void vtkImageStencilData::GetSpacing ( double & ,

double & ,

double &

) [virtual]

Set the desired spacing for the stencil. This must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.

virtual void vtkImageStencilData::GetSpacing ( double [3] ) [virtual]

Set the desired spacing for the stencil. This must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.

virtual void vtkImageStencilData::SetOrigin ( double ,

double ,

double

) [virtual]

Set the desired origin for the stencil. This must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.

virtual void vtkImageStencilData::SetOrigin ( double [3] ) [virtual]

Set the desired origin for the stencil. This must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.

virtual double* vtkImageStencilData::GetOrigin ( ) [virtual]

Set the desired origin for the stencil. This must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.

virtual void vtkImageStencilData::GetOrigin ( double & ,

double & ,

double &

) [virtual]

Set the desired origin for the stencil. This must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.

virtual void vtkImageStencilData::GetOrigin ( double [3] ) [virtual]

Set the desired origin for the stencil. This must be called before the stencil is Updated, ideally in the ExecuteInformation method of the imaging filter that is using the stencil.

void vtkImageStencilData::SetExtent ( int extent[6] )

Set the extent of the data. This is should be called only by vtkImageStencilSource, as it is part of the basic pipeline functionality.

void vtkImageStencilData::SetExtent ( int x1,

int x2,

int y1,

int y2,

int z1,

int z2

)

Set the extent of the data. This is should be called only by vtkImageStencilSource, as it is part of the basic pipeline functionality.

int* vtkImageStencilData::GetExtent ( )

Set the extent of the data. This is should be called only by vtkImageStencilSource, as it is part of the basic pipeline functionality.

void vtkImageStencilData::GetExtent ( int & x1,

int & x2,

int & y1,

int & y2,

int & z1,

int & z2

)

Set the extent of the data. This is should be called only by vtkImageStencilSource, as it is part of the basic pipeline functionality.

void vtkImageStencilData::GetExtent ( int * extent )

Set the extent of the data. This is should be called only by vtkImageStencilSource, as it is part of the basic pipeline functionality.

virtual void vtkImageStencilData::SetOldSpacing ( double ,

double ,

double

) [virtual]

Save the previous data spacing. This should be called only by vtkImageStencilSource.

virtual void vtkImageStencilData::SetOldSpacing ( double [3] ) [virtual]

Save the previous data spacing. This should be called only by vtkImageStencilSource.

virtual double* vtkImageStencilData::GetOldSpacing ( ) [virtual]

Save the previous data spacing. This should be called only by vtkImageStencilSource.

virtual void vtkImageStencilData::GetOldSpacing ( double & ,

double & ,

double &

) [virtual]

Save the previous data spacing. This should be called only by vtkImageStencilSource.

virtual void vtkImageStencilData::GetOldSpacing ( double [3] ) [virtual]

Save the previous data spacing. This should be called only by vtkImageStencilSource.

virtual void vtkImageStencilData::SetOldOrigin ( double ,

double ,

double

) [virtual]

Save the previous data origin. This should be called only by vtkImageStencilSource.

virtual void vtkImageStencilData::SetOldOrigin ( double [3] ) [virtual]

Save the previous data origin. This should be called only by vtkImageStencilSource.

virtual double* vtkImageStencilData::GetOldOrigin ( ) [virtual]

Save the previous data origin. This should be called only by vtkImageStencilSource.

virtual void vtkImageStencilData::GetOldOrigin ( double & ,

double & ,

double &

) [virtual]

Save the previous data origin. This should be called only by vtkImageStencilSource.

virtual void vtkImageStencilData::GetOldOrigin ( double [3] ) [virtual]

Save the previous data origin. This should be called only by vtkImageStencilSource.

void vtkImageStencilData::AllocateExtents ( )

Allocate space for the sub-extents. This is called by vtkImageStencilSource.

void vtkImageStencilData::UpdateData ( ) [virtual]

WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. Propagate the update back up the pipeline, and perform the actual work of updating on the way down. When the propagate arrives at a port, block and wait for the asynchronous update to finish on the other side. This propagation may early terminate based on the PipelineMTime.
Reimplemented from vtkDataObject.

void vtkImageStencilData::PropagateUpdateExtent ( ) [virtual]

WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. The update extent for this object is propagated up the pipeline. This propagation may early terminate based on the PipelineMTime.
Reimplemented from vtkDataObject.

void vtkImageStencilData::TriggerAsynchronousUpdate ( ) [virtual]

WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. Propagate back up the pipeline for ports and trigger the update on the other side of the port to allow for asynchronous parallel processing in the pipeline. This propagation may early terminate based on the PipelineMTime.
Reimplemented from vtkDataObject.

int vtkImageStencilData::SpacingOrOriginHasChanged ( ) [protected]

Check to see of the Spacing and Origin are different from the OldSpacing and OldOrigin.

Member Data Documentation

double vtkImageStencilData::OldSpacing[3] [protected]

Previous Spacing and Origin values, so that it is possible to know when an update is required because they have changed.
Definition at line 160 of file vtkImageStencilData.h.

double vtkImageStencilData::OldOrigin[3] [protected]

Previous Spacing and Origin values, so that it is possible to know when an update is required because they have changed.
Definition at line 161 of file vtkImageStencilData.h.

double vtkImageStencilData::Spacing[3] [protected]

The Spacing and Origin of the data.
Definition at line 166 of file vtkImageStencilData.h.

double vtkImageStencilData::Origin[3] [protected]

The Spacing and Origin of the data.
Definition at line 167 of file vtkImageStencilData.h.

int vtkImageStencilData::NumberOfExtentEntries [protected]

The actual 'data' is stored here.
Definition at line 172 of file vtkImageStencilData.h.

int* vtkImageStencilData::ExtentListLengths [protected]

The actual 'data' is stored here.
Definition at line 173 of file vtkImageStencilData.h.

int** vtkImageStencilData::ExtentLists [protected]

The actual 'data' is stored here.
Definition at line 174 of file vtkImageStencilData.h.

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

dox/Imaging/vtkImageStencilData.h


Public Types
typedef vtkDataObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	Initialize ()
void	DeepCopy (vtkDataObject *o)
void	ShallowCopy (vtkDataObject *f)
void	InternalImageStencilDataCopy (vtkImageStencilData *s)
int	GetDataObjectType ()
int	GetExtentType ()
void	InsertNextExtent (int r1, int r2, int yIdx, int zIdx)
void	AllocateExtents ()
void	UpdateData ()
void	PropagateUpdateExtent ()
void	TriggerAsynchronousUpdate ()

int	GetNextExtent (int &r1, int &r2, int xMin, int xMax, int yIdx, int zIdx, int &iter)

virtual void	SetSpacing (double, double, double)
virtual void	SetSpacing (double[3])
virtual double *	GetSpacing ()
virtual void	GetSpacing (double &, double &, double &)
virtual void	GetSpacing (double[3])

virtual void	SetOrigin (double, double, double)
virtual void	SetOrigin (double[3])
virtual double *	GetOrigin ()
virtual void	GetOrigin (double &, double &, double &)
virtual void	GetOrigin (double[3])

void	SetExtent (int extent[6])
void	SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
int *	GetExtent ()
void	GetExtent (int &x1, int &x2, int &y1, int &y2, int &z1, int &z2)
void	GetExtent (int *extent)

virtual void	SetOldSpacing (double, double, double)
virtual void	SetOldSpacing (double[3])
virtual double *	GetOldSpacing ()
virtual void	GetOldSpacing (double &, double &, double &)
virtual void	GetOldSpacing (double[3])

virtual void	SetOldOrigin (double, double, double)
virtual void	SetOldOrigin (double[3])
virtual double *	GetOldOrigin ()
virtual void	GetOldOrigin (double &, double &, double &)
virtual void	GetOldOrigin (double[3])
Static Public Member Functions
vtkImageStencilData *	New ()
int	IsTypeOf (const char *type)
vtkImageStencilData *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageStencilData ()
	~vtkImageStencilData ()
int	SpacingOrOriginHasChanged ()
Protected Attributes

double	OldSpacing [3]
double	OldOrigin [3]

double	Spacing [3]
double	Origin [3]

int	NumberOfExtentEntries
int *	ExtentListLengths
int **	ExtentLists