#include <otbMeanShiftSmoothingImageFilter.h>

Inheritance diagram for otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >:

Collaboration diagram for otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >:

Public Types
typedef itk::SmartPointer < const Self >	ConstPointer

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::Pointer	InputImagePointerType

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef InputImageType::IndexType	InputIndexType

typedef InputImageType::IndexValueType	InputIndexValueType

typedef InputImageType::PixelType	InputPixelType

typedef InputImageType::SizeType	InputSizeType

typedef TKernel	KernelType

typedef unsigned long	LabelType

typedef otb::Image< unsigned short, InputImageType::ImageDimension >	ModeTableImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::Pointer	OutputImagePointerType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef TOutputImage	OutputImageType

typedef TOutputIterationImage	OutputIterationImageType

typedef otb::Image< LabelType, InputImageType::ImageDimension >	OutputLabelImageType

typedef OutputImageType::PixelType	OutputPixelType

typedef OutputImageType::RegionType	OutputRegionType

typedef OutputSpatialImageType::Pointer	OutputSpatialImagePointerType

typedef otb::VectorImage < RealType, InputImageType::ImageDimension >	OutputSpatialImageType

typedef OutputSpatialImageType::PixelType	OutputSpatialPixelType

typedef itk::SmartPointer< Self >	Pointer

typedef InputImageType::PointType	PointType

typedef double	RealType

typedef itk::VariableLengthVector < RealType >	RealVector

typedef otb::VectorImage < RealType, InputImageType::ImageDimension >	RealVectorImageType

typedef InputImageType::RegionType	RegionType

typedef MeanShiftSmoothingImageFilter	Self

typedef InputImageType::SizeType	SizeType

typedef itk::ImageToImageFilter < TInputImage, TOutputImage >	Superclass

Public Member Functions
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual void	DebugOff () const

virtual void	DebugOn () const

virtual void	Delete ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData ()

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

const InputImageType *	GetInput (void)

const InputImageType *	GetInput (unsigned int idx)

DataObjectPointerArray &	GetInputs ()

const OutputIterationImageType *	GetIterationOutput () const

OutputIterationImageType *	GetIterationOutput ()

const OutputLabelImageType *	GetLabelOutput () const

OutputLabelImageType *	GetLabelOutput ()

virtual const unsigned int &	GetMaxIterationNumber ()

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual const bool &	GetModeSearch ()

virtual unsigned long	GetMTime () const

MultiThreader *	GetMultiThreader ()

virtual const char *	GetNameOfClass () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual const int &	GetNumberOfThreads ()

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

OutputImageType *	GetOutput (void)

OutputImageType *	GetOutput (unsigned int idx)

DataObjectPointerArray &	GetOutputs ()

virtual const float &	GetProgress ()

virtual const RealType &	GetRangeBandwidth ()

const OutputImageType *	GetRangeOutput () const

OutputImageType *	GetRangeOutput ()

virtual int	GetReferenceCount () const

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()

virtual bool	GetReleaseDataFlag () const

virtual const RealType &	GetSpatialBandwidth ()

const OutputSpatialImageType *	GetSpatialOutput () const

OutputSpatialImageType *	GetSpatialOutput ()

virtual const double &	GetThreshold ()

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (DataObject *output)

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual DataObjectPointer	MakeOutput (unsigned int idx)

virtual void	Modified () const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

virtual void	PrepareOutputs ()

void	Print (std::ostream &os, Indent indent=0) const

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	Register () const

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	ReleaseDataBeforeUpdateFlagOn ()

void	ReleaseDataFlagOff ()

void	ReleaseDataFlagOn ()

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetDebug (bool debugFlag) const

virtual void	SetGlobalShift (InputIndexType _arg)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetMaxIterationNumber (unsigned int _arg)

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetModeSearch (bool _arg)

virtual void	SetNumberOfThreads (int _arg)

virtual void	SetProgress (float _arg)

virtual void	SetRangeBandwidth (RealType _arg)

virtual void	SetReferenceCount (int)

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual void	SetReleaseDataFlag (bool flag)

virtual void	SetSpatialBandwidth (RealType _arg)

virtual void	SetThreshold (double _arg)

virtual void	UnRegister () const

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float amount)

Static Public Member Functions
static void	BreakOnError ()

static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Attributes
static const unsigned int	ImageDimension = InputImageType::ImageDimension

static const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Types
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)>	InputToOutputRegionCopierType

typedef int	InternalReferenceCountType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)>	OutputToInputRegionCopierType

Protected Member Functions
	MeanShiftSmoothingImageFilter ()

virtual	~MeanShiftSmoothingImageFilter ()

virtual void	AddInput (DataObject *input)

virtual void	AddOutput (DataObject *output)

virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	CalculateMeanShiftVector (const typename RealVectorImageType::Pointer inputImagePtr, const RealVector &jointPixel, const OutputRegionType &outputRegion, const RealVector &bandwidth, RealVector &meanShiftVector)

virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation (void)

virtual void	GenerateOutputRequestedRegion (DataObject *output)

const DataObject *	GetInput (unsigned int idx) const

virtual const unsigned int &	GetNumberOfRequiredInputs ()

virtual const unsigned int &	GetNumberOfRequiredOutputs ()

const DataObject *	GetOutput (unsigned int idx) const

virtual void	PrintHeader (std::ostream &os, Indent indent) const

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, itk::Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual void	PropagateResetPipeline ()

void	PushBackInput (const DataObject *input)

void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (DataObject *input)

virtual void	RemoveOutput (DataObject *output)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetNthInput (unsigned int num, DataObject *input)

virtual void	SetNthOutput (unsigned int num, DataObject *output)

void	SetNumberOfInputs (unsigned int num)

