SimpleITK  1.1.0.dev476
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ProcessObject Class Referenceabstract

Base class for SimpleITK classes based on ProcessObject. More...

#include <sitkProcessObject.h>

+ Inheritance diagram for itk::simple::ProcessObject:
+ Collaboration diagram for itk::simple::ProcessObject:

Classes

struct  EventCommand
 

Public Types

typedef ProcessObject Self
 

Public Member Functions

virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual std::string GetName () const =0
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual std::string ToString () const
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 

Static Public Member Functions

static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 

Protected Member Functions

virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) throw ()
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 

Static Protected Member Functions

template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Private Member Functions

unsigned long AddObserverToActiveProcessObject (EventCommand &e)
 
void RemoveObserverFromActiveProcessObject (EventCommand &e)
 

Private Attributes

itk::ProcessObjectm_ActiveProcess
 
std::list< EventCommandm_Commands
 
bool m_Debug
 
unsigned int m_NumberOfThreads
 
float m_ProgressMeasurement
 

Friends

class itk::simple::Command
 

Detailed Description

Base class for SimpleITK classes based on ProcessObject.

Examples:
FilterProgressReporting/FilterProgressReporting.cxx.

Definition at line 50 of file sitkProcessObject.h.

Member Typedef Documentation

Definition at line 54 of file sitkProcessObject.h.

Constructor & Destructor Documentation

itk::simple::ProcessObject::ProcessObject ( )

Default Constructor that takes no arguments and initializes default parameters

virtual itk::simple::ProcessObject::~ProcessObject ( )
virtual

Default Destructor

Member Function Documentation

virtual void itk::simple::ProcessObject::Abort ( )
virtual

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.

virtual int itk::simple::ProcessObject::AddCommand ( itk::simple::EventEnum  event,
itk::simple::Command cmd 
)
virtual

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 Commands and Events for SimpleITK.

Note
The return value is reserved for latter usage.
Examples:
DemonsRegistration1/DemonsRegistration1.cxx, DemonsRegistration2/DemonsRegistration2.cxx, FilterProgressReporting/FilterProgressReporting.cxx, ImageRegistrationMethod1/ImageRegistrationMethod1.cxx, ImageRegistrationMethod2/ImageRegistrationMethod2.cxx, ImageRegistrationMethodBSpline1/ImageRegistrationMethodBSpline1.cxx, and ImageRegistrationMethodDisplacement1/ImageRegistrationMethodDisplacement1.cxx.
virtual unsigned long itk::simple::ProcessObject::AddITKObserver ( const itk::EventObject ,
itk::Command  
)
protectedvirtual
unsigned long itk::simple::ProcessObject::AddObserverToActiveProcessObject ( EventCommand e)
private
template<class TImageType >
static TImageType::ConstPointer itk::simple::ProcessObject::CastImageToITK ( const Image img)
inlinestaticprotected

Definition at line 270 of file sitkProcessObject.h.

References itk::simple::Image::GetITKBase(), and sitkExceptionMacro.

template<class TImageType >
static Image itk::simple::ProcessObject::CastITKToImage ( TImageType *  img)
inlinestaticprotected

Definition at line 283 of file sitkProcessObject.h.

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image itk::simple::ProcessObject::CastITKToImage ( itk::Image< TVector< TPixelType, VLength >, VImageDimension > *  img)
inlinestaticprotected

Definition at line 291 of file sitkProcessObject.h.

virtual void itk::simple::ProcessObject::DebugOff ( )
virtual

Turn debugging output on/off.

Enabling debugging prints additional information to stdout about the execution of the internal filters.

virtual void itk::simple::ProcessObject::DebugOn ( )
virtual

Turn debugging output on/off.

Enabling debugging prints additional information to stdout about the execution of the internal filters.

virtual itk::ProcessObject* itk::simple::ProcessObject::GetActiveProcess ( )
protectedvirtual
virtual bool itk::simple::ProcessObject::GetDebug ( ) const
virtual

Get the value of the debug flag.

static double itk::simple::ProcessObject::GetGlobalDefaultCoordinateTolerance ( )
static

Access the global tolerance to determine congruent spaces.

The default tolerance is governed by the GlobalDefaultCoordinateTolerance and the GlobalDefaultDirectionTolerance properties, defaulting to 1.0e-6. The default tolerance for spatial comparison is then scaled by the voxelSpacing for coordinates (i.e. the coordinates must be the same to within one part per million). For the direction cosines the values must be within the current absolute tolerance.

static bool itk::simple::ProcessObject::GetGlobalDefaultDebug ( )
static

Get the value of the default debug flag.

static double itk::simple::ProcessObject::GetGlobalDefaultDirectionTolerance ( )
static

Access the global tolerance to determine congruent spaces.

The default tolerance is governed by the GlobalDefaultCoordinateTolerance and the GlobalDefaultDirectionTolerance properties, defaulting to 1.0e-6. The default tolerance for spatial comparison is then scaled by the voxelSpacing for coordinates (i.e. the coordinates must be the same to within one part per million). For the direction cosines the values must be within the current absolute tolerance.

static unsigned int itk::simple::ProcessObject::GetGlobalDefaultNumberOfThreads ( )
static

