VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageStencilSource Class Reference

generate an image stencil More...

#include <vtkImageStencilSource.h>

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

Public Types

typedef vtkImageStencilAlgorithm Superclass
 
- Public Types inherited from vtkImageStencilAlgorithm
typedef vtkAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkImageStencilSourceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetInformationInput (vtkImageData *)
 
virtual vtkImageData * GetInformationInput ()
 
virtual void SetOutputOrigin (double, double, double)
 
virtual void SetOutputOrigin (double[3])
 
virtual double * GetOutputOrigin ()
 
virtual void GetOutputOrigin (double &, double &, double &)
 
virtual void GetOutputOrigin (double[3])
 
virtual void SetOutputSpacing (double, double, double)
 
virtual void SetOutputSpacing (double[3])
 
virtual double * GetOutputSpacing ()
 
virtual void GetOutputSpacing (double &, double &, double &)
 
virtual void GetOutputSpacing (double[3])
 
virtual void SetOutputWholeExtent (int, int, int, int, int, int)
 
virtual void SetOutputWholeExtent (int[6])
 
virtual int * GetOutputWholeExtent ()
 
virtual void GetOutputWholeExtent (int &, int &, int &, int &, int &, int &)
 
virtual void GetOutputWholeExtent (int[6])
 
- Public Member Functions inherited from vtkImageStencilAlgorithm
vtkImageStencilAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetOutput (vtkImageStencilData *output)
 
vtkImageStencilDataGetOutput ()
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Static Public Member Functions

static vtkImageStencilSourceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageStencilSourceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageStencilAlgorithm
static vtkImageStencilAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageStencilAlgorithmSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkImageStencilSource ()
 
 ~vtkImageStencilSource ()
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkImageStencilAlgorithm
 vtkImageStencilAlgorithm ()
 
 ~vtkImageStencilAlgorithm ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkImageStencilDataAllocateOutputData (vtkDataObject *out, int *updateExt)
 
virtual int FillOutputPortInformation (int, vtkInformation *)
 

Protected Attributes

vtkImageData * InformationInput
 
int OutputWholeExtent [6]
 
double OutputOrigin [3]
 
double OutputSpacing [3]
 

Detailed Description

generate an image stencil

vtkImageStencilSource is a superclass for filters that generate image stencils. Given a clipping object such as a vtkImplicitFunction, it will set up a list of clipping extents for each x-row through the image data. The extents for each x-row can be retrieved via the GetNextExtent() method after the extent lists have been built with the BuildExtents() method. For large images, using clipping extents is much more memory efficient (and slightly more time-efficient) than building a mask. This class can be subclassed to allow clipping with objects other than vtkImplicitFunction.

See Also
vtkImplicitFunction vtkImageStencil vtkPolyDataToImageStencil

Definition at line 41 of file vtkImageStencilSource.h.

Member Typedef Documentation

Definition at line 46 of file vtkImageStencilSource.h.

Constructor & Destructor Documentation

vtkImageStencilSource::vtkImageStencilSource ( )
protected
vtkImageStencilSource::~vtkImageStencilSource ( )
protected

Member Function Documentation

static vtkImageStencilSource* vtkImageStencilSource::New ( )
static
static int vtkImageStencilSource::IsTypeOf ( const char *  type)
static
virtual int vtkImageStencilSource::IsA ( const char *  type)
virtual
static vtkImageStencilSource* vtkImageStencilSource::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkImageStencilSource::NewInstanceInternal ( ) const
protectedvirtual
vtkImageStencilSource* vtkImageStencilSource::NewInstance ( ) const
void vtkImageStencilSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkImageStencilSource::SetInformationInput ( vtkImageData *  )
virtual

Set a vtkImageData that has the Spacing, Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish to apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin, and SetOutputWholeExtent methods will be ignored.

virtual vtkImageData* vtkImageStencilSource::GetInformationInput ( )
virtual

Set a vtkImageData that has the Spacing, Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish to apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin, and SetOutputWholeExtent methods will be ignored.

virtual void vtkImageStencilSource::SetOutputOrigin ( double  ,
double  ,
double   
)
virtual

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImageStencilSource::SetOutputOrigin ( double  [3])
virtual

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual double* vtkImageStencilSource::GetOutputOrigin ( )
virtual

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImageStencilSource::GetOutputOrigin ( double &  ,
double &  ,
double &   
)
virtual

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImageStencilSource::GetOutputOrigin ( double  [3])
virtual

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImageStencilSource::SetOutputSpacing ( double  ,
double  ,
double   
)
virtual

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImageStencilSource::SetOutputSpacing ( double  [3])
virtual

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual double* vtkImageStencilSource::GetOutputSpacing ( )
virtual

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImageStencilSource::GetOutputSpacing ( double &  ,
double &  ,
double &   
)
virtual

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImageStencilSource::GetOutputSpacing ( double  [3])
virtual

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImageStencilSource::SetOutputWholeExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
)
virtual

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil).

virtual void vtkImageStencilSource::SetOutputWholeExtent ( int  [6])
virtual

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil).

virtual int* vtkImageStencilSource::GetOutputWholeExtent ( )
virtual

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil).

virtual void vtkImageStencilSource::GetOutputWholeExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
)
virtual

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil).

virtual void vtkImageStencilSource::GetOutputWholeExtent ( int  [6])
virtual

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil).

virtual void vtkImageStencilSource::ReportReferences ( vtkGarbageCollector *  )
virtual

Report object referenced by instances of this class.

virtual int vtkImageStencilSource::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Reimplemented from vtkImageStencilAlgorithm.

Member Data Documentation

vtkImageData* vtkImageStencilSource::InformationInput
protected

Definition at line 93 of file vtkImageStencilSource.h.

int vtkImageStencilSource::OutputWholeExtent[6]
protected

Definition at line 95 of file vtkImageStencilSource.h.

double vtkImageStencilSource::OutputOrigin[3]
protected

Definition at line 96 of file vtkImageStencilSource.h.

double vtkImageStencilSource::OutputSpacing[3]
protected

Definition at line 97 of file vtkImageStencilSource.h.


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