void	SetNumberOfOutputs (unsigned int num)

virtual void	SetNumberOfRequiredInputs (unsigned int _arg)

virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)

virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)

void	ThreadedGenerateData (const OutputRegionType &outputRegionForThread, int threadId)

Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes
TimeStamp	m_OutputInformationMTime

InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

bool	m_Updating

Private Member Functions
	MeanShiftSmoothingImageFilter (const Self &)

void	operator= (const Self &)

Private Attributes
InputIndexType	m_GlobalShift

RealVectorImageType::Pointer	m_JointImage

KernelType	m_Kernel

unsigned int	m_MaxIterationNumber

bool	m_ModeSearch

ModeTableImageType::Pointer	m_ModeTable

unsigned int	m_NumberOfComponentsPerPixel

itk::VariableLengthVector < LabelType >	m_NumLabels

RealType	m_RangeBandwidth

RealType	m_SpatialBandwidth

InputSizeType	m_SpatialRadius

unsigned int	m_ThreadIdNumberOfBits

double	m_Threshold

Detailed Description

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>
class otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >

Mean shift is an edge-preserving smoothing algorithm often used in image processing and segmentation. It will iteratively smooth a given pixel with its neighbors that are within a spatial distance (set using SetSpatialBandwidth()) and within a spectral range (set using SetRangeBandwidth()). The resulting filtered image can be retrieved by GetOutput() or GetRangeOutput().

There are additional output images, as explained below. Internally, the algorithm will iteratively update a pixel both in position and spectral value, with respect to its neighbors, until convergence to a local mode. The map of the distance traveled by pixels is obtained by GetSpatialOutput(). A map of detected local modes is also available in GetLabelOutput() and can be seen as a first segmentation of the input image, although usually highly oversegmented. Finally, GetIterationOutput() will return the number of algorithm iterations for each pixel.

The class template parameter TKernel allows one to choose how pixels in the spatial and spectral neighborhood of a given pixel participate in the smoothed result. By default, a uniform kernel is used (KernelUniform), giving an equal weight to all neighbor pixels. KernelGaussian can also be used, although the computation time is significantly higher. The TKernel class should define operator(), taking a squared norm as parameter and returning a real value between 0 and 1. It should also define GetRadius(), converting the spatial bandwidth parameter to the spatial radius defining how many pixels are in the processing window local to a pixel.

MeanShifVector squared norm is compared with Threshold (set using Get/Set accessor) to define pixel convergence (1e-3 by default). MaxIterationNumber defines maximum iteration number for each pixel convergence (set using Get/Set accessor). Set to 4 by default. ModeSearch is a boolean value, to choose between optimized and non optimized algorithm. If set to true (by default), assign mode value to each pixel on a path covered in convergence steps.

For more information on mean shift techniques, one might consider reading the following article:

D. Comaniciu, P. Meer, "Mean Shift: A Robust Approach Toward Feature Space Analysis," IEEE Transactions on Pattern Analysis and Machine Intelligence, vol. 24, no. 5, pp. 603-619, May, 2002 D. Comaniciu, P. Meer, "Robust analysis of feature spaces: color image segmentation," cvpr, p. 750, 1997 IEEE Computer Society Conference on Computer Vision and Pattern Recognition (CVPR'97), 1997 D. Comaniciu, P. Meer, "Mean Shift Analysis and Applications," iccv, p. 1197, Seventh International Conference on Computer Vision (ICCV'99) - Volume 2, 1999

See Also: MeanShiftImageFilter

Definition at line 446 of file otbMeanShiftSmoothingImageFilter.h.

Member Typedef Documentation

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef itk::SmartPointer<const Self> otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::ConstPointer

Definition at line 453 of file otbMeanShiftSmoothingImageFilter.h.

template<class TOutputImage>

typedef DataObject::Pointer itk::ImageSource< TOutputImage >::DataObjectPointer

inherited

Smart Pointer type to a DataObject.

Definition at line 62 of file itkImageSource.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray

inherited

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType

inherited

Size type of an std::vector

Definition at line 112 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

typedef InputImageType::ConstPointer itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

inherited

Definition at line 84 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef InputImageType::PixelType itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImagePixelType

inherited

Definition at line 86 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef InputImageType::Pointer itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImagePointer

inherited

Definition at line 83 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef InputImageType::Pointer otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::InputImagePointerType

Definition at line 464 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef InputImageType::RegionType itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImageRegionType

inherited

Definition at line 85 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef TInputImage otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::InputImageType

Template parameters typedefs

Definition at line 459 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef InputImageType::IndexType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::InputIndexType

Definition at line 466 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef InputImageType::IndexValueType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::InputIndexValueType

Definition at line 468 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef InputImageType::PixelType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::InputPixelType

Definition at line 465 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef InputImageType::SizeType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::InputSizeType

Definition at line 467 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)> itk::ImageToImageFilter< TInputImage, TOutputImage >::InputToOutputRegionCopierType

protectedinherited

Typedef for the region copier function object that converts an input region to an output region.

Definition at line 161 of file itkImageToImageFilter.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef TKernel otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::KernelType

Definition at line 487 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef unsigned long otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::LabelType

Definition at line 480 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef otb::Image<unsigned short, InputImageType::ImageDimension> otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::ModeTableImageType

Definition at line 493 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef Superclass::OutputImagePixelType itk::ImageToImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

inherited

Definition at line 79 of file itkImageToImageFilter.h.

template<class TOutputImage>

typedef OutputImageType::Pointer itk::ImageSource< TOutputImage >::OutputImagePointer

inherited

Definition at line 69 of file itkImageSource.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef OutputImageType::Pointer otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputImagePointerType

Definition at line 474 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef Superclass::OutputImageRegionType itk::ImageToImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

inherited

Superclass typedefs.

Definition at line 75 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef TOutputImage otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputImageType

Definition at line 473 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef TOutputIterationImage otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputIterationImageType

Definition at line 478 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef otb::Image<LabelType, InputImageType::ImageDimension> otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputLabelImageType

Definition at line 481 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef OutputImageType::PixelType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputPixelType

Definition at line 475 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef OutputImageType::RegionType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputRegionType

Definition at line 476 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef OutputSpatialImageType::Pointer otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputSpatialImagePointerType

Definition at line 484 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef otb::VectorImage<RealType, InputImageType::ImageDimension> otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputSpatialImageType

Definition at line 483 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef OutputSpatialImageType::PixelType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputSpatialPixelType

Definition at line 485 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> itk::ImageToImageFilter< TInputImage, TOutputImage >::OutputToInputRegionCopierType

protectedinherited

Typedef for the region copier function object that converts an output region to an input region.

Definition at line 166 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef itk::SmartPointer<Self> otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::Pointer

Definition at line 452 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef InputImageType::PointType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::PointType

Definition at line 469 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef double otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::RealType

Definition at line 454 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef itk::VariableLengthVector<RealType> otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::RealVector

Definition at line 491 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef otb::VectorImage<RealType, InputImageType::ImageDimension> otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::RealVectorImageType

Definition at line 492 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef InputImageType::RegionType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::RegionType

Definition at line 470 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef MeanShiftSmoothingImageFilter otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::Self

Standard class typedef

Definition at line 450 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef InputImageType::SizeType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::SizeType

Definition at line 471 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::Superclass

Definition at line 451 of file otbMeanShiftSmoothingImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::MeanShiftSmoothingImageFilter ( )

protected

Constructor

Definition at line 34 of file otbMeanShiftSmoothingImageFilter.txx.

References otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_GlobalShift, otb::Image< TPixel, VImageDimension >::New(), otb::VectorImage< TPixel, VImageDimension >::New(), itk::ProcessObject::SetNthOutput(), and itk::ProcessObject::SetNumberOfOutputs().

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::~MeanShiftSmoothingImageFilter ( )

protectedvirtual

Destructor

Definition at line 56 of file otbMeanShiftSmoothingImageFilter.txx.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::MeanShiftSmoothingImageFilter ( const Self & )

private

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( )

virtualinherited

virtual void itk::ProcessObject::AbortGenerateDataOn ( )

virtualinherited

Turn on and off the AbortGenerateData flag.

void itk::ProcessObject::AddInput ( DataObject * input )

protectedvirtualinherited

Adds an input to the first null position in the input list. Expands the list memory if necessary

Reimplemented in otb::ObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionPrecision, TCoordRep >, otb::DescriptorsListSampleGenerator< TInputImage, TVectorData, TListSample, TLabelListSample, TOutputPrecision, TCoordRep >, otb::PersistentDescriptorsListSampleGenerator< TInputImage, TVectorData, TFunctionType, TListSample, TLabelListSample >, and otb::PersistentObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionType >.

Definition at line 144 of file itkProcessObject.cxx.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::ProcessObject::AddOutput ( DataObject * output )

protectedvirtualinherited

Adds an output to the first null position in the output list. Expands the list memory if necessary

Definition at line 390 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::AfterThreadedGenerateData ( void )

protectedvirtual

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 770 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::VariableLengthVector< TValueType >::SetSize().

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::AllocateOutputs ( )

protectedvirtual

Allocates the outputs (need to be reimplemented since outputs have differents type)

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 117 of file otbMeanShiftSmoothingImageFilter.txx.

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::BeforeThreadedGenerateData ( void )

protectedvirtual

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 214 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::VariableLengthVector< TValueType >::Fill().

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

void itk::ProcessObject::CacheInputReleaseDataFlags ( )

protectedvirtualinherited

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

Definition at line 1050 of file itkProcessObject.cxx.

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::CalculateMeanShiftVector	(	const typename RealVectorImageType::Pointer	inputImagePtr,
		const RealVector &	jointPixel,
		const OutputRegionType &	outputRegion,
		const RealVector &	bandwidth,
		RealVector &	meanShiftVector
	)

protectedvirtual

Definition at line 343 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::VariableLengthVector< TValueType >::Fill(), itk::ImageConstIterator< TImage >::Get(), itk::VariableLengthVector< TValueType >::GetSize(), itk::ImageRegionConstIterator< TImage >::GoToBegin(), and itk::ImageConstIterator< TImage >::IsAtEnd().

template<class TInputImage , class TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::CallCopyInputRegionToOutputRegion	(	OutputImageRegionType &	destRegion,
		const InputImageRegionType &	srcRegion
	)

protectedvirtualinherited

This function calls the actual region copier to do the mapping from input image space to output image space. It uses a Function object used for dispatching to various routines to copy an input region (start index and size) to an output region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::UnaryFunctorImageFilter can support output images of a higher dimension that the input.

This function object is used by the default implementation of GenerateOutputInformation(). It can also be used in routines like ThreadedGenerateData() where a filter may need to map an input region to an output region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the first portion of the input region is copied to the output region. If the input region is a lower dimension than the output, the input region information is copied into the first portion of the output region and the rest of the output region is set to zero.

If a filter needs a different default behavior, it can override this method.

Reimplemented in otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::INVERSE >, otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::FORWARD >, otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >, and otb::DecimateImageFilter< TInputImage, TOutputImage >.

Definition at line 165 of file itkImageToImageFilter.txx.

template<class TInputImage , class TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::CallCopyOutputRegionToInputRegion	(	InputImageRegionType &	destRegion,
		const OutputImageRegionType &	srcRegion
	)