Set the number of threads that all new process objects are initialized with.

static bool itk::simple::ProcessObject::GetGlobalWarningDisplay ( )
static

Manage warnings produced by ITK.

Enabled by default, this parameter may enable printing of warnings indicating unstable state or parameters during execution. It is a global value set for all ITK filters and processes.

static const itk::EventObject& itk::simple::ProcessObject::GetITKEventObject ( EventEnum  e)
staticprotected
virtual std::string itk::simple::ProcessObject::GetName ( ) const
pure virtual

return user readable name for the filter

Implemented in itk::simple::LabelIntensityStatisticsImageFilter, itk::simple::LabelShapeStatisticsImageFilter, itk::simple::DiffeomorphicDemonsRegistrationFilter, itk::simple::LevelSetMotionRegistrationFilter, itk::simple::FastSymmetricForcesDemonsRegistrationFilter, itk::simple::DemonsRegistrationFilter, itk::simple::SymmetricForcesDemonsRegistrationFilter, itk::simple::PatchBasedDenoisingImageFilter, itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter, itk::simple::LabelStatisticsImageFilter, itk::simple::GeodesicActiveContourLevelSetImageFilter, itk::simple::ThresholdSegmentationLevelSetImageFilter, itk::simple::N4BiasFieldCorrectionImageFilter, itk::simple::ShapeDetectionLevelSetImageFilter, itk::simple::ResampleImageFilter, itk::simple::ConfidenceConnectedImageFilter, itk::simple::IsolatedConnectedImageFilter, itk::simple::LaplacianSegmentationLevelSetImageFilter, itk::simple::FastMarchingBaseImageFilter, itk::simple::LabelMapContourOverlayImageFilter, itk::simple::GaussianImageSource, itk::simple::VectorConfidenceConnectedImageFilter, itk::simple::DiscreteGaussianDerivativeImageFilter, itk::simple::GridImageSource, itk::simple::MultiLabelSTAPLEImageFilter, itk::simple::WarpImageFilter, itk::simple::RecursiveGaussianImageFilter, itk::simple::STAPLEImageFilter, itk::simple::GaborImageSource, itk::simple::FastMarchingUpwindGradientImageFilter, itk::simple::LandmarkBasedTransformInitializerFilter, itk::simple::OtsuThresholdImageFilter, itk::simple::DoubleThresholdImageFilter, itk::simple::NeighborhoodConnectedImageFilter, itk::simple::AntiAliasBinaryImageFilter, itk::simple::ConnectedThresholdImageFilter, itk::simple::RelabelComponentImageFilter, itk::simple::LandweberDeconvolutionImageFilter, itk::simple::CollidingFrontsImageFilter, itk::simple::DanielssonDistanceMapImageFilter, itk::simple::HuangThresholdImageFilter, itk::simple::IntermodesThresholdImageFilter, itk::simple::IsoDataThresholdImageFilter, itk::simple::KittlerIllingworthThresholdImageFilter, itk::simple::LiThresholdImageFilter, itk::simple::MaximumEntropyThresholdImageFilter, itk::simple::MomentsThresholdImageFilter, itk::simple::RenyiEntropyThresholdImageFilter, itk::simple::ShanbhagThresholdImageFilter, itk::simple::TriangleThresholdImageFilter, itk::simple::YenThresholdImageFilter, itk::simple::BinaryDilateImageFilter, itk::simple::BinaryErodeImageFilter, itk::simple::DiscreteGaussianImageFilter, itk::simple::IsolatedWatershedImageFilter, itk::simple::LabelMapMaskImageFilter, itk::simple::ScalarToRGBColormapImageFilter, itk::simple::CannyEdgeDetectionImageFilter, itk::simple::ProjectedLandweberDeconvolutionImageFilter, itk::simple::VotingBinaryIterativeHoleFillingImageFilter, itk::simple::BinaryOpeningByReconstructionImageFilter, itk::simple::RegionalMaximaImageFilter, itk::simple::AdaptiveHistogramEqualizationImageFilter, itk::simple::ClosingByReconstructionImageFilter, itk::simple::OpeningByReconstructionImageFilter, itk::simple::RegionalMinimaImageFilter, itk::simple::SignedDanielssonDistanceMapImageFilter, itk::simple::SimpleContourExtractorImageFilter, itk::simple::VotingBinaryImageFilter, itk::simple::DisplacementFieldJacobianDeterminantFilter, itk::simple::FastMarchingImageFilter, itk::simple::MaskedFFTNormalizedCorrelationImageFilter, itk::simple::RichardsonLucyDeconvolutionImageFilter, itk::simple::LabelOverlapMeasuresImageFilter, itk::simple::OtsuMultipleThresholdsImageFilter, itk::simple::SignedMaurerDistanceMapImageFilter, itk::simple::TransformToDisplacementFieldFilter, itk::simple::BilateralImageFilter, itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter, itk::simple::BinaryClosingByReconstructionImageFilter, itk::simple::BinaryMorphologicalClosingImageFilter, itk::simple::BinaryThresholdProjectionImageFilter, itk::simple::StatisticsImageFilter, itk::simple::WienerDeconvolutionImageFilter, itk::simple::ExtractImageFilter, itk::simple::ThresholdMaximumConnectedComponentsImageFilter, itk::simple::BinaryMinMaxCurvatureFlowImageFilter, itk::simple::InvertDisplacementFieldImageFilter, itk::simple::BinaryMorphologicalOpeningImageFilter, itk::simple::IntensityWindowingImageFilter, itk::simple::ShotNoiseImageFilter, itk::simple::BinaryThresholdImageFilter, itk::simple::ConvolutionImageFilter, itk::simple::BinaryContourImageFilter, itk::simple::DerivativeImageFilter, itk::simple::TikhonovDeconvolutionImageFilter, itk::simple::ErodeObjectMorphologyImageFilter, itk::simple::ZeroFluxNeumannPadImageFilter, itk::simple::AddImageFilter, itk::simple::ApproximateSignedDistanceMapImageFilter, itk::simple::BinaryImageToLabelMapFilter, itk::simple::ExpandImageFilter, itk::simple::InverseDeconvolutionImageFilter, itk::simple::InverseDisplacementFieldImageFilter, itk::simple::ThresholdImageFilter, itk::simple::VotingBinaryHoleFillingImageFilter, itk::simple::BinaryMedianImageFilter, itk::simple::BinaryProjectionImageFilter, itk::simple::CurvatureAnisotropicDiffusionImageFilter, itk::simple::HistogramMatchingImageFilter, itk::simple::MinMaxCurvatureFlowImageFilter, itk::simple::MorphologicalWatershedFromMarkersImageFilter, itk::simple::ScalarImageKmeansImageFilter, itk::simple::GradientRecursiveGaussianImageFilter, itk::simple::MorphologicalWatershedImageFilter, itk::simple::AdditiveGaussianNoiseImageFilter, itk::simple::CurvatureFlowImageFilter, itk::simple::GradientAnisotropicDiffusionImageFilter, itk::simple::UnsharpMaskImageFilter, itk::simple::BinaryGrindPeakImageFilter, itk::simple::BlackTopHatImageFilter, itk::simple::GrayscaleMorphologicalClosingImageFilter, itk::simple::GrayscaleMorphologicalOpeningImageFilter, itk::simple::LabelOverlayImageFilter, itk::simple::ZeroCrossingImageFilter, itk::simple::BinaryReconstructionByDilationImageFilter, itk::simple::BinaryReconstructionByErosionImageFilter, itk::simple::FFTConvolutionImageFilter, itk::simple::PhysicalPointImageSource, itk::simple::SigmoidImageFilter, itk::simple::ImageRegistrationMethod, itk::simple::FFTNormalizedCorrelationImageFilter, itk::simple::SubtractImageFilter, itk::simple::WhiteTopHatImageFilter, itk::simple::ClampImageFilter, itk::simple::DilateObjectMorphologyImageFilter, itk::simple::MaskImageFilter, itk::simple::GrayscaleGeodesicDilateImageFilter, itk::simple::GrayscaleGeodesicErodeImageFilter, itk::simple::LabelContourImageFilter, itk::simple::LaplacianImageFilter, itk::simple::ReconstructionByDilationImageFilter, itk::simple::ReconstructionByErosionImageFilter, itk::simple::RegionOfInterestImageFilter, itk::simple::ConstantPadImageFilter, itk::simple::GradientImageFilter, itk::simple::BinaryNotImageFilter, itk::simple::EqualImageFilter, itk::simple::GreaterEqualImageFilter, itk::simple::GreaterImageFilter, itk::simple::LessEqualImageFilter, itk::simple::LessImageFilter, itk::simple::NotEqualImageFilter, itk::simple::ValuedRegionalMaximaImageFilter, itk::simple::ComposeImageFilter, itk::simple::GrayscaleDilateImageFilter, itk::simple::GrayscaleErodeImageFilter, itk::simple::HMinimaImageFilter, itk::simple::SmoothingRecursiveGaussianImageFilter, itk::simple::FlipImageFilter, itk::simple::LabelVotingImageFilter, itk::simple::LaplacianSharpeningImageFilter, itk::simple::PasteImageFilter, itk::simple::ValuedRegionalMinimaImageFilter, itk::simple::BinaryFillholeImageFilter, itk::simple::HConcaveImageFilter, itk::simple::HConvexImageFilter, itk::simple::RescaleIntensityImageFilter, itk::simple::CenteredTransformInitializerFilter, itk::simple::ConnectedComponentImageFilter, itk::simple::MedianImageFilter, itk::simple::GrayscaleConnectedClosingImageFilter, itk::simple::GrayscaleConnectedOpeningImageFilter, itk::simple::RealAndImaginaryToComplexImageFilter, itk::simple::GradientMagnitudeRecursiveGaussianImageFilter, itk::simple::LaplacianRecursiveGaussianImageFilter, itk::simple::NaryMaximumImageFilter, itk::simple::RankImageFilter, itk::simple::TileImageFilter, itk::simple::VectorIndexSelectionCastImageFilter, itk::simple::LabelMapOverlayImageFilter, itk::simple::MorphologicalGradientImageFilter, itk::simple::NormalizeToConstantImageFilter, itk::simple::CropImageFilter, itk::simple::FFTPadImageFilter, itk::simple::JoinSeriesImageFilter, itk::simple::LabelToRGBImageFilter, itk::simple::MeanImageFilter, itk::simple::NaryAddImageFilter, itk::simple::SliceImageFilter, itk::simple::GrayscaleGrindPeakImageFilter, itk::simple::MirrorPadImageFilter, itk::simple::PowImageFilter, itk::simple::SquaredDifferenceImageFilter, itk::simple::WrapPadImageFilter, itk::simple::AbsoluteValueDifferenceImageFilter, itk::simple::GradientMagnitudeImageFilter, itk::simple::HausdorffDistanceImageFilter, itk::simple::LabelMapToBinaryImageFilter, itk::simple::NoiseImageFilter, itk::simple::StandardDeviationProjectionImageFilter, itk::simple::SumProjectionImageFilter, itk::simple::GrayscaleFillholeImageFilter, itk::simple::FastApproximateRankImageFilter, itk::simple::MaximumProjectionImageFilter, itk::simple::MeanProjectionImageFilter, itk::simple::MedianProjectionImageFilter, itk::simple::MergeLabelMapFilter, itk::simple::ScalarConnectedComponentImageFilter, itk::simple::ShrinkImageFilter, itk::simple::HMaximaImageFilter, itk::simple::BSplineTransformInitializerFilter, itk::simple::CheckerBoardImageFilter, itk::simple::FFTShiftImageFilter, itk::simple::IsoContourDistanceImageFilter, itk::simple::IterativeInverseDisplacementFieldImageFilter, itk::simple::LabelImageToLabelMapFilter, itk::simple::MinimumProjectionImageFilter, itk::simple::PermuteAxesImageFilter, itk::simple::BinShrinkImageFilter, itk::simple::NotImageFilter, itk::simple::SaltAndPepperNoiseImageFilter, itk::simple::SpeckleNoiseImageFilter, itk::simple::BinaryMagnitudeImageFilter, itk::simple::InvertIntensityImageFilter, itk::simple::ShiftScaleImageFilter, itk::simple::VectorConnectedComponentImageFilter, itk::simple::CenteredVersorTransformInitializerFilter, itk::simple::OrImageFilter, itk::simple::XorImageFilter, itk::simple::BinaryThinningImageFilter, itk::simple::HalfHermitianToRealInverseFFTImageFilter, itk::simple::LabelUniqueLabelMapFilter, itk::simple::MinimumMaximumImageFilter, itk::simple::ChangeLabelImageFilter, itk::simple::AndImageFilter, itk::simple::BinomialBlurImageFilter, itk::simple::CyclicShiftImageFilter, itk::simple::NormalizedCorrelationImageFilter, itk::simple::RelabelLabelMapFilter, itk::simple::SobelEdgeDetectionImageFilter, itk::simple::SimilarityIndexImageFilter, itk::simple::AcosImageFilter, itk::simple::AsinImageFilter, itk::simple::BoxMeanImageFilter, itk::simple::BoxSigmaImageFilter, itk::simple::ChangeLabelLabelMapFilter, itk::simple::CosImageFilter, itk::simple::LabelMapToRGBImageFilter, itk::simple::MaskNegatedImageFilter, itk::simple::DivideFloorImageFilter, itk::simple::DivideRealImageFilter, itk::simple::LabelMapToLabelImageFilter, itk::simple::AtanImageFilter, itk::simple::Atan2ImageFilter, itk::simple::BitwiseNotImageFilter, itk::simple::NormalizeImageFilter, itk::simple::MaximumImageFilter, itk::simple::MinimumImageFilter, itk::simple::MultiplyImageFilter, itk::simple::VectorMagnitudeImageFilter, itk::simple::AbsImageFilter, itk::simple::AggregateLabelMapFilter, itk::simple::DivideImageFilter, itk::simple::ForwardFFTImageFilter, itk::simple::RealToHalfHermitianForwardFFTImageFilter, itk::simple::SinImageFilter, itk::simple::ImageFileWriter, itk::simple::InverseFFTImageFilter, itk::simple::ModulusImageFilter, itk::simple::SquareImageFilter, itk::simple::EdgePotentialImageFilter, itk::simple::MagnitudeAndPhaseToComplexImageFilter, itk::simple::ImageSeriesReader, itk::simple::UnaryMinusImageFilter, itk::simple::CastImageFilter, itk::simple::ImportImageFilter, itk::simple::BoundedReciprocalImageFilter, itk::simple::ComplexToImaginaryImageFilter, itk::simple::ComplexToModulusImageFilter, itk::simple::ComplexToPhaseImageFilter, itk::simple::ComplexToRealImageFilter, itk::simple::ExpImageFilter, itk::simple::ExpNegativeImageFilter, itk::simple::Log10ImageFilter, itk::simple::LogImageFilter, itk::simple::RoundImageFilter, itk::simple::SqrtImageFilter, itk::simple::TanImageFilter, itk::simple::TernaryAddImageFilter, itk::simple::TernaryMagnitudeImageFilter, itk::simple::TernaryMagnitudeSquaredImageFilter, itk::simple::ImageSeriesWriter, itk::simple::HashImageFilter, and itk::simple::ImageFileReader.

