Orfeo Toolbox  3.16
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample > Class Template Reference

Integration point for MembershipCalculator, DecisionRule, and target sample data. This class is functionally identical to the SampleClassifier, except that users can perform only part of the input sample that belongs to the subset of classes. More...

#include <itkSampleClassifierWithMask.h>

+ Inheritance diagram for itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >:
+ Collaboration diagram for itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >:

Public Types

typedef Superclass::ClassLabelType ClassLabelType
 
typedef
Superclass::ClassLabelVectorType 		ClassLabelVectorType
 
typedef SmartPointer< const Self > ConstPointer
 
typedef DecisionRuleBase DecisionRuleType
 
typedef TSample::MeasurementType MeasurementType
 
typedef
TSample::MeasurementVectorType 		MeasurementVectorType
 
typedef
MembershipFunctionType::Pointer 		MembershipFunctionPointer
 
typedef
Superclass::MembershipFunctionPointerVector 		MembershipFunctionPointerVector
 
typedef
Statistics::MembershipFunctionBase
< MeasurementVectorType > 		MembershipFunctionType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< Self > Pointer
 
typedef SampleClassifierWithMask Self
 
typedef SampleClassifier< TSample > Superclass
 

Public Member Functions

virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
unsigned int AddMembershipFunction (MembershipFunctionType *function)
 
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 const bool & GetAbortGenerateData ()
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
DecisionRuleType * GetDecisionRule (void)
 
TMaskSample * GetMask ()
 
const MembershipFunctionType * GetMembershipFunction (unsigned int index) const
 
ClassLabelVectorType & GetMembershipFunctionClassLabels ()
 
MetaDataDictionary & GetMetaDataDictionary (void)
 
const MetaDataDictionary & GetMetaDataDictionary (void) const
 
virtual unsigned long GetMTime () const
 
virtual const char * GetNameOfClass () const
 
virtual const unsigned int & GetNumberOfClasses ()
 
unsigned int GetNumberOfMembershipFunctions ()
 
OutputType * GetOutput ()
 
virtual const float & GetProgress ()
 
virtual int GetReferenceCount () const
 
const TSample * GetSample () 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)
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetDebug (bool debugFlag) const
 
void SetDecisionRule (DecisionRuleType *ptrToDecisionRule)
 
void SetMask (TMaskSample *mask)
 
void SetMembershipFunctionClassLabels (ClassLabelVectorType &labels)
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetNumberOfClasses (unsigned int _arg)
 
void SetOtherClassLabel (ClassLabelType label)
 
virtual void SetProgress (float _arg)
 
virtual void SetReferenceCount (int)
 
void SetSample (const TSample *sample)
 
void SetSelectedClassLabels (ClassLabelVectorType &labels)
 
virtual void UnRegister () const
 
void Update ()
 
virtual void UpdateOutputData ()
 
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)
 

Protected Types

typedef int InternalReferenceCountType
 

Protected Member Functions

 SampleClassifierWithMask ()
 
virtual ~SampleClassifierWithMask ()
 
void GenerateData ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 

Protected Attributes

InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Private Attributes

TMaskSample::Pointer m_Mask
 
ClassLabelType m_OtherClassLabel
 
ClassLabelVectorType m_SelectedClassLabels
 

Detailed Description

template<class TSample, class TMaskSample>
class itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >

Integration point for MembershipCalculator, DecisionRule, and target sample data. This class is functionally identical to the SampleClassifier, except that users can perform only part of the input sample that belongs to the subset of classes.

To this purpose, this class needs a class mask sample that has class labels as measurement vectors. Using SetMask method, users can provide the class mask sample.

To specify which classes should be included for classification, users must call SetSelectedClassLabels method with class labels that will be included. All measurement vectors that belong to the non-selected classes will be classified to the class label that has been given by the SetOtherClassLabel method.

Except for the modifications mentioned above, the basic behavior and methods are identical to those of SampleClassifier.

Recent API changes: The static const macro to get the length of a measurement vector, MeasurementVectorSize has been removed to allow the length of a measurement vector to be specified at run time. Please use the function GetMeasurementVectorSize() instead.

See Also
SampleClassifier

Definition at line 60 of file itkSampleClassifierWithMask.h.

Member Typedef Documentation

template<class TSample , class TMaskSample >
typedef Superclass::ClassLabelType itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::ClassLabelType

Definition at line 76 of file itkSampleClassifierWithMask.h.

template<class TSample , class TMaskSample >
typedef Superclass::ClassLabelVectorType itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::ClassLabelVectorType

Definition at line 77 of file itkSampleClassifierWithMask.h.

template<class TSample , class TMaskSample >
typedef SmartPointer<const Self> itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::ConstPointer

Definition at line 68 of file itkSampleClassifierWithMask.h.

typedef DecisionRuleBase itk::ClassifierBase< TSample >::DecisionRuleType
inherited

Type alias for decision rule

Definition at line 114 of file itkClassifierBase.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 TSample , class TMaskSample >
typedef TSample::MeasurementType itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::MeasurementType

typedefs from TSample object

Definition at line 80 of file itkSampleClassifierWithMask.h.

template<class TSample , class TMaskSample >
typedef TSample::MeasurementVectorType itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::MeasurementVectorType

Definition at line 81 of file itkSampleClassifierWithMask.h.

typedef MembershipFunctionType::Pointer itk::ClassifierBase< TSample >::MembershipFunctionPointer
inherited

Definition at line 108 of file itkClassifierBase.h.

template<class TSample , class TMaskSample >
typedef Superclass::MembershipFunctionPointerVector itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::MembershipFunctionPointerVector

typedefs from Superclass

Definition at line 86 of file itkSampleClassifierWithMask.h.

typedef Statistics::MembershipFunctionBase< MeasurementVectorType > itk::ClassifierBase< TSample >::MembershipFunctionType
inherited

Typedefs for membership funciton

Definition at line 107 of file itkClassifierBase.h.

template<class TSample , class TMaskSample >
typedef Superclass::OutputType itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::OutputType

Superclass typedefs

Definition at line 72 of file itkSampleClassifierWithMask.h.

template<class TSample , class TMaskSample >
typedef SmartPointer< Self > itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::Pointer

Definition at line 67 of file itkSampleClassifierWithMask.h.

template<class TSample , class TMaskSample >
typedef SampleClassifierWithMask itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::Self

Standard class typedefs

Definition at line 65 of file itkSampleClassifierWithMask.h.

template<class TSample , class TMaskSample >
typedef SampleClassifier< TSample > itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::Superclass

Definition at line 66 of file itkSampleClassifierWithMask.h.

Constructor & Destructor Documentation

template<class TSample , class TMaskSample >
itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::SampleClassifierWithMask ( )
protected

Definition at line 27 of file itkSampleClassifierWithMask.txx.

template<class TSample , class TMaskSample >
virtual itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::~SampleClassifierWithMask ( )
inlineprotectedvirtual

Definition at line 101 of file itkSampleClassifierWithMask.h.

Member Function Documentation

virtual void itk::LightProcessObject::AbortGenerateDataOff ( )
virtualinherited
virtual void itk::LightProcessObject::AbortGenerateDataOn ( )
virtualinherited

Turn on and off the AbortGenerateData flag.

unsigned int itk::ClassifierBase< TSample >::AddMembershipFunction ( MembershipFunctionType *  function)
inherited

Stores a membership function of a class in its internal vector

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 TSample , class TMaskSample >
virtual::itk::LightObject::Pointer itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::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::Statistics::SampleClassifier< TSample >.

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.

template<class TSample , class TMaskSample >
void itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::GenerateData ( void  )
protectedvirtual

Starts the classification process

Reimplemented from itk::Statistics::SampleClassifier< TSample >.

Definition at line 73 of file itkSampleClassifierWithMask.txx.

References itk::Statistics::MembershipSample< TSample >::AddInstance(), itk::Statistics::MembershipSample< TSample >::Resize(), and itk::Statistics::MembershipSample< TSample >::SetNumberOfClasses().

virtual const bool& itk::LightProcessObject::GetAbortGenerateData ( )
virtualinherited

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

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

DecisionRuleType* itk::ClassifierBase< TSample >::GetDecisionRule ( void  )
inlineinherited

Gets the pointer to the decision rule being used.

Definition at line 125 of file itkClassifierBase.h.

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 TSample , class TMaskSample >
TMaskSample* itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::GetMask ( )
inline

Definition at line 90 of file itkSampleClassifierWithMask.h.

const MembershipFunctionType* itk::ClassifierBase< TSample >::GetMembershipFunction ( unsigned int  index) const
inlineinherited

Gets the MembershipFunction that are plugged in by the AddMembershipFunction method. The index is assigned according to the order each membership function has been added using the AddMemberShipFunction method

Definition at line 134 of file itkClassifierBase.h.

template<class TSample>
ClassLabelVectorType& itk::Statistics::SampleClassifier< TSample >::GetMembershipFunctionClassLabels ( )
inlineinherited

Gets the user given class labels

Definition at line 115 of file itkSampleClassifier.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.

Referenced by otb::RenderingImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData(), itk::Brains2MaskImageIO::CanReadFile(), otb::DataNode< TPrecision, VDimension, TValuePrecision >::CopyFieldList(), otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), otb::Image< TPixel, VImageDimension >::CopyInformation(), itk::GDCMImageIO::GetBodyPart(), itk::GDCMImageIO::GetInstitution(), itk::GDCMImageIO::GetManufacturer(), itk::GDCMImageIO::GetModality(), itk::GDCMImageIO::GetModel(), itk::GDCMImageIO::GetNumberOfSeriesInStudy(), itk::GDCMImageIO::GetNumberOfStudyRelatedSeries(), itk::GDCMImageIO::GetPatientAge(), itk::GDCMImageIO::GetPatientDOB(), itk::GDCMImageIO::GetPatientID(), itk::GDCMImageIO::GetPatientName(), itk::GDCMImageIO::GetPatientSex(), itk::GDCMImageIO::GetScanOptions(), itk::GDCMImageIO::GetStudyDate(), itk::GDCMImageIO::GetStudyDescription(), itk::GDCMImageIO::GetStudyID(), itk::GDCMImageIO::GetValueFromTag(), otb::GDALImageIO::InternalReadImageInformation(), itk::GDCMImageIO::InternalReadImageInformation(), otb::GDALImageIO::InternalWriteImageInformation(), otb::RAMDrivenAdaptativeStreamingManager< TImage >::PrepareStreaming(), itk::DICOMImageIO2::Read(), itk::DICOMImageIO2::ReadImageInformation(), itk::NrrdImageIO::ReadImageInformation(), otb::JPEG2000ImageIO::ReadImageInformation(), itk::MetaImageIO::ReadImageInformation(), itk::VoxBoCUBImageIO::ReadImageInformation(), itk::MRCImageIO::ReadImageInformation(), itk::IPLCommonImageIO::ReadImageInformation(), itk::PhilipsRECImageIO::ReadImageInformation(), itk::AnalyzeImageIO::ReadImageInformation(), itk::Bruker2DSEQImageIO::ReadImageInformation(), otb::ImageMetadataInterfaceBase::SetImage(), itk::NiftiImageIO::SetImageIOMetadataFromNIfTI(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), itk::NrrdImageIO::Write(), itk::GDCMImageIO::Write(), and itk::PolygonGroupSpatialObjectXMLFileWriter::WriteFile().

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.

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

Return this objects modified time.

Return the modification for this object.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::SpatialObject< TDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, otb::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::MeshSpatialObject< TMesh >, and itk::SceneSpatialObject< TSpaceDimension >.

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 TSample , class TMaskSample >
virtual const char* itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::GetNameOfClass ( ) const
virtual

Standard macros

Reimplemented from itk::Statistics::SampleClassifier< TSample >.

virtual const unsigned int& itk::ClassifierBase< TSample >::GetNumberOfClasses ( void  )
virtualinherited

Gets the number of classes.

unsigned int itk::ClassifierBase< TSample >::GetNumberOfMembershipFunctions ( )
inlineinherited

Gets the number of membership functions

Definition at line 140 of file itkClassifierBase.h.

template<class TSample >
SampleClassifier< TSample >::OutputType * itk::Statistics::SampleClassifier< TSample >::GetOutput ( void  )
inherited

Returns the classification result

Definition at line 136 of file itkSampleClassifier.txx.

virtual const float& itk::LightProcessObject::GetProgress ( )
virtualinherited

Get the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

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

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

template<class TSample >
const TSample * itk::Statistics::SampleClassifier< TSample >::GetSample ( ) const
inherited

Returns the target data

Definition at line 68 of file itkSampleClassifier.txx.

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.

Reimplemented in otb::SVMModel< TValue, TLabel >, otb::SurfaceAdjacencyEffect6SCorrectionSchemeFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, otb::GenericRSTransform< TScalarType, NInputDimensions, NOutputDimensions >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, TBufferConverter >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, MeanShift::VectorBufferConverter >, otb::GCPsToRPCSensorModelImageFilter< TImage >, otb::Polygon< TValue >, otb::ImageRegionAdaptativeSplitter< VImageDimension >, otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, VDimension >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, 2 >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, otb::PhysicalToRPCSensorModelImageFilter< TImage >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >, itk::NormalizeImageFilter< TInputImage, TOutputImage >, and otb::StatisticsXMLFileReader< TMeasurementVector >.

Definition at line 297 of file itkObject.cxx.

Referenced by otb::Wrapper::InputImageListParameter::AddFromFileName(), otb::Wrapper::InputVectorDataListParameter::AddFromFileName(), otb::Wrapper::InputFilenameListParameter::AddFromFileName(), otb::Wrapper::InputImageListParameter::AddImage(), otb::Wrapper::InputVectorDataListParameter::AddNullElement(), otb::Wrapper::InputImageListParameter::AddNullElement(), otb::Wrapper::InputFilenameListParameter::AddNullElement(), otb::Wrapper::StringListParameter::AddNullElement(), otb::VectorDataModel::AddPointToGeometry(), otb::Wrapper::InputVectorDataListParameter::AddVectorData(), otb::Wrapper::InputFilenameListParameter::ClearValue(), otb::Wrapper::InputVectorDataListParameter::ClearValue(), otb::Wrapper::InputImageListParameter::ClearValue(), otb::VectorDataModel::DeleteGeometry(), otb::VectorDataModel::EndGeometry(), otb::Wrapper::InputFilenameListParameter::Erase(), otb::Wrapper::InputVectorDataListParameter::Erase(), otb::Wrapper::InputImageListParameter::Erase(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), otb::ImageWidget< TInputImage >::LinearInterpolationOff(), otb::ImageWidget< TInputImage >::LinearInterpolationOn(), itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >::MatrixOffsetTransformBase(), otb::ogr::ImageReference< double >::Modified(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetAutoMinMax(), otb::BlendingImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetBlendingFunction(), otb::ImageLayerGenerator< TImageLayer >::SetBlendingFunction(), otb::TileMapImageIO::SetCacheDirectory(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetChannelList(), itk::LBFGSBOptimizer::SetCostFunction(), itk::MINC2ImageIO::SetDimensionName(), itk::ImageIOBase::SetDimensions(), otb::ImageIOBase::SetDimensions(), itk::ImageIOBase::SetDirection(), otb::ImageIOBase::SetDirection(), otb::Wrapper::InputImageListParameter::SetImageList(), itk::GDCMSeriesFileNames::SetInputDirectory(), otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram(), otb::ImageToGenericRSOutputParameters< TImage >::SetInputKeywordList(), otb::Wrapper::InputImageListParameter::SetListFromFileName(), otb::Wrapper::InputVectorDataListParameter::SetListFromFileName(), otb::Wrapper::InputFilenameListParameter::SetListFromFileName(), otb::Function::RenderingFunction< TPixel, TRGBPixel >::SetListSample(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), otb::Wrapper::InputVectorDataListParameter::SetNthFileName(), otb::Wrapper::InputImageListParameter::SetNthFileName(), otb::Wrapper::InputFilenameListParameter::SetNthFileName(), otb::ImageIOBase::SetNumberOfDimensions(), itk::ImageIOBase::SetNumberOfDimensions(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ImageIOBase::SetOrigin(), otb::ImageIOBase::SetOrigin(), otb::ImageToGenericRSOutputParameters< TImage >::SetOutputProjectionRef(), otb::MapProjectionAdapter::SetParameter(), otb::Function::GaussianRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), otb::ImageLayerGenerator< TImageLayer >::SetRenderingFunction(), otb::RenderingImageFilter< TInputImage, TOutputImage >::SetRenderingFunction(), itk::ImageIOBase::SetSpacing(), otb::ImageIOBase::SetSpacing(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation(), otb::Wrapper::InputFilenameParameter::SetValue(), otb::Wrapper::OutputFilenameParameter::SetValue(), otb::Wrapper::ListViewParameter::SetValue(), otb::Wrapper::ChoiceParameter::SetValue(), otb::Wrapper::InputVectorDataListParameter::SetVectorDataList(), and otb::MapProjectionAdapter::SetWkt().

template<class TSample , class TMaskSample >
static Pointer itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::New ( )
static
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 TSample , class TMaskSample >
void itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::Statistics::SampleClassifier< TSample >.

Definition at line 36 of file itkSampleClassifierWithMask.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().

virtual void itk::LightProcessObject::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.

void itk::ClassifierBase< TSample >::SetDecisionRule ( DecisionRuleType *  ptrToDecisionRule)
inlineinherited

Sets the pointer to the decision rule. Stores the decision rule that makes the real decision using informations from MembershipFunctions and other prior knowledge

Definition at line 119 of file itkClassifierBase.h.

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 TSample , class TMaskSample >
void itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::SetMask ( TMaskSample *  mask)

Definition at line 62 of file itkSampleClassifierWithMask.txx.

template<class TSample >
void itk::Statistics::SampleClassifier< TSample >::SetMembershipFunctionClassLabels ( ClassLabelVectorType &  labels)
inherited

Sets the user given class labels for membership functions. If users do not provide class labels for membership functions by calling this function, then the index of the membership function vector for a membership function will be used as class label of measurement vectors belong to the membership function

Definition at line 76 of file itkSampleClassifier.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().

virtual void itk::ClassifierBase< TSample >::SetNumberOfClasses ( unsigned int  _arg)
virtualinherited

Sets the number of classes.

template<class TSample , class TMaskSample >
void itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::SetOtherClassLabel ( ClassLabelType  label)
inline

Definition at line 96 of file itkSampleClassifierWithMask.h.

virtual void itk::LightProcessObject::SetProgress ( float  _arg)
virtualinherited

Set the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

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.

template<class TSample>
void itk::Statistics::SampleClassifier< TSample >::SetSample ( const TSample *  sample)
inherited

Sets the target data that will be classified by this

Definition at line 56 of file itkSampleClassifier.txx.

template<class TSample , class TMaskSample >
void itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::SetSelectedClassLabels ( ClassLabelVectorType &  labels)
inline

Definition at line 93 of file itkSampleClassifierWithMask.h.

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::ClassifierBase< TSample >::Update ( void  )
inherited

Starts the classification process

void itk::LightProcessObject::UpdateOutputData ( void  )
virtualinherited

Actually generate new output.

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

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

Definition at line 77 of file itkLightProcessObject.cxx.

void itk::LightProcessObject::UpdateProgress ( float  amount)
inherited

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

Definition at line 51 of file itkLightProcessObject.cxx.

Member Data Documentation

template<class TSample , class TMaskSample >
TMaskSample::Pointer itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::m_Mask
private

Mask sample pointer

Definition at line 109 of file itkSampleClassifierWithMask.h.

template<class TSample , class TMaskSample >
ClassLabelType itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::m_OtherClassLabel
private

Definition at line 111 of file itkSampleClassifierWithMask.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 TSample , class TMaskSample >
ClassLabelVectorType itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >::m_SelectedClassLabels
private

Definition at line 110 of file itkSampleClassifierWithMask.h.

The documentation for this class was generated from the following files:
Generated at Sun May 19 2013 03:03:56 for Orfeo Toolbox with doxygen 1.8.3.1