protectedvirtualinherited

This function calls the actual region copier to do the mapping from output image space to input image space. It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractImageFilter can support output images of a lower dimension that the input.

This function object can be used by GenerateOutputInformation() to copy the input LargestPossibleRegion to the output LargestPossibleRegion and can also be used in GenerateData or ThreadedGenerateData() where a filter may need to map an output region to an input region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the output region information is copied into the first portion of the input region and the rest of the input region is set to zero. If the input region is a lower dimension than the output, the first portion of the output region is copied to the input region.

If a filter needs a different default behavior, it can override this method. The ExtractImageFilter overrides this function object so that if the input image is a higher dimension than the output image, the filter can control "where" in the input image the output subimage is extracted (as opposed to mapping to first few dimensions of the input).

Reimplemented in otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::INVERSE >, otb::WaveletFilterBank< TInputImage, TOutputImage, TWaveletOperator, Wavelet::FORWARD >, otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >, and otb::DecimateImageFilter< TInputImage, TOutputImage >.

Definition at line 154 of file itkImageToImageFilter.txx.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual::itk::LightObject::Pointer otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::CreateAnother ( void ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * )

inlinevirtualinherited

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Definition at line 224 of file itkProcessObject.h.

template<class TOutputImage >

void itk::ImageSource< TOutputImage >::GenerateData ( void )

protectedvirtualinherited

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See Also: ThreadedGenerateData()

Reimplemented from itk::ProcessObject.

Definition at line 225 of file itkImageSource.txx.

References itk::ImageSource< TOutputImage >::ThreadStruct::Filter.

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GenerateInputRequestedRegion ( void )

protectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See Also: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 155 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::DataObjectError::SetDataObject(), itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GenerateOutputInformation ( void )

protectedvirtual

GenerateOutputInformation Define output pixel size

Reimplemented from itk::ProcessObject.

Definition at line 138 of file otbMeanShiftSmoothingImageFilter.txx.

void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject * output )

protectedvirtualinherited

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

By default we set all the output requested regions to be the same.

Reimplemented in otb::watershed::Segmenter< TInputImage >, itk::watershed::Segmenter< TInputImage >, otb::watershed::Segmenter< InputImageType >, itk::watershed::Segmenter< InputImageType >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::SegmentTreeGenerator< ScalarType >, itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, otb::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< TScalarType, TImageDimension >, otb::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, otb::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::BoundaryResolver< TPixelType, TDimension >, otb::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, and itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 846 of file itkProcessObject.cxx.

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( )

virtualinherited

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

template<class TInputImage , class TOutputImage >

const ImageToImageFilter< TInputImage, TOutputImage >::InputImageType * itk::ImageToImageFilter< TInputImage, TOutputImage >::GetInput ( void )

inherited

Definition at line 82 of file itkImageToImageFilter.txx.

References itk::ProcessObject::GetInput().

Referenced by otb::RenderingImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData(), and otb::ROIdataConversion< TInputImage, TInputROIImage >::GetInputImage().

template<class TInputImage , class TOutputImage >

const ImageToImageFilter< TInputImage, TOutputImage >::InputImageType * itk::ImageToImageFilter< TInputImage, TOutputImage >::GetInput ( unsigned int idx )

inherited

Definition at line 99 of file itkImageToImageFilter.txx.

References itk::ProcessObject::GetInput().

const DataObject * itk::ProcessObject::GetInput ( unsigned int idx ) const

protectedinherited

Definition at line 482 of file itkProcessObject.cxx.

References NULL.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( )

inlineinherited

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

Definition at line 108 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

const MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputIterationImageType * otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetIterationOutput ( ) const

Returns the const number of iterations map.

Definition at line 97 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::ProcessObject::GetOutput().

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputIterationImageType * otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetIterationOutput ( )

Returns the number of iterations done at each pixel

Definition at line 90 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::ProcessObject::GetOutput().

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

const MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputLabelImageType * otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetLabelOutput ( ) const

Returns the const image of region labels. This output does not have sense without mode search optimization (each label codes for one mode)

Definition at line 111 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::ProcessObject::GetOutput().

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputLabelImageType * otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetLabelOutput ( )

Returns the image of region labels. This output does not have sense without mode search optimization (each label codes for one mode)

Definition at line 104 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::ProcessObject::GetOutput().

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual const unsigned int& otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetMaxIterationNumber ( )

virtual

Sets the maximum number of algorithm iterations

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns: A reference to this objects MetaDataDictionary.

Warning: This reference may be changed.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns: A constant reference to this objects MetaDataDictionary.

Definition at line 543 of file itkObject.cxx.

References NULL.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual const bool& otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetModeSearch ( )

virtual

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), otb::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

MultiThreader* itk::ProcessObject::GetMultiThreader ( )

inlineinherited

Return the multithreader used by this class.

Definition at line 280 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual const char* otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetNameOfClass ( ) const

virtual

Type macro

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const

inlineinherited

Get the size of the input vector. This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null.

Definition at line 118 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const

inlineinherited

Definition at line 135 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( )

protectedvirtualinherited

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( )

protectedvirtualinherited

virtual const int& itk::ProcessObject::GetNumberOfThreads ( )

virtualinherited

Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SplitRequestedRegion().

ProcessObject::DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const

virtualinherited

Get the number of valid inputs. This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector.

Get the number of specified inputs

Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField, TRealType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

Definition at line 112 of file itkProcessObject.cxx.

template<class TOutputImage >

ImageSource< TOutputImage >::OutputImageType * itk::ImageSource< TOutputImage >::GetOutput ( void )

inherited

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

anotherFilter->SetInput( someFilter->GetOutput() );

anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

image = someFilter->GetOutput();

image->Update();

someFilter->Update();

image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

Definition at line 66 of file itkImageSource.txx.

References itk::ProcessObject::GetOutput().

Referenced by itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage(), itk::ImageSeriesReader< TOutputImage >::ComputeMovingDimensionIndex(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), and main().

template<class TOutputImage >

ImageSource< TOutputImage >::OutputImageType * itk::ImageSource< TOutputImage >::GetOutput ( unsigned int idx )

inherited

Definition at line 85 of file itkImageSource.txx.

References itk::ProcessObject::GetOutput(), and NULL.

const DataObject * itk::ProcessObject::GetOutput ( unsigned int idx ) const

protectedinherited

Definition at line 454 of file itkProcessObject.cxx.

References NULL.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( )

inlineinherited

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 133 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

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

virtualinherited

Get the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution.

Referenced by itk::WatershedMiniPipelineProgressCommand::Execute(), otb::StreamingImageVirtualWriter< TInputImage >::ObserveSourceFilterProgress(), otb::ImageFileWriter< TInputImage >::ObserveSourceFilterProgress(), itk::LaplacianRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ReportProgress(), and itk::XMLFilterWatcher::ShowProgress().

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual const RealType& otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetRangeBandwidth ( )

virtual

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

const MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputImageType * otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetRangeOutput ( ) const

Returns the const spectral image output

Definition at line 76 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::ProcessObject::GetOutput().

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputImageType * otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetRangeOutput ( )

Returns the spectral image output

Definition at line 83 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::ProcessObject::GetOutput().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( )

virtualinherited

bool itk::ProcessObject::GetReleaseDataFlag ( ) const

virtualinherited

Definition at line 512 of file itkProcessObject.cxx.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual const RealType& otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetSpatialBandwidth ( )

virtual

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

const MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputSpatialImageType * otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetSpatialOutput ( ) const

Returns the const spatial image output,spatial image output is a displacement map (pixel position after convergence minus pixel index)

Definition at line 62 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::ProcessObject::GetOutput().

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::OutputSpatialImageType * otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetSpatialOutput ( )

Returns the spatial image output,spatial image output is a displacement map (pixel position after convergence minus pixel index)

Definition at line 69 of file otbMeanShiftSmoothingImageFilter.txx.

References itk::ProcessObject::GetOutput().

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual const double& otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::GetThreshold ( )

virtual

Sets the threshold value for the mean shift vector's squared norm, under which convergence is assumed

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

template<class TOutputImage >

void itk::ImageSource< TOutputImage >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	output
	)

virtualinherited

Graft the specified data object onto this ProcessObject's idx'th output. This is similar to the GraftOutput method except it allows you to specify which output is affected. The specified index must be a valid output number (less than ProcessObject::GetNumberOfOutputs()). See the GraftOutput for general usage information.

Definition at line 113 of file itkImageSource.txx.

References itk::ProcessObject::GetOutput(), and itk::DataObject::Graft().

template<class TOutputImage >

void itk::ImageSource< TOutputImage >::GraftOutput ( DataObject * output )

virtualinherited

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

// setup the mini-pipeline to process the input to this filter
firstFilterInMiniPipeline->SetInput( this->GetInput() );
// setup the mini-pipeline to calculate the correct regions
// and write to the appropriate bulk data block
lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );
// execute the mini-pipeline
lastFilterInMiniPipeline->Update();
// graft the mini-pipeline output back onto this filter's output.
// this is needed to get the appropriate regions passed back.
this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

Definition at line 101 of file itkImageSource.txx.

Referenced by otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), and itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

template<class TOutputImage >

ImageSource< TOutputImage >::DataObjectPointer itk::ImageSource< TOutputImage >::MakeOutput ( unsigned int idx )

virtualinherited

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

Definition at line 55 of file itkImageSource.txx.

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

static Pointer otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::New ( )

static

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::operator= ( const Self & )

private

template<class TInputImage , class TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::PopBackInput ( )

virtualinherited

Model a stack on the input list by providing a pop back

Reimplemented from itk::ProcessObject.

Definition at line 193 of file itkImageToImageFilter.txx.

References itk::ProcessObject::PopBackInput().

template<class TInputImage , class TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::PopFrontInput ( )

virtualinherited

Reimplemented from itk::ProcessObject.

Definition at line 211 of file itkImageToImageFilter.txx.

References itk::ProcessObject::PopFrontInput().

void itk::ProcessObject::PrepareOutputs ( )

virtualinherited

An opportunity to deallocate a ProcessObject's bulk data storage. Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default.

Reimplemented in itk::WatershedImageFilter< TInputImage >, otb::WatershedImageFilter< TInputImage >, and otb::GeometriesSource.

Definition at line 864 of file itkProcessObject.cxx.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

protectedvirtual

PrintSelf method

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 818 of file otbMeanShiftSmoothingImageFilter.txx.

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output )

virtualinherited

Send the requested region information back up the pipeline (to the filters that preceed this one).

check flag to avoid executing forever if there is a loop

Give the subclass a chance to indicate that it will provide more data then required for the output. This can happen, for example, when a source can only produce the whole output. Although this is being called for a specific output, the source may need to enlarge all outputs.

Give the subclass a chance to define how to set the requested regions for each of its outputs, given this output's requested region. The default implementation is to make all the output requested regions the same. A subclass may need to override this method if each output is a different resolution.

Give the subclass a chance to request a larger requested region on the inputs. This is necessary when, for example, a filter requires more data at the "internal" boundaries to produce the boundary values - such as an image filter that derives a new pixel value by applying some operation to a neighborhood of surrounding original values.

Now that we know the input requested region, propagate this through all the inputs.

Reimplemented in itk::VTKImageImport< TOutputImage >, and itk::StreamingImageFilter< TInputImage, TOutputImage >.

Definition at line 766 of file itkProcessObject.cxx.

void itk::ProcessObject::PropagateResetPipeline ( )

protectedvirtualinherited

Called to allocate the input array. Copies old inputs. Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

Propagate the ResetPipeline call

Definition at line 631 of file itkProcessObject.cxx.

template<class TInputImage , class TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::PushBackInput ( const InputImageType * image )

virtualinherited

Push/Pop the input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

Definition at line 184 of file itkImageToImageFilter.txx.

References itk::ProcessObject::PushBackInput().

template<class TInputImage, class TOutputImage>

void itk::ImageToImageFilter< TInputImage, TOutputImage >::PushBackInput ( const DataObject * input )

inlineprotectedvirtualinherited

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ProcessObject.

Definition at line 248 of file itkImageToImageFilter.h.

template<class TInputImage , class TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::PushFrontInput ( const InputImageType * image )

virtualinherited

Definition at line 202 of file itkImageToImageFilter.txx.

References itk::ProcessObject::PushFrontInput().

template<class TInputImage, class TOutputImage>

void itk::ImageToImageFilter< TInputImage, TOutputImage >::PushFrontInput ( const DataObject * input )

inlineprotectedvirtualinherited

Reimplemented from itk::ProcessObject.

Definition at line 250 of file itkImageToImageFilter.h.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOff ( )

virtualinherited

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( )

virtualinherited

void itk::ProcessObject::ReleaseDataFlagOff ( )

inlineinherited

Definition at line 256 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( )

inlineinherited

Definition at line 255 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseInputs ( )

protectedvirtualinherited

A filter may need to release its input's bulk data after it has finished calculating a new output. The filter may need to release the inputs because the user has turned on the ReleaseDataFlag or it may need to release the inputs because the filter is an "in place" filter and it has overwritten its input with its output data. The implementation here simply checks the ReleaseDataFlag of the inputs. InPlaceImageFilter overrides this method so release the input it has overwritten.

See Also: InPlaceImageFilter::ReleaseInputs()

Definition at line 886 of file itkProcessObject.cxx.

Referenced by otb::LabelMapSVMClassifier< TInputLabelMap >::ReleaseInputs(), itk::InPlaceImageFilter< TInputImage, TOutputImage >::ReleaseInputs(), and itk::InPlaceLabelMapFilter< TInputImage >::ReleaseInputs().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::ProcessObject::RemoveInput ( DataObject * input )

protectedvirtualinherited

Remove an input.

Removes the first occurence of the given OutputObject from the inputs to this ProcessObject. If it's the last object on the list, shortens the list.

Definition at line 173 of file itkProcessObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

void itk::ProcessObject::RemoveOutput ( DataObject * output )

protectedvirtualinherited

Definition at line 294 of file itkProcessObject.cxx.

void itk::ProcessObject::ResetPipeline ( )

virtualinherited

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

Definition at line 621 of file itkProcessObject.cxx.

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

void itk::ProcessObject::RestoreInputReleaseDataFlags ( )

protectedvirtualinherited

Restore the cached input ReleaseDataFlags.

Definition at line 1075 of file itkProcessObject.cxx.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg )

virtualinherited

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::SetGlobalShift ( InputIndexType _arg )

virtual

Global shift allows to tackle down numerical instabilities by

aligning pixel indices when performing tile processing

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TInputImage , class TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput ( const InputImageType * image )

virtualinherited

Set/Get the image input of this process object.

Reimplemented in otb::ConvexOrConcaveClassificationFilter< TInputImage, TOutputImage >, otb::WatershedImageFilter< TInputImage >, itk::WatershedImageFilter< TInputImage >, otb::ImageAndVectorImageOperationFilter< TInputImage, TVectorInputImage, TOutputImage >, itk::VoronoiSegmentationRGBImageFilter< TInputImage, TOutputImage >, otb::GeodesicMorphologyLevelingFilter< TInputImage, TInputMaps, TOutputImage >, and otb::ModulusAndDirectionImageToImageFilter< TInputImage, TInputImageDirection, TOutputImage >.

Definition at line 55 of file itkImageToImageFilter.txx.

References itk::ProcessObject::SetNthInput().

Referenced by itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), and otb::ROIdataConversion< TInputImage, TInputROIImage >::SetInputImage().

template<class TInputImage, class TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput	(	unsigned int	index,
		const TInputImage *	image
	)

virtualinherited

Connect one of the operands for pixel-wise addition

Reimplemented in otb::WatershedImageFilter< TInputImage >, itk::WatershedImageFilter< TInputImage >, itk::VoronoiSegmentationRGBImageFilter< TInputImage, TOutputImage >, and otb::AngularProjectionImageFilter< TInputImage, TOutputImage, TAngleArray, TPrecision >.

Definition at line 69 of file itkImageToImageFilter.txx.

References itk::ProcessObject::SetNthInput().

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::SetMaxIterationNumber ( unsigned int _arg )

virtual

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns: Set the MetaDataDictionary

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::SetModeSearch ( bool _arg )

virtual

Toggle mode search, which is enabled by default. When off, the output label image is not available Be careful, with this option, the result will slightly depend on thread number.

void itk::ProcessObject::SetNthInput	(	unsigned int	idx,
		DataObject *	input
	)

protectedvirtualinherited

Protected methods for setting inputs. Subclasses make use of them for setting input.

Set an Input of this filter. This method does Register()/UnRegister() manually to deal with the fact that smart pointers aren't around to do the reference counting.

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Definition at line 210 of file itkProcessObject.cxx.

void itk::ProcessObject::SetNthOutput	(	unsigned int	idx,
		DataObject *	output
	)

