Class ProcessObject
java.lang.Object
org.itk.simple.ProcessObject
- Direct Known Subclasses:
- BSplineTransformInitializerFilter,- CenteredTransformInitializerFilter,- CenteredVersorTransformInitializerFilter,- HashImageFilter,- ImageFileWriter,- ImageFilter,- ImageReaderBase,- ImageRegistrationMethod,- ImageSeriesWriter
Base class for SimpleITK classes based on ProcessObject.
C++ includes: sitkProcessObject.h
- 
Field SummaryFields
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidabort()virtual void itk::simple::ProcessObject::Abort() Sets an abort flag on the active process.intaddCommand(EventEnum event, Command cmd) virtual int itk::simple::ProcessObject::AddCommand(itk::simple::EventEnum event, itk::simple::Command &cmd) Add a Command Object to observer the event.voiddebugOff()voiddebugOn()voiddelete()virtual itk::simple::ProcessObject::~ProcessObject() Default Destructorprotected voidfinalize()protected static longgetCPtr(ProcessObject obj) booleangetDebug()static doublestatic booleanstatic doublestatic longstatic Stringstatic booleangetName()virtual std::string itk::simple::ProcessObject::GetName() const =0 return user readable name for the filterlonglongfloatvirtual float itk::simple::ProcessObject::GetProgress() const An Active Measurement of the progress of execution.static voidstatic voidstatic voidstatic voidbooleanhasCommand(EventEnum event) virtual bool itk::simple::ProcessObject::HasCommand(itk::simple::EventEnum event) const Query of this object has any registered commands for event.voidvirtual void itk::simple::ProcessObject::RemoveAllCommands() Remove all registered commands.voidsetDebug(boolean debugFlag) static voidsetGlobalDefaultCoordinateTolerance(double arg0) static voidsetGlobalDefaultDebug(boolean debugFlag) static voidsetGlobalDefaultDirectionTolerance(double arg0) static voidsetGlobalDefaultNumberOfThreads(long n) static booleansetGlobalDefaultThreader(String threader) static voidsetGlobalWarningDisplay(boolean flag) voidsetNumberOfThreads(long n) voidsetNumberOfWorkUnits(long n) protected static longswigRelease(ProcessObject obj) toString()virtual std::string itk::simple::ProcessObject::ToString() const
- 
Field Details- 
swigCMemOwnprotected transient boolean swigCMemOwn
 
- 
- 
Constructor Details- 
ProcessObjectprotected ProcessObject(long cPtr, boolean cMemoryOwn) 
 
- 
- 
Method Details- 
getCPtr
- 
swigRelease
- 
finalize
- 
deletepublic void delete()virtual itk::simple::ProcessObject::~ProcessObject() Default Destructor
- 
toString
- 
getNamevirtual std::string itk::simple::ProcessObject::GetName() const =0 return user readable name for the filter
- 
debugOnpublic void debugOn()
- 
debugOffpublic void debugOff()
- 
getDebugpublic boolean getDebug()
- 
setDebugpublic void setDebug(boolean debugFlag) 
- 
globalDefaultDebugOnpublic static void globalDefaultDebugOn()
- 
globalDefaultDebugOffpublic static void globalDefaultDebugOff()
- 
getGlobalDefaultDebugpublic static boolean getGlobalDefaultDebug()
- 
setGlobalDefaultDebugpublic static void setGlobalDefaultDebug(boolean debugFlag) 
- 
globalWarningDisplayOnpublic static void globalWarningDisplayOn()
- 
globalWarningDisplayOffpublic static void globalWarningDisplayOff()
- 
setGlobalWarningDisplaypublic static void setGlobalWarningDisplay(boolean flag) 
- 
getGlobalWarningDisplaypublic static boolean getGlobalWarningDisplay()
- 
getGlobalDefaultCoordinateTolerancepublic static double getGlobalDefaultCoordinateTolerance()
- 
setGlobalDefaultCoordinateTolerancepublic static void setGlobalDefaultCoordinateTolerance(double arg0) 
- 
getGlobalDefaultDirectionTolerancepublic static double getGlobalDefaultDirectionTolerance()
- 
setGlobalDefaultDirectionTolerancepublic static void setGlobalDefaultDirectionTolerance(double arg0) 
- 
setGlobalDefaultThreader
- 
getGlobalDefaultThreader
- 
setGlobalDefaultNumberOfThreadspublic static void setGlobalDefaultNumberOfThreads(long n) 
- 
getGlobalDefaultNumberOfThreadspublic static long getGlobalDefaultNumberOfThreads()
- 
setNumberOfThreadspublic void setNumberOfThreads(long n) 
- 
getNumberOfThreadspublic long getNumberOfThreads()
- 
setNumberOfWorkUnitspublic void setNumberOfWorkUnits(long n) 
- 
getNumberOfWorkUnitspublic long getNumberOfWorkUnits()
- 
addCommandvirtual int itk::simple::ProcessObject::AddCommand(itk::simple::EventEnum event, itk::simple::Command &cmd) Add a Command Object to observer the event. The Command object's Execute method will be invoked when the internal ITK Object has the event. These events only occur during this ProcessObject's Execute method when the ITK filter is running. The command occurs in the same thread as this objects Execute methods was called in. An internal reference is made between the Command and this ProcessObject which enable automatic removal of the command when deleted. This enables both object to exist as stack based object and be automatically cleaned up. Unless specified otherwise, it's safe to get any value during execution. "Measurements" will have valid values only after the Execute method has returned. "Active Measurements" will have valid values during events, and access the underlying ITK object. Deleting a command this object has during a command call-back will produce undefined behavior. For more information see the page CommandPage. The return value is reserved for latter usage.
- 
removeAllCommandspublic void removeAllCommands()virtual void itk::simple::ProcessObject::RemoveAllCommands() Remove all registered commands. Calling when this object is invoking anther command will produce undefined behavior.
- 
hasCommandvirtual bool itk::simple::ProcessObject::HasCommand(itk::simple::EventEnum event) const Query of this object has any registered commands for event.
- 
getProgresspublic float getProgress()virtual float itk::simple::ProcessObject::GetProgress() const An Active Measurement of the progress of execution. Get the execution progress of the current process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution (or aborted). This is an Active Measurement so it can be accessed during Events during the execution.
- 
abortpublic void abort()virtual void itk::simple::ProcessObject::Abort() Sets an abort flag on the active process. Requests the current active process to abort. Additional, progress or iteration event may occur. If aborted then, an AbortEvent should occur. The Progress should be set to 1.0 after aborting. The expected behavior is that not exception should be throw out of this processes Execute method. Additionally, the results returned are valid but undefined content. The content may be only partially updated, uninitialized or the a of size zero. If there is no active process the method has no effect.
 
-