virtual unsigned int itk::simple::ProcessObject::GetNumberOfThreads ( ) const
virtual

The number of threads used when executing a filter if the filter is multi-threaded

virtual float itk::simple::ProcessObject::GetProgress ( ) const
virtual

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.

static void itk::simple::ProcessObject::GlobalDefaultDebugOff ( )
static
static void itk::simple::ProcessObject::GlobalDefaultDebugOn ( )
static

Turn default debugging output value on/off.

This is the initial values used for new classes and procedural methods.

static void itk::simple::ProcessObject::GlobalWarningDisplayOff ( )
static

Manage warnings produced by ITK.

Enabled by default, this parameter may enable printing of warnings indicating unstable state or parameters during execution. It is a global value set for all ITK filters and processes.

static void itk::simple::ProcessObject::GlobalWarningDisplayOn ( )
static

Manage warnings produced by ITK.

Enabled by default, this parameter may enable printing of warnings indicating unstable state or parameters during execution. It is a global value set for all ITK filters and processes.

virtual bool itk::simple::ProcessObject::HasCommand ( itk::simple::EventEnum  event) const
virtual

Query of this object has any registered commands for event.

virtual void itk::simple::ProcessObject::OnActiveProcessDelete ( )
protectedvirtual
virtual void itk::simple::ProcessObject::onCommandDelete ( const itk::simple::Command cmd)
throw (
)
protectedvirtual
virtual void itk::simple::ProcessObject::PreUpdate ( itk::ProcessObject p)
protectedvirtual
virtual void itk::simple::ProcessObject::RemoveAllCommands ( )
virtual

