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

Flexible threshold. More...

#include <vtkImageThreshold.h>

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

Public Types

typedef vtkThreadedImageAlgorithm Superclass
- Public Types inherited from vtkThreadedImageAlgorithm
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)
void ThresholdByUpper (double thresh)
void ThresholdByLower (double thresh)
void ThresholdBetween (double lower, double upper)
virtual void SetReplaceIn (int)
virtual int GetReplaceIn ()
virtual void ReplaceInOn ()
virtual void ReplaceInOff ()
void SetInValue (double val)
virtual double GetInValue ()
virtual void SetReplaceOut (int)
virtual int GetReplaceOut ()
virtual void ReplaceOutOn ()
virtual void ReplaceOutOff ()
void SetOutValue (double val)
virtual double GetOutValue ()
virtual double GetUpperThreshold ()
virtual double GetLowerThreshold ()
virtual void SetOutputScalarType (int)
virtual int GetOutputScalarType ()
void SetOutputScalarTypeToDouble ()
void SetOutputScalarTypeToFloat ()
void SetOutputScalarTypeToLong ()
void SetOutputScalarTypeToUnsignedLong ()
void SetOutputScalarTypeToInt ()
void SetOutputScalarTypeToUnsignedInt ()
void SetOutputScalarTypeToShort ()
void SetOutputScalarTypeToUnsignedShort ()
void SetOutputScalarTypeToChar ()
void SetOutputScalarTypeToSignedChar ()
void SetOutputScalarTypeToUnsignedChar ()
- Public Member Functions inherited from vtkThreadedImageAlgorithm
virtual void ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int threadId)
virtual void SetNumberOfThreads (int)
virtual int GetNumberOfThreads ()
virtual int SplitExtent (int splitExt[6], int startExt[6], int num, int total)
- 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 vtkImageThresholdNew ()
static int IsTypeOf (const char *type)
static vtkImageThresholdSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageThreshold ()
 ~vtkImageThreshold ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int id)
