Package org.itk.simple
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 Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
abort()
virtual void itk::simple::ProcessObject::Abort() Sets an abort flag on the active process.int
addCommand
(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.void
debugOff()
void
debugOn()
void
delete()
virtual itk::simple::ProcessObject::~ProcessObject() Default Destructorprotected void
finalize()
protected static long
getCPtr
(ProcessObject obj) boolean
getDebug()
static double
static boolean
static double
static long
static String
static boolean
getName()
virtual std::string itk::simple::ProcessObject::GetName() const =0 return user readable name for the filterlong
long
float
virtual float itk::simple::ProcessObject::GetProgress() const An Active Measurement of the progress of execution.static void
static void
static void
static void
boolean
hasCommand
(EventEnum event) virtual bool itk::simple::ProcessObject::HasCommand(itk::simple::EventEnum event) const Query of this object has any registered commands for event.void
virtual void itk::simple::ProcessObject::RemoveAllCommands() Remove all registered commands.void
setDebug
(boolean debugFlag) static void
setGlobalDefaultCoordinateTolerance
(double arg0) static void
setGlobalDefaultDebug
(boolean debugFlag) static void
setGlobalDefaultDirectionTolerance
(double arg0) static void
setGlobalDefaultNumberOfThreads
(long n) static boolean
setGlobalDefaultThreader
(String threader) static void
setGlobalWarningDisplay
(boolean flag) void
setNumberOfThreads
(long n) void
setNumberOfWorkUnits
(long n) protected static long
swigRelease
(ProcessObject obj) toString()
virtual std::string itk::simple::ProcessObject::ToString() const
-
Field Details
-
swigCMemOwn
protected transient boolean swigCMemOwn
-
-
Constructor Details
-
ProcessObject
protected ProcessObject(long cPtr, boolean cMemoryOwn)
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize() -
delete
public void delete()virtual itk::simple::ProcessObject::~ProcessObject() Default Destructor -
toString
virtual std::string itk::simple::ProcessObject::ToString() const -
getName
virtual std::string itk::simple::ProcessObject::GetName() const =0 return user readable name for the filter -
debugOn
public void debugOn() -
debugOff
public void debugOff() -
getDebug
public boolean getDebug() -
setDebug
public void setDebug(boolean debugFlag) -
globalDefaultDebugOn
public static void globalDefaultDebugOn() -
globalDefaultDebugOff
public static void globalDefaultDebugOff() -
getGlobalDefaultDebug
public static boolean getGlobalDefaultDebug() -
setGlobalDefaultDebug
public static void setGlobalDefaultDebug(boolean debugFlag) -
globalWarningDisplayOn
public static void globalWarningDisplayOn() -
globalWarningDisplayOff
public static void globalWarningDisplayOff() -
setGlobalWarningDisplay
public static void setGlobalWarningDisplay(boolean flag) -
getGlobalWarningDisplay
public static boolean getGlobalWarningDisplay() -
getGlobalDefaultCoordinateTolerance
public static double getGlobalDefaultCoordinateTolerance() -
setGlobalDefaultCoordinateTolerance
public static void setGlobalDefaultCoordinateTolerance(double arg0) -
getGlobalDefaultDirectionTolerance
public static double getGlobalDefaultDirectionTolerance() -
setGlobalDefaultDirectionTolerance
public static void setGlobalDefaultDirectionTolerance(double arg0) -
setGlobalDefaultThreader
-
getGlobalDefaultThreader
-
setGlobalDefaultNumberOfThreads
public static void setGlobalDefaultNumberOfThreads(long n) -
getGlobalDefaultNumberOfThreads
public static long getGlobalDefaultNumberOfThreads() -
setNumberOfThreads
public void setNumberOfThreads(long n) -
getNumberOfThreads
public long getNumberOfThreads() -
setNumberOfWorkUnits
public void setNumberOfWorkUnits(long n) -
getNumberOfWorkUnits
public long getNumberOfWorkUnits() -
addCommand
virtual 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. -
removeAllCommands
public void removeAllCommands()virtual void itk::simple::ProcessObject::RemoveAllCommands() Remove all registered commands. Calling when this object is invoking anther command will produce undefined behavior. -
hasCommand
virtual bool itk::simple::ProcessObject::HasCommand(itk::simple::EventEnum event) const Query of this object has any registered commands for event. -
getProgress
public 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. -
abort
public 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.
-