efficient description of an image stencil More...

#include <vtkImageStencilData.h>

Inheritance diagram for vtkImageStencilData:

Collaboration diagram for vtkImageStencilData:

Public Types
typedef vtkDataObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkImageStencilData *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	Initialize ()
void	DeepCopy (vtkDataObject *o)
void	ShallowCopy (vtkDataObject *f)
void	InternalImageStencilDataCopy (vtkImageStencilData *s)
int	GetDataObjectType ()
int	GetExtentType ()
int	IsInside (int xIdx, int yIdx, int zIdx)
void	InsertNextExtent (int r1, int r2, int yIdx, int zIdx)
void	InsertAndMergeExtent (int r1, int r2, int yIdx, int zIdx)
void	RemoveExtent (int r1, int r2, int yIdx, int zIdx)
void	AllocateExtents ()
void	Fill ()
virtual void	CopyInformationFromPipeline (vtkInformation *meta_data)
virtual void	Add (vtkImageStencilData *)
virtual void	Subtract (vtkImageStencilData *)
virtual void	Replace (vtkImageStencilData *)
virtual int	Clip (int extent[6])

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)
virtual int *	GetExtent ()
virtual void	GetExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetExtent (int[6])
Static Public Member Functions
static vtkImageStencilData *	New ()
static int	IsTypeOf (const char *type)
static vtkImageStencilData *	SafeDownCast (vtkObjectBase *o)

static vtkImageStencilData *	GetData (vtkInformation *info)
static vtkImageStencilData *	GetData (vtkInformationVector *v, int i=0)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageStencilData ()
	~vtkImageStencilData ()
void	CopyOriginAndSpacingFromPipeline (vtkInformation *meta_data)
virtual void	InternalAdd (vtkImageStencilData *)
void	CollapseAdditionalIntersections (int r2, int idx, int *clist, int &clistlen)
Protected Attributes
int	Extent [6]

double	Spacing [3]
double	Origin [3]

int	NumberOfExtentEntries
int *	ExtentListLengths
int **	ExtentLists
Friends
class	vtkImageStencilIteratorFriendship

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

Tests:: vtkImageStencilData (Tests)

Definition at line 36 of file vtkImageStencilData.h.

Member Typedef Documentation

typedef vtkDataObject vtkImageStencilData::Superclass

Reimplemented from vtkDataObject.

Definition at line 40 of file vtkImageStencilData.h.

Constructor & Destructor Documentation

vtkImageStencilData::vtkImageStencilData ( ) [protected]

vtkImageStencilData::~vtkImageStencilData ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkDataObject.

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

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

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

Reimplemented from vtkDataObject.

virtual vtkObjectBase* vtkImageStencilData::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkDataObject.

vtkImageStencilData* vtkImageStencilData::NewInstance ( ) const

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 * src ) [virtual]

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

Reimplemented from vtkDataObject.

void vtkImageStencilData::ShallowCopy ( vtkDataObject * src ) [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 50 of file vtkImageStencilData.h.

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

The extent type is 3D, just like vtkImageData.

Reimplemented from vtkDataObject.

Definition at line 53 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.

int vtkImageStencilData::IsInside	(	int	xIdx,
		int	yIdx,
		int	zIdx
	)

Checks if an index is inside the stencil. This can be faster than GetNextExtent if called on a voxel. If calling sequentially, along a scan line, the preferred way is to use GetNextExtent and then loop over the returned [r1,r2] extents.

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

void vtkImageStencilData::InsertAndMergeExtent	(	int	r1,
		int	r2,
		int	yIdx,
		int	zIdx
	)

Similar to InsertNextExtent, except that the extent (r1,r2) at yIdx, zIdx is merged with other extents, (if any) on that row. So a unique extent may not necessarily be added. For instance, if an extent [5,11] already exists adding an extent, [7,9] will not affect the stencil. Likewise adding [10, 13] will replace the existing extent with [5,13].

void vtkImageStencilData::RemoveExtent	(	int	r1,
		int	r2,
		int	yIdx,
		int	zIdx
	)

Remove the extent from (r1,r2) at yIdx, zIdx

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] )