Remove all registered commands.

Calling when this object is invoking anther command will produce undefined behavior.

virtual void itk::simple::ProcessObject::RemoveITKObserver ( EventCommand e)
protectedvirtual
void itk::simple::ProcessObject::RemoveObserverFromActiveProcessObject ( EventCommand e)
private
virtual void itk::simple::ProcessObject::SetDebug ( bool  debugFlag)
virtual

Get the value of the debug flag.

static void itk::simple::ProcessObject::SetGlobalDefaultCoordinateTolerance ( double  )
static

Access the global tolerance to determine congruent spaces.

The default tolerance is governed by the GlobalDefaultCoordinateTolerance and the GlobalDefaultDirectionTolerance properties, defaulting to 1.0e-6. The default tolerance for spatial comparison is then scaled by the voxelSpacing for coordinates (i.e. the coordinates must be the same to within one part per million). For the direction cosines the values must be within the current absolute tolerance.

static void itk::simple::ProcessObject::SetGlobalDefaultDebug ( bool  debugFlag)
static
static void itk::simple::ProcessObject::SetGlobalDefaultDirectionTolerance ( double  )
static

Access the global tolerance to determine congruent spaces.

The default tolerance is governed by the GlobalDefaultCoordinateTolerance and the GlobalDefaultDirectionTolerance properties, defaulting to 1.0e-6. The default tolerance for spatial comparison is then scaled by the voxelSpacing for coordinates (i.e. the coordinates must be the same to within one part per million). For the direction cosines the values must be within the current absolute tolerance.

static void itk::simple::ProcessObject::SetGlobalDefaultNumberOfThreads ( unsigned int  n)
static

Set the number of threads that all new process objects are initialized with.

static void itk::simple::ProcessObject::SetGlobalWarningDisplay ( bool  flag)
static

Manage warnings produced by ITK.

Enabled by default, this parameter may enable printing of warnings indicating unstable state or parameters during execution. It is a global value set for all ITK filters and processes.

virtual void itk::simple::ProcessObject::SetNumberOfThreads ( unsigned int  n)
virtual

The number of threads used when executing a filter if the filter is multi-threaded

virtual std::string itk::simple::ProcessObject::ToString ( ) const
virtual

Reimplemented in itk::simple::LabelIntensityStatisticsImageFilter, itk::simple::LabelShapeStatisticsImageFilter, itk::simple::DiffeomorphicDemonsRegistrationFilter, itk::simple::LevelSetMotionRegistrationFilter, itk::simple::FastSymmetricForcesDemonsRegistrationFilter, itk::simple::DemonsRegistrationFilter, itk::simple::SymmetricForcesDemonsRegistrationFilter, itk::simple::PatchBasedDenoisingImageFilter, itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter, itk::simple::LabelStatisticsImageFilter, itk::simple::GeodesicActiveContourLevelSetImageFilter, itk::simple::ThresholdSegmentationLevelSetImageFilter, itk::simple::N4BiasFieldCorrectionImageFilter, itk::simple::ShapeDetectionLevelSetImageFilter, itk::simple::ResampleImageFilter, itk::simple::ConfidenceConnectedImageFilter, itk::simple::IsolatedConnectedImageFilter, itk::simple::LaplacianSegmentationLevelSetImageFilter, itk::simple::FastMarchingBaseImageFilter, itk::simple::LabelMapContourOverlayImageFilter, itk::simple::GaussianImageSource, itk::simple::VectorConfidenceConnectedImageFilter, itk::simple::DiscreteGaussianDerivativeImageFilter, itk::simple::GridImageSource, itk::simple::MultiLabelSTAPLEImageFilter, itk::simple::WarpImageFilter, itk::simple::RecursiveGaussianImageFilter, itk::simple::STAPLEImageFilter, itk::simple::GaborImageSource, itk::simple::FastMarchingUpwindGradientImageFilter, itk::simple::LandmarkBasedTransformInitializerFilter, itk::simple::OtsuThresholdImageFilter, itk::simple::DoubleThresholdImageFilter, itk::simple::NeighborhoodConnectedImageFilter, itk::simple::AntiAliasBinaryImageFilter, itk::simple::ConnectedThresholdImageFilter, itk::simple::RelabelComponentImageFilter, itk::simple::LandweberDeconvolutionImageFilter, itk::simple::CollidingFrontsImageFilter, itk::simple::DanielssonDistanceMapImageFilter, itk::simple::HuangThresholdImageFilter, itk::simple::IntermodesThresholdImageFilter, itk::simple::IsoDataThresholdImageFilter, itk::simple::KittlerIllingworthThresholdImageFilter, itk::simple::LiThresholdImageFilter, itk::simple::MaximumEntropyThresholdImageFilter, itk::simple::MomentsThresholdImageFilter, itk::simple::RenyiEntropyThresholdImageFilter, itk::simple::ShanbhagThresholdImageFilter, itk::simple::TriangleThresholdImageFilter, itk::simple::YenThresholdImageFilter, itk::simple::BinaryDilateImageFilter, itk::simple::BinaryErodeImageFilter, itk::simple::DiscreteGaussianImageFilter, itk::simple::IsolatedWatershedImageFilter, itk::simple::LabelMapMaskImageFilter, itk::simple::ScalarToRGBColormapImageFilter, itk::simple::CannyEdgeDetectionImageFilter, itk::simple::ProjectedLandweberDeconvolutionImageFilter, itk::simple::VotingBinaryIterativeHoleFillingImageFilter, itk::simple::BinaryOpeningByReconstructionImageFilter, itk::simple::RegionalMaximaImageFilter, itk::simple::AdaptiveHistogramEqualizationImageFilter, itk::simple::ClosingByReconstructionImageFilter, itk::simple::OpeningByReconstructionImageFilter, itk::simple::RegionalMinimaImageFilter, itk::simple::SignedDanielssonDistanceMapImageFilter, itk::simple::SimpleContourExtractorImageFilter, itk::simple::VotingBinaryImageFilter, itk::simple::DisplacementFieldJacobianDeterminantFilter, itk::simple::FastMarchingImageFilter, itk::simple::MaskedFFTNormalizedCorrelationImageFilter, itk::simple::RichardsonLucyDeconvolutionImageFilter, itk::simple::LabelOverlapMeasuresImageFilter, itk::simple::OtsuMultipleThresholdsImageFilter, itk::simple::SignedMaurerDistanceMapImageFilter, itk::simple::TransformToDisplacementFieldFilter, itk::simple::BilateralImageFilter, itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter, itk::simple::BinaryClosingByReconstructionImageFilter, itk::simple::BinaryMorphologicalClosingImageFilter, itk::simple::BinaryThresholdProjectionImageFilter, itk::simple::StatisticsImageFilter, itk::simple::WienerDeconvolutionImageFilter, itk::simple::ExtractImageFilter, itk::simple::ThresholdMaximumConnectedComponentsImageFilter, itk::simple::BinaryMinMaxCurvatureFlowImageFilter, itk::simple::InvertDisplacementFieldImageFilter, itk::simple::BinaryMorphologicalOpeningImageFilter, itk::simple::IntensityWindowingImageFilter, itk::simple::ShotNoiseImageFilter, itk::simple::BinaryThresholdImageFilter, itk::simple::ConvolutionImageFilter, itk::simple::BinaryContourImageFilter, itk::simple::DerivativeImageFilter, itk::simple::TikhonovDeconvolutionImageFilter, itk::simple::ErodeObjectMorphologyImageFilter, itk::simple::ZeroFluxNeumannPadImageFilter, itk::simple::AddImageFilter, itk::simple::ApproximateSignedDistanceMapImageFilter, itk::simple::BinaryImageToLabelMapFilter, itk::simple::ExpandImageFilter, itk::simple::InverseDeconvolutionImageFilter, itk::simple::InverseDisplacementFieldImageFilter, itk::simple::ThresholdImageFilter, itk::simple::VotingBinaryHoleFillingImageFilter, itk::simple::ImageRegistrationMethod, itk::simple::BinaryMedianImageFilter, itk::simple::BinaryProjectionImageFilter, itk::simple::CurvatureAnisotropicDiffusionImageFilter, itk::simple::HistogramMatchingImageFilter, itk::simple::MinMaxCurvatureFlowImageFilter, itk::simple::MorphologicalWatershedFromMarkersImageFilter, itk::simple::ScalarImageKmeansImageFilter, itk::simple::GradientRecursiveGaussianImageFilter, itk::simple::MorphologicalWatershedImageFilter, itk::simple::AdditiveGaussianNoiseImageFilter, itk::simple::CurvatureFlowImageFilter, itk::simple::GradientAnisotropicDiffusionImageFilter, itk::simple::UnsharpMaskImageFilter, itk::simple::BinaryGrindPeakImageFilter, itk::simple::BlackTopHatImageFilter, itk::simple::GrayscaleMorphologicalClosingImageFilter, itk::simple::GrayscaleMorphologicalOpeningImageFilter, itk::simple::LabelOverlayImageFilter, itk::simple::ZeroCrossingImageFilter, itk::simple::BinaryReconstructionByDilationImageFilter, itk::simple::BinaryReconstructionByErosionImageFilter, itk::simple::FFTConvolutionImageFilter, itk::simple::PhysicalPointImageSource, itk::simple::SigmoidImageFilter, itk::simple::FFTNormalizedCorrelationImageFilter, itk::simple::SubtractImageFilter, itk::simple::WhiteTopHatImageFilter, itk::simple::ClampImageFilter, itk::simple::DilateObjectMorphologyImageFilter, itk::simple::MaskImageFilter, itk::simple::GrayscaleGeodesicDilateImageFilter, itk::simple::GrayscaleGeodesicErodeImageFilter, itk::simple::LabelContourImageFilter, itk::simple::LaplacianImageFilter, itk::simple::ReconstructionByDilationImageFilter, itk::simple::ReconstructionByErosionImageFilter, itk::simple::RegionOfInterestImageFilter, itk::simple::ConstantPadImageFilter, itk::simple::GradientImageFilter, itk::simple::BinaryNotImageFilter, itk::simple::EqualImageFilter, itk::simple::GreaterEqualImageFilter, itk::simple::GreaterImageFilter, itk::simple::LessEqualImageFilter, itk::simple::LessImageFilter, itk::simple::NotEqualImageFilter, itk::simple::ValuedRegionalMaximaImageFilter, itk::simple::ComposeImageFilter, itk::simple::GrayscaleDilateImageFilter, itk::simple::GrayscaleErodeImageFilter, itk::simple::HMinimaImageFilter, itk::simple::SmoothingRecursiveGaussianImageFilter, itk::simple::FlipImageFilter, itk::simple::LabelVotingImageFilter, itk::simple::LaplacianSharpeningImageFilter, itk::simple::PasteImageFilter, itk::simple::ValuedRegionalMinimaImageFilter, itk::simple::BinaryFillholeImageFilter, itk::simple::HConcaveImageFilter, itk::simple::HConvexImageFilter, itk::simple::RescaleIntensityImageFilter, itk::simple::CenteredTransformInitializerFilter, itk::simple::ConnectedComponentImageFilter, itk::simple::MedianImageFilter, itk::simple::GrayscaleConnectedClosingImageFilter, itk::simple::GrayscaleConnectedOpeningImageFilter, itk::simple::RealAndImaginaryToComplexImageFilter, itk::simple::GradientMagnitudeRecursiveGaussianImageFilter, itk::simple::LaplacianRecursiveGaussianImageFilter, itk::simple::NaryMaximumImageFilter, itk::simple::RankImageFilter, itk::simple::TileImageFilter, itk::simple::VectorIndexSelectionCastImageFilter, itk::simple::LabelMapOverlayImageFilter, itk::simple::MorphologicalGradientImageFilter, itk::simple::NormalizeToConstantImageFilter, itk::simple::CropImageFilter, itk::simple::FFTPadImageFilter, itk::simple::JoinSeriesImageFilter, itk::simple::LabelToRGBImageFilter, itk::simple::MeanImageFilter, itk::simple::NaryAddImageFilter, itk::simple::SliceImageFilter, itk::simple::GrayscaleGrindPeakImageFilter, itk::simple::MirrorPadImageFilter, itk::simple::PowImageFilter, itk::simple::SquaredDifferenceImageFilter, itk::simple::WrapPadImageFilter, itk::simple::AbsoluteValueDifferenceImageFilter, itk::simple::GradientMagnitudeImageFilter, itk::simple::HausdorffDistanceImageFilter, itk::simple::LabelMapToBinaryImageFilter, itk::simple::NoiseImageFilter, itk::simple::StandardDeviationProjectionImageFilter, itk::simple::SumProjectionImageFilter, itk::simple::GrayscaleFillholeImageFilter, itk::simple::FastApproximateRankImageFilter, itk::simple::MaximumProjectionImageFilter, itk::simple::MeanProjectionImageFilter, itk::simple::MedianProjectionImageFilter, itk::simple::MergeLabelMapFilter, itk::simple::ScalarConnectedComponentImageFilter, itk::simple::ShrinkImageFilter, itk::simple::HMaximaImageFilter, itk::simple::BSplineTransformInitializerFilter, itk::simple::CheckerBoardImageFilter, itk::simple::FFTShiftImageFilter, itk::simple::IsoContourDistanceImageFilter, itk::simple::IterativeInverseDisplacementFieldImageFilter, itk::simple::LabelImageToLabelMapFilter, itk::simple::MinimumProjectionImageFilter, itk::simple::PermuteAxesImageFilter, itk::simple::BinShrinkImageFilter, itk::simple::NotImageFilter, itk::simple::SaltAndPepperNoiseImageFilter, itk::simple::SpeckleNoiseImageFilter, itk::simple::BinaryMagnitudeImageFilter, itk::simple::InvertIntensityImageFilter, itk::simple::ShiftScaleImageFilter, itk::simple::VectorConnectedComponentImageFilter, itk::simple::CenteredVersorTransformInitializerFilter, itk::simple::OrImageFilter, itk::simple::XorImageFilter, itk::simple::BinaryThinningImageFilter, itk::simple::HalfHermitianToRealInverseFFTImageFilter, itk::simple::LabelUniqueLabelMapFilter, itk::simple::MinimumMaximumImageFilter, itk::simple::ChangeLabelImageFilter, itk::simple::AndImageFilter, itk::simple::BinomialBlurImageFilter, itk::simple::CyclicShiftImageFilter, itk::simple::NormalizedCorrelationImageFilter, itk::simple::RelabelLabelMapFilter, itk::simple::SobelEdgeDetectionImageFilter, itk::simple::SimilarityIndexImageFilter, itk::simple::AcosImageFilter, itk::simple::AsinImageFilter, itk::simple::BoxMeanImageFilter, itk::simple::BoxSigmaImageFilter, itk::simple::ChangeLabelLabelMapFilter, itk::simple::CosImageFilter, itk::simple::LabelMapToRGBImageFilter, itk::simple::MaskNegatedImageFilter, itk::simple::DivideFloorImageFilter, itk::simple::DivideRealImageFilter, itk::simple::LabelMapToLabelImageFilter, itk::simple::AtanImageFilter, itk::simple::Atan2ImageFilter, itk::simple::BitwiseNotImageFilter, itk::simple::NormalizeImageFilter, itk::simple::MaximumImageFilter, itk::simple::MinimumImageFilter, itk::simple::MultiplyImageFilter, itk::simple::VectorMagnitudeImageFilter, itk::simple::AbsImageFilter, itk::simple::AggregateLabelMapFilter, itk::simple::DivideImageFilter, itk::simple::ForwardFFTImageFilter, itk::simple::RealToHalfHermitianForwardFFTImageFilter, itk::simple::SinImageFilter, itk::simple::InverseFFTImageFilter, itk::simple::ModulusImageFilter, itk::simple::SquareImageFilter, itk::simple::EdgePotentialImageFilter, itk::simple::MagnitudeAndPhaseToComplexImageFilter, itk::simple::ImageReaderBase, itk::simple::UnaryMinusImageFilter, itk::simple::CastImageFilter, itk::simple::BoundedReciprocalImageFilter, itk::simple::ComplexToImaginaryImageFilter, itk::simple::ComplexToModulusImageFilter, itk::simple::ComplexToPhaseImageFilter, itk::simple::ComplexToRealImageFilter, itk::simple::ExpImageFilter, itk::simple::ExpNegativeImageFilter, itk::simple::Log10ImageFilter, itk::simple::LogImageFilter, itk::simple::RoundImageFilter, itk::simple::SqrtImageFilter, itk::simple::TanImageFilter, itk::simple::TernaryAddImageFilter, itk::simple::TernaryMagnitudeImageFilter, itk::simple::TernaryMagnitudeSquaredImageFilter, itk::simple::ImageFileWriter, itk::simple::HashImageFilter, itk::simple::ImageSeriesReader, itk::simple::ImportImageFilter, itk::simple::ImageSeriesWriter, and itk::simple::ImageFileReader.

template<typename T >
static std::ostream& itk::simple::ProcessObject::ToStringHelper ( std::ostream &  os,
const T &  v 
)
inlinestaticprotected

Output operator to os with conversion to a printable type.

That is char types are presumed to be numbers, and converted to int.

Definition at line 323 of file sitkProcessObject.h.

static std::ostream& itk::simple::ProcessObject::ToStringHelper ( std::ostream &  os,
const char &  v 
)
staticprotected

Output operator to os with conversion to a printable type.

That is char types are presumed to be numbers, and converted to int.

static std::ostream& itk::simple::ProcessObject::ToStringHelper ( std::ostream &  os,
const signed char &  v 
)
staticprotected

Output operator to os with conversion to a printable type.

That is char types are presumed to be numbers, and converted to int.

static std::ostream& itk::simple::ProcessObject::ToStringHelper ( std::ostream &  os,
const unsigned char &  v 
)
staticprotected

Output operator to os with conversion to a printable type.

That is char types are presumed to be numbers, and converted to int.

Friends And Related Function Documentation

friend class itk::simple::Command
friend

Definition at line 262 of file sitkProcessObject.h.

Member Data Documentation

itk::ProcessObject* itk::simple::ProcessObject::m_ActiveProcess
private

Definition at line 353 of file sitkProcessObject.h.

std::list<EventCommand> itk::simple::ProcessObject::m_Commands
private

Definition at line 351 of file sitkProcessObject.h.

bool itk::simple::ProcessObject::m_Debug
private

Definition at line 347 of file sitkProcessObject.h.

unsigned int itk::simple::ProcessObject::m_NumberOfThreads
private

Definition at line 349 of file sitkProcessObject.h.

float itk::simple::ProcessObject::m_ProgressMeasurement
private

Definition at line 356 of file sitkProcessObject.h.


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