efficient description of an image stencil More...

#include <vtkImageStencilData.h>

Inheritance diagram for vtkImageStencilData:

Collaboration diagram for vtkImageStencilData:

Public Types
typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
enum	FieldAssociations { FIELD_ASSOCIATION_POINTS , FIELD_ASSOCIATION_CELLS , FIELD_ASSOCIATION_NONE , FIELD_ASSOCIATION_POINTS_THEN_CELLS , FIELD_ASSOCIATION_VERTICES , FIELD_ASSOCIATION_EDGES , FIELD_ASSOCIATION_ROWS , NUMBER_OF_ASSOCIATIONS }
	Possible values for the FIELD_ASSOCIATION information entry. More...

enum	AttributeTypes { POINT , CELL , FIELD , POINT_THEN_CELL , VERTEX , EDGE , ROW , NUMBER_OF_ATTRIBUTE_TYPES }
	Possible attribute types. More...

enum	FieldOperations { FIELD_OPERATION_PRESERVED , FIELD_OPERATION_REINTERPOLATED , FIELD_OPERATION_MODIFIED , FIELD_OPERATION_REMOVED }
	Possible values for the FIELD_OPERATION information entry. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkImageStencilData *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	Initialize () override
	Restore data object to initial state,. More...

void	DeepCopy (vtkDataObject *o) override
	Shallow and Deep copy. More...

void	ShallowCopy (vtkDataObject *f) override
	Shallow and Deep copy. More...

void	InternalImageStencilDataCopy (vtkImageStencilData *s)

int	GetDataObjectType () override
	Returns `VTK_IMAGE_STENCIL_DATA`. More...

int	GetExtentType () override
	The extent type is 3D, just like vtkImageData. More...

int	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. More...

int	IsInside (int xIdx, int yIdx, int zIdx)
	Checks if an image index is inside the stencil. More...

void	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). More...

void	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. More...

void	RemoveExtent (int r1, int r2, int yIdx, int zIdx)
	Remove the extent from (r1,r2) at yIdx, zIdx. More...

void	AllocateExtents ()
	Allocate space for the sub-extents. More...

void	Fill ()
	Fill the sub-extents. More...

virtual void	Add (vtkImageStencilData *)
	Add merges the stencil supplied as argument into Self. More...

virtual void	Subtract (vtkImageStencilData *)
	Subtract removes the portion of the stencil, supplied as argument, that lies within Self from Self. More...

virtual void	Replace (vtkImageStencilData *)
	Replaces the portion of the stencil, supplied as argument, that lies within Self from Self. More...

virtual int	Clip (int extent[6])
	Clip the stencil with the supplied extents. More...


virtual void	SetSpacing (double, double, double)
	Set the desired spacing for the stencil. More...

virtual void	SetSpacing (double[3])
	Set the desired spacing for the stencil. More...

virtual double *	GetSpacing ()
	Set the desired spacing for the stencil. More...

virtual void	GetSpacing (double &, double &, double &)
	Set the desired spacing for the stencil. More...

virtual void	GetSpacing (double[3])
	Set the desired spacing for the stencil. More...


virtual void	SetOrigin (double, double, double)
	Set the desired origin for the stencil. More...

virtual void	SetOrigin (double[3])
	Set the desired origin for the stencil. More...

virtual double *	GetOrigin ()
	Set the desired origin for the stencil. More...

virtual void	GetOrigin (double &, double &, double &)
	Set the desired origin for the stencil. More...

virtual void	GetOrigin (double[3])
	Set the desired origin for the stencil. More...


void	SetExtent (const int extent[6])
	Set the extent of the data. More...

void	SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
	Set the extent of the data. More...

virtual int *	GetExtent ()
	Set the extent of the data. More...

virtual void	GetExtent (int &, int &, int &, int &, int &, int &)
	Set the extent of the data. More...

virtual void	GetExtent (int[6])
	Set the extent of the data. More...


void	CopyInformationFromPipeline (vtkInformation *info) override
	Override these to handle origin, spacing, scalar type, and scalar number of components. More...

void	CopyInformationToPipeline (vtkInformation *info) override
	Override these to handle origin, spacing, scalar type, and scalar number of components. More...

Public Member Functions inherited from vtkDataObject
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkDataObject *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

vtkMTimeType	GetMTime () override
	Data objects are composite objects and need to check each part for MTime. More...

virtual void	Initialize ()
	Restore data object to initial state,. More...

void	ReleaseData ()
	Release data back to system to conserve memory resource. More...

virtual int	GetDataObjectType ()
	Return class name of data type. More...

vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...

virtual unsigned long	GetActualMemorySize ()
	Return the actual size of the data in kibibytes (1024 bytes). More...

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
	Copy from the pipeline information to the data object's own information. More...

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
	Copy information from this data object to the pipeline information. More...

void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data. More...

virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted. More...

virtual int	GetExtentType ()
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. More...

virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent. More...

virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type. More...

virtual vtkDataArray *	GetGhostArray (int type)
	Returns the ghost arrays of the data object of the specified atribute type. More...

virtual vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData. More...

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from. More...

virtual vtkIdType	GetNumberOfElements (int type)
	Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this data object. More...

virtual int	GetDataReleased ()
	Get the flag indicating the data has been released. More...

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object. More...

virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object. More...

void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkImageStencilData *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkImageStencilData *	SafeDownCast (vtkObjectBase *o)


static vtkImageStencilData *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkImageStencilData *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) More...

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name. More...

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Remove the info associated with an array. More...

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)
	Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters. More...

static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e. More...

static int	GetAssociationTypeFromString (const char *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e. More...

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	DIRECTION ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

static void	SetGlobalReleaseDataFlag (int val)
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

static int	GetGlobalReleaseDataFlag ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Types
enum	Operation { Merge , Erase }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImageStencilData ()

	~vtkImageStencilData () override

void	LogicalOperationExtent (int r1, int r2, int yIdx, int zIdx, Operation operation)
	Apply the given operation over the given (r1, r2) extent. More...

void	LogicalOperationInPlace (vtkImageStencilData *stencil, Operation operation)
	Combine with the given stencil, using the given operation. More...

void	ChangeExtent (const int extent[6])
	Change the extent while preserving the data. More...

void	CopyOriginAndSpacingFromPipeline (vtkInformation *info)
	Get important info from pipeline. More...

Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObject ()

	~vtkDataObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Extent [6]


double	Spacing [3]
	The Spacing and Origin of the data. More...

double	Origin [3]
	The Spacing and Origin of the data. More...


int	NumberOfExtentEntries
	The actual 'data' is stored here. More...

int *	ExtentListLengths
	The actual 'data' is stored here. More...

int **	ExtentLists
	The actual 'data' is stored here. More...

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkImageStencilIteratorFriendship

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Online Examples:

ImageStencil

Definition at line 52 of file vtkImageStencilData.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObject vtkImageStencilData::Superclass

Definition at line 56 of file vtkImageStencilData.h.

Member Enumeration Documentation

◆ Operation

enum vtkImageStencilData::Operation

protected

Enumerator
Merge
Erase

Definition at line 205 of file vtkImageStencilData.h.

Constructor & Destructor Documentation

◆ vtkImageStencilData()

vtkImageStencilData::vtkImageStencilData ( )

protected

◆ ~vtkImageStencilData()

vtkImageStencilData::~vtkImageStencilData ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkImageStencilData * vtkImageStencilData::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkImageStencilData::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkImageStencilData::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObject.

◆ NewInstance()

vtkImageStencilData * vtkImageStencilData::NewInstance ( ) const

◆ PrintSelf()

void vtkImageStencilData::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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.

◆ Initialize()

void vtkImageStencilData::Initialize ( )

overridevirtual

Restore data object to initial state,.

Reimplemented from vtkDataObject.

◆ DeepCopy()

void vtkImageStencilData::DeepCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

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

Reimplemented from vtkDataObject.

◆ ShallowCopy()

void vtkImageStencilData::ShallowCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

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

Reimplemented from vtkDataObject.

◆ InternalImageStencilDataCopy()

void vtkImageStencilData::InternalImageStencilDataCopy ( vtkImageStencilData * s )

◆ GetDataObjectType()

int vtkImageStencilData::GetDataObjectType ( )

inlineoverridevirtual

Returns VTK_IMAGE_STENCIL_DATA.

Reimplemented from vtkDataObject.

Definition at line 67 of file vtkImageStencilData.h.

◆ GetExtentType()

int vtkImageStencilData::GetExtentType ( )

inlineoverridevirtual

The extent type is 3D, just like vtkImageData.

Reimplemented from vtkDataObject.

Definition at line 72 of file vtkImageStencilData.h.

◆ GetNextExtent()

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.

◆ IsInside()

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

Checks if an image index is inside the stencil.

Even though GetNextExtent and the vtkImageStencilIterator are faster if every voxel in the volume has to be checked, IsInside provides an efficient alternative for if just a single voxel has to be checked.

◆ InsertNextExtent()

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

◆ InsertAndMergeExtent()

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

◆ RemoveExtent()

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

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