protectedvirtualinherited

Protected methods for setting outputs. Subclasses make use of them for getting output.

Set an output of this filter. This method specifically does not do a Register()/UnRegister() because of the desire to break the reference counting loop.

Definition at line 333 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num )

protectedinherited

Called to allocate the input array. Copies old inputs.

Called by constructor to set up input array.

Definition at line 96 of file itkProcessObject.cxx.

Referenced by otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num )

protectedinherited

Called to allocate the output array. Copies old outputs.

Called by constructor to set up output array.

Definition at line 424 of file itkProcessObject.cxx.

Referenced by otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::MeanShiftSmoothingImageFilter(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg )

protectedvirtualinherited

Referenced by itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::FastMarchingImageFilter(), otb::FillGapsFilter::FillGapsFilter(), otb::ImageToLabelMapWithAttributesFilter< TInputImage, TLabeledImage, TLabel, TLabelObject >::ImageToLabelMapWithAttributesFilter(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::PasteImageFilter(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg )

protectedvirtualinherited

Referenced by itk::AutomaticTopologyMeshSource< TOutputMesh >::AutomaticTopologyMeshSource(), itk::BalloonForceFilter< TInputMesh, TOutputMesh >::BalloonForceFilter(), itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >::CoreAtomImageToDistanceMatrixProcess(), itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >::CoreAtomImageToUnaryCorrespondenceMatrixProcess(), itk::DeformableMesh3DFilter< TInputMesh, TOutputMesh >::DeformableMesh3DFilter(), itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >::FastMarchingExtensionImageFilter(), otb::FillGapsFilter::FillGapsFilter(), otb::GeometriesSource::GeometriesSource(), itk::ImageSource< TOutputImage >::ImageSource(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::MedialNodePairCorrespondenceProcess< TSourceImage >::MedialNodePairCorrespondenceProcess(), itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >::MedialNodeTripletCorrespondenceProcess(), itk::MeshSource< TOutputMesh >::MeshSource(), itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >::MultiScaleHessianBasedMeasureImageFilter(), otb::OSMDataToVectorDataGenerator::OSMDataToVectorDataGenerator(), itk::PathSource< TOutputPath >::PathSource(), itk::RegularSphereMeshSource< TOutputMesh >::RegularSphereMeshSource(), otb::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler(), itk::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler(), itk::SimplexMeshAdaptTopologyFilter< TInputMesh, TOutputMesh >::SimplexMeshAdaptTopologyFilter(), itk::SphereMeshSource< TOutputMesh >::SphereMeshSource(), itk::TriangleMeshToSimplexMeshFilter< TInputMesh, TOutputMesh >::TriangleMeshToSimplexMeshFilter(), itk::TwoOutputExampleImageFilter< TImage >::TwoOutputExampleImageFilter(), and itk::VTKPolyDataReader< TOutputMesh >::VTKPolyDataReader().

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg )

virtualinherited

Get/Set the number of threads to create when executing.

Referenced by itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivative(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivativePos(), and itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrecalculateChange().

virtual void itk::ProcessObject::SetProgress ( float _arg )

virtualinherited

Set the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::SetRangeBandwidth ( RealType _arg )

virtual

Sets the spectral bandwidth (or radius for a uniform kernel) for pixels to be included in the same mode

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg )

virtualinherited

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

void itk::ProcessObject::SetReleaseDataFlag ( bool flag )

virtualinherited

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

Definition at line 528 of file itkProcessObject.cxx.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::SetSpatialBandwidth ( RealType _arg )

virtual

Sets the spatial bandwidth (or radius in the case of a uniform kernel) of the neighborhood for each pixel

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

virtual void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::SetThreshold ( double _arg )

virtual

template<class TOutputImage >

int itk::ImageSource< TOutputImage >::SplitRequestedRegion	(	int	i,
		int	num,
		OutputImageRegionType &	splitRegion
	)

protectedvirtualinherited

Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". This method is called "num" times. The regions must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedRegion, i.e. return value is less than or equal to "num".

Reimplemented in itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >.

Definition at line 138 of file itkImageSource.txx.

Referenced by itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >::ApplyUpdateThreaderCallback(), itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >::CalculateChangeThreaderCallback(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivativePosThreaderCallback(), and itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivativeThreaderCallback().

template<class TInputImage , class TOutputImage , class TKernel , class TOutputIterationImage >

void otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::ThreadedGenerateData	(	const OutputRegionType &	outputRegionForThread,
		int	threadId
	)

protectedvirtual

MeanShiftFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See Also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 532 of file otbMeanShiftSmoothingImageFilter.txx.

template<class TOutputImage >

ITK_THREAD_RETURN_TYPE itk::ImageSource< TOutputImage >::ThreaderCallback ( void * arg )

staticprotectedinherited

Static function used as a "callback" by the MultiThreader. The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData().

Definition at line 278 of file itkImageSource.txx.

References itk::ImageSource< TOutputImage >::ThreadStruct::Filter, and ITK_THREAD_RETURN_VALUE.

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

void itk::ProcessObject::Update ( void )

virtualinherited

Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead.

The following methods are used to coordinate the execution of the data processing pipeline.

Definition at line 611 of file itkProcessObject.cxx.

Referenced by otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), itk::AutoCropLabelMapFilter< TInputImage >::GenerateOutputInformation(), itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation(), and itk::VoronoiSegmentationImageFilterBase< TInputImage, TOutputImage, TBinaryPriorImage >::RunSegmentOneStep().

void itk::ProcessObject::UpdateLargestPossibleRegion ( )

virtualinherited

Like Update(), but sets the output requested region to the largest possible region for the output. This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update().

Definition at line 1120 of file itkProcessObject.cxx.

void itk::ProcessObject::UpdateOutputData ( DataObject * output )

virtualinherited

Actually generate new output

prevent chasing our tail

Prepare all the outputs. This may deallocate previous bulk data.

Propagate the update call - make sure everything we might rely on is up-to-date Must call PropagateRequestedRegion before UpdateOutputData if multiple inputs since they may lead back to the same data object.

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

Tell all Observers that the filter is starting

GenerateData this object - we have not aborted yet, and our progress before we start to execute is 0.0.

Count the number of required inputs which have been assigned

If we ended due to aborting, push the progress up to 1.0 (since it probably didn't end there)

Notify end event observers

Now we have to mark the data as up to date.

Restore the state of any input ReleaseDataFlags

Release any inputs if marked for release

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

Definition at line 908 of file itkProcessObject.cxx.

void itk::ProcessObject::UpdateOutputInformation ( void )

virtualinherited

Update the information decribing the output data. This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Watch out for loops in the pipeline

Since we are in a loop, we will want to update. But if we don't modify this filter, then we will not execute because our OutputInformationMTime will be more recent than the MTime of our output.

We now wish to set the PipelineMTime of each output DataObject to the largest of this ProcessObject's MTime, all input DataObject's PipelineMTime, and all input's MTime. We begin with the MTime of this ProcessObject.

Loop through the inputs

Propagate the UpdateOutputInformation call

What is the PipelineMTime of this input? Compare this against our current computation to find the largest one.

Pipeline MTime of the input does not include the MTime of the data object itself. Factor these mtimes into the next PipelineMTime

Call GenerateOutputInformation for subclass specific information. Since UpdateOutputInformation propagates all the way up the pipeline, we need to be careful here to call GenerateOutputInformation only if necessary. Otherwise, we may cause this source to be modified which will cause it to execute again on the next update.

Keep track of the last time GenerateOutputInformation() was called

Reimplemented in otb::watershed::Segmenter< TInputImage >, itk::watershed::Segmenter< TInputImage >, otb::watershed::Segmenter< InputImageType >, itk::watershed::Segmenter< InputImageType >, and itk::VTKImageImport< TOutputImage >.

Definition at line 664 of file itkProcessObject.cxx.

References itk::Object::GetMTime(), itk::DataObject::GetPipelineMTime(), itk::DataObject::SetPipelineMTime(), and itk::DataObject::UpdateOutputInformation().

Referenced by itk::VTKImageExportBase::UpdateInformationCallback().

void itk::ProcessObject::UpdateProgress ( float amount )

inherited

Update the progress of the process object.

Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress.

Update the progress of the process object. If a ProgressMethod exists, execute it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Definition at line 500 of file itkProcessObject.cxx.

Referenced by itk::WatershedMiniPipelineProgressCommand::Execute(), otb::otb_UpdateGDALProgress(), itk::ProgressReporter::ProgressReporter(), and itk::ProgressReporter::~ProgressReporter().

Member Data Documentation

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

const unsigned int otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::ImageDimension = InputImageType::ImageDimension

static

Definition at line 489 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage>

const unsigned int itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

staticinherited

ImageDimension constants

Definition at line 90 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

InputIndexType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_GlobalShift

private

Definition at line 661 of file otbMeanShiftSmoothingImageFilter.h.

Referenced by otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::MeanShiftSmoothingImageFilter().

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

RealVectorImageType::Pointer otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_JointImage

private

Input data in the joint spatial-range domain, scaled by the bandwidths

Definition at line 632 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

KernelType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_Kernel

private

Kernel object, implementing operator() which returns a weight between 0 and 1 depending on the squared norm given in parameter

Definition at line 626 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

unsigned int otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_MaxIterationNumber

private

Maximum number of iterations

Definition at line 622 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

bool otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_ModeSearch

private

Boolean to enable mode search

Definition at line 643 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

ModeTableImageType::Pointer otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_ModeTable

private

Image to store the status at each pixel: 0 : no mode has been found yet 1 : a mode has been assigned to this pixel 2 : pixel is in the path of the currently processed pixel and a mode will be assigned to it

Definition at line 640 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

unsigned int otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_NumberOfComponentsPerPixel

private

Number of components per pixel in the input image

Definition at line 629 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

itk::VariableLengthVector<LabelType> otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_NumLabels

private

Mode counters (local to each thread)

Definition at line 651 of file otbMeanShiftSmoothingImageFilter.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime

protectedinherited

Time when GenerateOutputInformation was last called.

Definition at line 421 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

RealType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_RangeBandwidth

private

Range bandwidth

Definition at line 610 of file otbMeanShiftSmoothingImageFilter.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

RealType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_SpatialBandwidth

private

Spatial bandwidth

Definition at line 613 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

InputSizeType otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_SpatialRadius

private

Radius of pixel neighborhood, determined by the kernel from the spatial bandwidth

Definition at line 616 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

unsigned int otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_ThreadIdNumberOfBits

private

Number of bits used to represent the threadId in the most significant bits of labels

Definition at line 654 of file otbMeanShiftSmoothingImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>

double otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::m_Threshold

private

Threshold on the squared norm of the mean shift vector to decide when to stop iterating

Definition at line 619 of file otbMeanShiftSmoothingImageFilter.h.

bool itk::ProcessObject::m_Updating

protectedinherited

These ivars are made protected so filters like itkStreamingImageFilter can access them directly. This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Definition at line 418 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

const unsigned int itk::ImageToImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

staticinherited

Definition at line 92 of file itkImageToImageFilter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>> class otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInputImage, class TOutputImage, class TKernel = Meanshift::KernelUniform, class TOutputIterationImage = otb::Image<unsigned int, TInputImage::ImageDimension>>
class otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >