SimpleITK  2.0.0rc1.post264
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
itk::simple::ImageFilter Class Referenceabstract

The base interface for SimpleITK filters that take one input image. More...

#include <sitkImageFilter.h>

Inherits itk::simple::ProcessObject.

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

+ Collaboration diagram for itk::simple::ImageFilter:

Public Types

using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
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
 

Protected Member Functions

void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 

Static Protected Member Functions

template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &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)
 
template<class TImageType >
static Image CastITKToImage (TImageType *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)
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
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...
 

Detailed Description

The base interface for SimpleITK filters that take one input image.

All SimpleITK filters which take one input image should inherit from this class

Definition at line 36 of file sitkImageFilter.h.

Member Typedef Documentation

◆ Self

Definition at line 40 of file sitkImageFilter.h.

Constructor & Destructor Documentation

◆ ImageFilter()

itk::simple::ImageFilter::ImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

◆ ~ImageFilter()

virtual itk::simple::ImageFilter::~ImageFilter ( )
pure virtual

Default Destructor

Member Function Documentation

◆ CheckImageMatchingDimension()

void itk::simple::ImageFilter::CheckImageMatchingDimension ( const Image image1,
const Image image2,
const std::string &  image2Name 
)
protected

Verify the dimension of image1 matches the dimension of image2, and if not then an exception is thrown.

◆ CheckImageMatchingPixelType()

void itk::simple::ImageFilter::CheckImageMatchingPixelType ( const Image image1,
const Image image2,
const std::string &  image2Name 
)
protected

Verify the pixel type of image1 matches the pixel type of image2, and if different then an exception is thrown.

◆ CheckImageMatchingSize()

void itk::simple::ImageFilter::CheckImageMatchingSize ( const Image image1,
const Image image2,
const std::string &  image2Name 
)
protected

Verify the size in pixel of image1 matches the size of image2, and if different then an exception is thrown.

◆ FixNonZeroIndex()

template<class TImageType >
static void itk::simple::ImageFilter::FixNonZeroIndex ( TImageType *  img)
inlinestaticprotected

Definition at line 65 of file sitkImageFilter.h.


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