VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageStencilToImage Class Reference

Convert an image stencil into an image. More...

#include <vtkImageStencilToImage.h>

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

Public Types

typedef vtkImageAlgorithm Superclass
- Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetOutsideValue (double)
virtual double GetOutsideValue ()
virtual void SetInsideValue (double)
virtual double GetInsideValue ()
virtual void SetOutputScalarType (int)
virtual int GetOutputScalarType ()
void SetOutputScalarTypeToFloat ()
void SetOutputScalarTypeToDouble ()
void SetOutputScalarTypeToInt ()
void SetOutputScalarTypeToUnsignedInt ()
void SetOutputScalarTypeToLong ()
void SetOutputScalarTypeToUnsignedLong ()
void SetOutputScalarTypeToShort ()
void SetOutputScalarTypeToUnsignedShort ()
void SetOutputScalarTypeToUnsignedChar ()
void SetOutputScalarTypeToChar ()
- Public Member Functions inherited from vtkImageAlgorithm
vtkDataObjectGetInput (int port)
vtkDataObjectGetInput ()
vtkImageDataGetImageDataInput (int port)
vtkImageDataGetOutput ()
vtkImageDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
virtual void AddInput (vtkDataObject *)
virtual void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
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)
vtkDataObjectGetInputDataObject (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)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkImageStencilToImageNew ()
static int IsTypeOf (const char *type)
static vtkImageStencilToImageSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageStencilToImage ()
 ~vtkImageStencilToImage ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillInputPortInformation (int, vtkInformation *)
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 ~vtkImageAlgorithm ()
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void AllocateOutputData (vtkImageData *out, int *uExtent)
virtual vtkImageDataAllocateOutputData (vtkDataObject *out)
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
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 vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

double OutsideValue
double InsideValue
int OutputScalarType

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

Detailed Description

Convert an image stencil into an image.

vtkImageStencilToImage will convert an image stencil into a binary image. The default output will be an 8-bit image with a value of 1 inside the stencil and 0 outside. When used in combination with vtkPolyDataToImageStencil or vtkImplicitFunctionToImageStencil, this can be used to create a binary image from a mesh or a function.

See Also
vtkImplicitModeller
Tests:
vtkImageStencilToImage (Tests)

Definition at line 35 of file vtkImageStencilToImage.h.

Member Typedef Documentation

Definition at line 39 of file vtkImageStencilToImage.h.

Constructor & Destructor Documentation

vtkImageStencilToImage::vtkImageStencilToImage ( )
protected
vtkImageStencilToImage::~vtkImageStencilToImage ( )
protected

Member Function Documentation

static vtkImageStencilToImage* vtkImageStencilToImage::New ( )
static

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

Reimplemented from vtkAlgorithm.

virtual const char* vtkImageStencilToImage::GetClassName ( )
virtual

Reimplemented from vtkImageAlgorithm.

static int vtkImageStencilToImage::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 vtkImageAlgorithm.

virtual int vtkImageStencilToImage::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 vtkImageAlgorithm.

static vtkImageStencilToImage* vtkImageStencilToImage::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkImageAlgorithm.

void vtkImageStencilToImage::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 vtkImageAlgorithm.

virtual void vtkImageStencilToImage::SetOutsideValue ( double  )
virtual

The value to use outside the stencil. The default is 0.

virtual double vtkImageStencilToImage::GetOutsideValue ( )
virtual

The value to use outside the stencil. The default is 0.

virtual void vtkImageStencilToImage::SetInsideValue ( double  )
virtual

The value to use inside the stencil. The default is 1.

virtual double vtkImageStencilToImage::GetInsideValue ( )
virtual

The value to use inside the stencil. The default is 1.

virtual void vtkImageStencilToImage::SetOutputScalarType ( int  )
virtual

The desired output scalar type. The default is unsigned char.

virtual int vtkImageStencilToImage::GetOutputScalarType ( )
virtual

The desired output scalar type. The default is unsigned char.

void vtkImageStencilToImage::SetOutputScalarTypeToFloat ( )
inline

The desired output scalar type. The default is unsigned char.

Definition at line 58 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToDouble ( )
inline

The desired output scalar type. The default is unsigned char.

Definition at line 59 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToInt ( )
inline

The desired output scalar type. The default is unsigned char.

Definition at line 60 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToUnsignedInt ( )
inline

The desired output scalar type. The default is unsigned char.

Definition at line 61 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToLong ( )
inline

The desired output scalar type. The default is unsigned char.

Definition at line 63 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToUnsignedLong ( )
inline

The desired output scalar type. The default is unsigned char.

Definition at line 64 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToShort ( )
inline

The desired output scalar type. The default is unsigned char.

Definition at line 66 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToUnsignedShort ( )
inline

The desired output scalar type. The default is unsigned char.

Definition at line 67 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToUnsignedChar ( )
inline

The desired output scalar type. The default is unsigned char.

Definition at line 69 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToChar ( )
inline

The desired output scalar type. The default is unsigned char.

Definition at line 71 of file vtkImageStencilToImage.h.

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

Reimplemented from vtkImageAlgorithm.

virtual int vtkImageStencilToImage::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkImageAlgorithm.

virtual int vtkImageStencilToImage::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkImageAlgorithm.

Member Data Documentation

double vtkImageStencilToImage::OutsideValue
protected

Definition at line 87 of file vtkImageStencilToImage.h.

double vtkImageStencilToImage::InsideValue
protected

Definition at line 88 of file vtkImageStencilToImage.h.

int vtkImageStencilToImage::OutputScalarType
protected

Definition at line 89 of file vtkImageStencilToImage.h.


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