Calculate the Hu's invariant parameter. More...

#include <otbHuPathFunction.h>

Inheritance diagram for otb::HuPathFunction< TInputPath, TOutput, TPrecision >:

Collaboration diagram for otb::HuPathFunction< TInputPath, TOutput, TPrecision >:

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

typedef InputPathType::ConstPointer	InputPathConstPointer

typedef Superclass::InputType	InputPathType

typedef TInputPath	InputType

typedef Superclass::OutputType	OutputType

typedef Superclass::PathConstPointer	PathConstPointer

typedef Superclass::PathType	PathType

typedef itk::SmartPointer< Self >	Pointer

typedef Superclass::PrecisionType	PrecisionType

typedef Superclass::RealType	RealType

typedef HuPathFunction	Self

typedef RealMomentPathFunction < TInputPath, TOutput, TPrecision >	Superclass

typedef VertexListType::ConstPointer	VertexListPointer

typedef itk::VectorContainer < unsigned, VertexType >	VertexListType

typedef PathType::ContinuousIndexType	VertexType

Public Member Functions
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 OutputType	Evaluate (const InputType &input) const =0

virtual RealType	Evaluate (const PathType &path) const

virtual RealType	Evaluate () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

const InputPathType *	GetInputPath () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual const short &	GetMomentNumber ()

virtual unsigned long	GetMTime () const

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

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

virtual void	Register () const

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

virtual void	SetInputPath (const InputPathType *ptr)

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetMomentNumber (short _arg)

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const

Static Public Member Functions
static void	BreakOnError ()

static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	HuPathFunction ()

virtual	~HuPathFunction ()

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

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

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

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

Protected Attributes
InputPathConstPointer	m_Path

InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
	HuPathFunction (const Self &)

void	operator= (const Self &)

Private Attributes
short	m_MomentNumber

Detailed Description

template<class TInputPath, class TOutput = double, class TPrecision = double>
class otb::HuPathFunction< TInputPath, TOutput, TPrecision >

Calculate the Hu's invariant parameter.

Calculate the Hu's invariant defined as:

$\phi_{1} = c_{11}$
$\phi_{2} = c_{20} c_{02}$
$\phi_{3} = c_{30} c_{03}$
$\phi_{4} = c_{21} c_{12}$
$\phi_{5} = Re (c_{30} c_{12}^{3})$
$\phi_{6} = Re (c_{20} c_{12}^{2})$
$\phi_{7} = Im (c_{30} c_{12}^{3})$

With :

$c_{p, q}=\int \int (x+iy)^{p} \cdot (x-iy)^{q} \cdot f(x, y) \cdot dx \cdot dy$

And:

pixel localization;
the pixel value over the coordinate.

This class is templated over the input image type and the path type (e.g. PolyLineParametricPath<2> ).

Definition at line 58 of file otbHuPathFunction.h.

Member Typedef Documentation

template<class TInputPath, class TOutput = double, class TPrecision = double>

typedef itk::SmartPointer<const Self> otb::HuPathFunction< TInputPath, TOutput, TPrecision >::ConstPointer

Definition at line 66 of file otbHuPathFunction.h.

template<class TInputPath , class TOutput >

typedef InputPathType::ConstPointer otb::PathFunction< TInputPath, TOutput >::InputPathConstPointer

inherited

InputPathPointer typedef support

Definition at line 62 of file otbPathFunction.h.

template<class TInputPath , class TOutput >

typedef Superclass::InputType otb::PathFunction< TInputPath, TOutput >::InputPathType

inherited

InputPathType typedef support.

Definition at line 56 of file otbPathFunction.h.

typedef TInputPath itk::FunctionBase< TInputPath , TOutput >::InputType

inherited

Input type

Definition at line 53 of file itkFunctionBase.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 TInputPath , class TOutput , class TPrecision = double>

typedef Superclass::OutputType otb::GeometricMomentPathFunction< TInputPath, TOutput, TPrecision >::OutputType

inherited

OutputPathType typedef support.

Definition at line 54 of file otbGeometricMomentPathFunction.h.

template<class TInputPath, class TOutput = double, class TPrecision = double>

typedef Superclass::PathConstPointer otb::HuPathFunction< TInputPath, TOutput, TPrecision >::PathConstPointer

Definition at line 76 of file otbHuPathFunction.h.

template<class TInputPath, class TOutput = double, class TPrecision = double>

typedef Superclass::PathType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::PathType

InputPathType typedef support.

Definition at line 72 of file otbHuPathFunction.h.

template<class TInputPath, class TOutput = double, class TPrecision = double>

typedef itk::SmartPointer<Self> otb::HuPathFunction< TInputPath, TOutput, TPrecision >::Pointer

Definition at line 65 of file otbHuPathFunction.h.

template<class TInputPath, class TOutput = double, class TPrecision = double>

typedef Superclass::PrecisionType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::PrecisionType

Type for calculation precision

Definition at line 85 of file otbHuPathFunction.h.

template<class TInputPath, class TOutput = double, class TPrecision = double>

typedef Superclass::RealType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::RealType

OutputType typedef support.

Definition at line 82 of file otbHuPathFunction.h.

template<class TInputPath, class TOutput = double, class TPrecision = double>

typedef HuPathFunction otb::HuPathFunction< TInputPath, TOutput, TPrecision >::Self

Standard class typedefs.

Definition at line 63 of file otbHuPathFunction.h.

template<class TInputPath, class TOutput = double, class TPrecision = double>

typedef RealMomentPathFunction<TInputPath, TOutput, TPrecision> otb::HuPathFunction< TInputPath, TOutput, TPrecision >::Superclass

Definition at line 64 of file otbHuPathFunction.h.

template<class TInputPath, class TOutput = double, class TPrecision = double>

typedef VertexListType::ConstPointer otb::HuPathFunction< TInputPath, TOutput, TPrecision >::VertexListPointer

Definition at line 79 of file otbHuPathFunction.h.

template<class TInputPath, class TOutput = double, class TPrecision = double>

typedef itk::VectorContainer<unsigned, VertexType> otb::HuPathFunction< TInputPath, TOutput, TPrecision >::VertexListType

Definition at line 78 of file otbHuPathFunction.h.

template<class TInputPath, class TOutput = double, class TPrecision = double>

typedef PathType::ContinuousIndexType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::VertexType

Definition at line 77 of file otbHuPathFunction.h.

Constructor & Destructor Documentation

template<class TInputPath , class TOutput , class TPrecision >

otb::HuPathFunction< TInputPath, TOutput, TPrecision >::HuPathFunction ( )

protected

Constructor

Definition at line 35 of file otbHuPathFunction.txx.

template<class TInputPath, class TOutput = double, class TPrecision = double>

virtual otb::HuPathFunction< TInputPath, TOutput, TPrecision >::~HuPathFunction ( )

inlineprotectedvirtual

Definition at line 97 of file otbHuPathFunction.h.

template<class TInputPath, class TOutput = double, class TPrecision = double>

otb::HuPathFunction< TInputPath, TOutput, TPrecision >::HuPathFunction ( const Self & )

private

Member Function Documentation

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::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.

template<class TInputPath, class TOutput = double, class TPrecision = double>

virtual::itk::LightObject::Pointer otb::HuPathFunction< TInputPath, TOutput, TPrecision >::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 OutputType itk::FunctionBase< TInputPath , TOutput >::Evaluate ( const InputType & input ) const

pure virtualinherited

Evaluate at the specified input position

template<class TInputPath , class TOutput , class TPrecision >

HuPathFunction< TInputPath, TOutput, TPrecision >::RealType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::Evaluate ( const PathType & path ) const

virtual

Evaluate the function at non-integer positions

Definition at line 55 of file otbHuPathFunction.txx.

template<class TInputPath , class TOutput , class TPrecision >

HuPathFunction< TInputPath, TOutput, TPrecision >::RealType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::Evaluate ( ) const

virtual

Definition at line 175 of file otbHuPathFunction.txx.

References otbMsgDevMacro.

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 TInputPath , class TOutput >

const InputPathType* otb::PathFunction< TInputPath, TOutput >::GetInputPath ( void ) const

inlineinherited

Get the input path.

Definition at line 71 of file otbPathFunction.h.

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 TInputPath, class TOutput = double, class TPrecision = double>

virtual const short& otb::HuPathFunction< TInputPath, TOutput, TPrecision >::GetMomentNumber ( )

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(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), otb::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().

template<class TInputPath, class TOutput = double, class TPrecision = double>

virtual const char* otb::HuPathFunction< TInputPath, TOutput, TPrecision >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from otb::RealMomentPathFunction< TInputPath, TOutput, TPrecision >.

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

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

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().

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.

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 TInputPath, class TOutput = double, class TPrecision = double>

static Pointer otb::HuPathFunction< TInputPath, TOutput, TPrecision >::New ( )

static

Method for creation through the object factory.

template<class TInputPath, class TOutput = double, class TPrecision = double>

void otb::HuPathFunction< TInputPath, TOutput, TPrecision >::operator= ( const Self & )

private

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 TInputPath , class TOutput , class TPrecision >

void otb::HuPathFunction< TInputPath, TOutput, TPrecision >::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

protectedvirtual

Standard "PrintSelf" method

Reimplemented from otb::GeometricMomentPathFunction< TInputPath, TOutput, TPrecision >.

Definition at line 46 of file otbHuPathFunction.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::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().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.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::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.

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 TInputPath , class TOutput >

void otb::PathFunction< TInputPath, TOutput >::SetInputPath ( const InputPathType * ptr )

virtualinherited

Set the input path.

Initialize by setting the input image

Definition at line 54 of file otbPathFunction.txx.

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 TInputPath, class TOutput = double, class TPrecision = double>

virtual void otb::HuPathFunction< TInputPath, TOutput, TPrecision >::SetMomentNumber ( short _arg )

virtual

Get/Set the radius of the neighborhood over which the statistics are evaluated

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.

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().

Member Data Documentation

template<class TInputPath, class TOutput = double, class TPrecision = double>

short otb::HuPathFunction< TInputPath, TOutput, TPrecision >::m_MomentNumber

private

Definition at line 104 of file otbHuPathFunction.h.

template<class TInputPath , class TOutput >

InputPathConstPointer otb::PathFunction< TInputPath, TOutput >::m_Path

protectedinherited

Definition at line 81 of file otbPathFunction.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.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<class TInputPath, class TOutput = double, class TPrecision = double> class otb::HuPathFunction< TInputPath, TOutput, TPrecision >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInputPath, class TOutput = double, class TPrecision = double>
class otb::HuPathFunction< TInputPath, TOutput, TPrecision >