- Protected Member Functions inherited from vtkThreadedImageAlgorithm
 vtkThreadedImageAlgorithm ()
 ~vtkThreadedImageAlgorithm ()
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- 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 int FillInputPortInformation (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 UpperThreshold
double LowerThreshold
int ReplaceIn
double InValue
int ReplaceOut
double OutValue
int OutputScalarType
- Protected Attributes inherited from vtkThreadedImageAlgorithm
vtkMultiThreaderThreader
int NumberOfThreads

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

Flexible threshold.

vtkImageThreshold can do binary or continuous thresholding for lower, upper or a range of data. The output data type may be different than the output, but defaults to the same type.

Tests:
vtkImageThreshold (Tests)

Definition at line 32 of file vtkImageThreshold.h.

Member Typedef Documentation

Definition at line 36 of file vtkImageThreshold.h.

Constructor & Destructor Documentation

vtkImageThreshold::vtkImageThreshold ( )
protected
vtkImageThreshold::~vtkImageThreshold ( )
inlineprotected

Definition at line 110 of file vtkImageThreshold.h.

Member Function Documentation

static vtkImageThreshold* vtkImageThreshold::New ( )
static

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

Reimplemented from vtkAlgorithm.

virtual const char* vtkImageThreshold::GetClassName ( )
virtual

Reimplemented from vtkThreadedImageAlgorithm.

static int vtkImageThreshold::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 vtkThreadedImageAlgorithm.

virtual int vtkImageThreshold::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 vtkThreadedImageAlgorithm.

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

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageThreshold::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 vtkThreadedImageAlgorithm.

void vtkImageThreshold::ThresholdByUpper ( double  thresh)

The values greater than or equal to the value match.

void vtkImageThreshold::ThresholdByLower ( double  thresh)

The values less than or equal to the value match.

void vtkImageThreshold::ThresholdBetween ( double  lower,
double  upper 
)

The values in a range (inclusive) match

virtual void vtkImageThreshold::SetReplaceIn ( int  )
virtual

Determines whether to replace the pixel in range with InValue

virtual int vtkImageThreshold::GetReplaceIn ( )
virtual

Determines whether to replace the pixel in range with InValue

virtual void vtkImageThreshold::ReplaceInOn ( )
virtual

Determines whether to replace the pixel in range with InValue

virtual void vtkImageThreshold::ReplaceInOff ( )
virtual

Determines whether to replace the pixel in range with InValue

void vtkImageThreshold::SetInValue ( double  val)

Replace the in range pixels with this value.

virtual double vtkImageThreshold::GetInValue ( )
virtual

Replace the in range pixels with this value.

virtual void vtkImageThreshold::SetReplaceOut ( int  )
virtual

Determines whether to replace the pixel out of range with OutValue

virtual int vtkImageThreshold::GetReplaceOut ( )
virtual

Determines whether to replace the pixel out of range with OutValue

virtual void vtkImageThreshold::ReplaceOutOn ( )
virtual

Determines whether to replace the pixel out of range with OutValue

virtual void vtkImageThreshold::ReplaceOutOff ( )
virtual

Determines whether to replace the pixel out of range with OutValue

void vtkImageThreshold::SetOutValue ( double  val)

Replace the in range pixels with this value.

virtual double vtkImageThreshold::GetOutValue ( )
virtual

Replace the in range pixels with this value.

virtual double vtkImageThreshold::GetUpperThreshold ( )
virtual

Get the Upper and Lower thresholds.

virtual double vtkImageThreshold::GetLowerThreshold ( )
virtual

Get the Upper and Lower thresholds.

virtual void vtkImageThreshold::SetOutputScalarType ( int  )
virtual

Set the desired output scalar type to cast to

virtual int vtkImageThreshold::GetOutputScalarType ( )
virtual

Set the desired output scalar type to cast to

void vtkImageThreshold::SetOutputScalarTypeToDouble ( )
inline

Set the desired output scalar type to cast to

Definition at line 84 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToFloat ( )
inline

Set the desired output scalar type to cast to

Definition at line 86 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToLong ( )
inline

Set the desired output scalar type to cast to

Definition at line 88 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedLong ( )
inline

Set the desired output scalar type to cast to

Definition at line 90 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToInt ( )
inline

Set the desired output scalar type to cast to

Definition at line 92 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedInt ( )
inline

Set the desired output scalar type to cast to

Definition at line 94 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToShort ( )
inline

Set the desired output scalar type to cast to

Definition at line 96 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedShort ( )
inline

Set the desired output scalar type to cast to

Definition at line 98 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToChar ( )
inline

Set the desired output scalar type to cast to

Definition at line 100 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToSignedChar ( )
inline

Set the desired output scalar type to cast to

Definition at line 102 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedChar ( )
inline

Set the desired output scalar type to cast to

Definition at line 104 of file vtkImageThreshold.h.

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

Reimplemented from vtkImageAlgorithm.

void vtkImageThreshold::ThreadedRequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector,
vtkImageData ***  inData,
vtkImageData **  outData,
int  extent[6],
int  threadId 
)
protectedvirtual

If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that the thread functions can call this method.

Reimplemented from vtkThreadedImageAlgorithm.

Member Data Documentation

double vtkImageThreshold::UpperThreshold
protected

Definition at line 110 of file vtkImageThreshold.h.

double vtkImageThreshold::LowerThreshold
protected

Definition at line 113 of file vtkImageThreshold.h.

int vtkImageThreshold::ReplaceIn
protected

Definition at line 114 of file vtkImageThreshold.h.

double vtkImageThreshold::InValue
protected

Definition at line 115 of file vtkImageThreshold.h.

int vtkImageThreshold::ReplaceOut
protected

Definition at line 116 of file vtkImageThreshold.h.

double vtkImageThreshold::OutValue
protected

Definition at line 117 of file vtkImageThreshold.h.

int vtkImageThreshold::OutputScalarType
protected

Definition at line 119 of file vtkImageThreshold.h.


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