clip an image with a function More...

#include <vtkImplicitFunctionToImageStencil.h>

Inheritance diagram for vtkImplicitFunctionToImageStencil:

Collaboration diagram for vtkImplicitFunctionToImageStencil:

Public Types
typedef vtkImageStencilSource	Superclass

Public Types inherited from vtkImageStencilSource
typedef vtkImageStencilAlgorithm	Superclass

Public Types inherited from vtkImageStencilAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkImplicitFunctionToImageStencil *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

unsigned long	GetMTime ()


virtual void	SetInput (vtkImplicitFunction *)

virtual vtkImplicitFunction *	GetInput ()


virtual void	SetThreshold (double)

virtual double	GetThreshold ()

Public Member Functions inherited from vtkImageStencilSource
vtkImageStencilSource *	NewInstance () const

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
vtkImageStencilAlgorithm *	NewInstance () const

void	SetOutput (vtkImageStencilData *output)

vtkImageStencilData *	GetOutput ()

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

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)

vtkDataObject *	GetInputDataObject (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)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkImplicitFunctionToImageStencil *	New ()

static int	IsTypeOf (const char *type)

static vtkImplicitFunctionToImageStencil *	SafeDownCast (vtkObjectBase *o)

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

static int	IsTypeOf (const char *type)

static vtkImageStencilSource *	SafeDownCast (vtkObjectBase *o)

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

static int	IsTypeOf (const char *type)

static vtkImageStencilAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImplicitFunctionToImageStencil ()

	~vtkImplicitFunctionToImageStencil ()

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkImageStencilSource
	vtkImageStencilSource ()

	~vtkImageStencilSource ()

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkImageStencilAlgorithm
	vtkImageStencilAlgorithm ()

	~vtkImageStencilAlgorithm ()

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

vtkImageStencilData *	AllocateOutputData (vtkDataObject out, int updateExt)

virtual int	FillOutputPortInformation (int, vtkInformation *)

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual int	FillInputPortInformation (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 vtkExecutive *	CreateDefaultExecutive ()

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *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 &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkImplicitFunction *	Input

double	Threshold

Protected Attributes inherited from vtkImageStencilSource
vtkImageData *	InformationInput

int	OutputWholeExtent [6]

double	OutputOrigin [3]

double	OutputSpacing [3]

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

clip an image with a function

vtkImplicitFunctionToImageStencil will convert a vtkImplicitFunction into a stencil that can be used with vtkImageStencil or with other classes that apply a stencil to an image.

See also: vtkImplicitFunction vtkImageStencil vtkPolyDataToImageStencil

Tests:: vtkImplicitFunctionToImageStencil (Tests)

Definition at line 37 of file vtkImplicitFunctionToImageStencil.h.

Member Typedef Documentation

typedef vtkImageStencilSource vtkImplicitFunctionToImageStencil::Superclass

Definition at line 41 of file vtkImplicitFunctionToImageStencil.h.

Constructor & Destructor Documentation

vtkImplicitFunctionToImageStencil::vtkImplicitFunctionToImageStencil ( )

protected

vtkImplicitFunctionToImageStencil::~vtkImplicitFunctionToImageStencil ( )

protected

Member Function Documentation

static vtkImplicitFunctionToImageStencil* vtkImplicitFunctionToImageStencil::New ( )

static

static int vtkImplicitFunctionToImageStencil::IsTypeOf ( const char * type )

static

virtual int vtkImplicitFunctionToImageStencil::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 vtkImageStencilSource.

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

static

virtual vtkObjectBase* vtkImplicitFunctionToImageStencil::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageStencilSource.

vtkImplicitFunctionToImageStencil* vtkImplicitFunctionToImageStencil::NewInstance ( ) const

void vtkImplicitFunctionToImageStencil::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 vtkImageStencilSource.

virtual void vtkImplicitFunctionToImageStencil::SetInput ( vtkImplicitFunction * )

virtual

Specify the implicit function to convert into a stencil.

virtual vtkImplicitFunction* vtkImplicitFunctionToImageStencil::GetInput ( )

virtual

Specify the implicit function to convert into a stencil.

virtual void vtkImplicitFunctionToImageStencil::SetThreshold ( double )

virtual

Set the threshold value for the implicit function.

virtual double vtkImplicitFunctionToImageStencil::GetThreshold ( )

virtual

Set the threshold value for the implicit function.

unsigned long vtkImplicitFunctionToImageStencil::GetMTime ( )

virtual

Override GetMTime() to account for the implicit function.

Reimplemented from vtkObject.

virtual int vtkImplicitFunctionToImageStencil::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protectedvirtual

Reimplemented from vtkImageStencilAlgorithm.

Member Data Documentation

vtkImplicitFunction* vtkImplicitFunctionToImageStencil::Input

protected

Definition at line 66 of file vtkImplicitFunctionToImageStencil.h.

double vtkImplicitFunctionToImageStencil::Threshold

protected

Definition at line 67 of file vtkImplicitFunctionToImageStencil.h.

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

dox/Imaging/Stencil/vtkImplicitFunctionToImageStencil.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation