itk::Statistics::WeightedCovarianceCalculator< TSample > Class Template Reference
#include <itkWeightedCovarianceCalculator.h>
Detailed Description
template<class TSample>
class itk::Statistics::WeightedCovarianceCalculator< TSample >
Calculates the covariance matrix of the target sample data where each measurement vector has an associated weight value.
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. It is now obtained from the input sample. Please use the function GetMeasurementVectorSize() to obtain the length. The mean output is an Array rather than a Vector. The covariance matrix is represented by a VariableSizeMatrix rather than a Matrix.
- See also:
- CovarianceCalculator SampleAlgorithmBase
Definition at line 42 of file itkWeightedCovarianceCalculator.h.
Member Typedef Documentation
| typedef SmartPointer<const Self> itk::Statistics::WeightedCovarianceCalculator< TSample >::ConstPointer |
Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.
Definition at line 50 of file itkWeightedCovarianceCalculator.h.
typedef TSample itk::Statistics::SampleAlgorithmBase< TSample >::InputSampleType [inherited] |
Sample typedefs alias
Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >, and itk::Statistics::SampleMeanShiftBlurringFilter< TSample >.
Definition at line 59 of file itkSampleAlgorithmBase.h.
typedef int itk::LightObject::InternalReferenceCountType [protected, inherited] |
Define the type of the reference count according to the target. This allows the use of atomic operations
Definition at line 139 of file itkLightObject.h.
| typedef Array< double > itk::Statistics::WeightedCovarianceCalculator< TSample >::MeanType |
Typedef for the mean output
Definition at line 67 of file itkWeightedCovarianceCalculator.h.
| typedef Superclass::MeasurementVectorSizeType itk::Statistics::WeightedCovarianceCalculator< TSample >::MeasurementVectorSizeType |
Length of a measurement vector
Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.
Definition at line 54 of file itkWeightedCovarianceCalculator.h.
| typedef TSample::MeasurementVectorType itk::Statistics::WeightedCovarianceCalculator< TSample >::MeasurementVectorType |
Measurement vector typedef
Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.
Definition at line 61 of file itkWeightedCovarianceCalculator.h.
| typedef VariableSizeMatrix< double > itk::Statistics::WeightedCovarianceCalculator< TSample >::OutputType |
Typedef for Covariance output
Definition at line 70 of file itkWeightedCovarianceCalculator.h.
| typedef SmartPointer<Self> itk::Statistics::WeightedCovarianceCalculator< TSample >::Pointer |
Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.
Definition at line 49 of file itkWeightedCovarianceCalculator.h.
| typedef WeightedCovarianceCalculator itk::Statistics::WeightedCovarianceCalculator< TSample >::Self |
Standard class typedefs.
Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.
Definition at line 47 of file itkWeightedCovarianceCalculator.h.
| typedef SampleAlgorithmBase< TSample > itk::Statistics::WeightedCovarianceCalculator< TSample >::Superclass |
Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.
Definition at line 48 of file itkWeightedCovarianceCalculator.h.
| typedef Array< double > itk::Statistics::WeightedCovarianceCalculator< TSample >::WeightArrayType |
Array typedef for weights
Definition at line 73 of file itkWeightedCovarianceCalculator.h.
| typedef FunctionBase< MeasurementVectorType, double > itk::Statistics::WeightedCovarianceCalculator< TSample >::WeightFunctionType |
Weight calculation function typedef
Definition at line 64 of file itkWeightedCovarianceCalculator.h.
Constructor & Destructor Documentation
| itk::Statistics::WeightedCovarianceCalculator< TSample >::WeightedCovarianceCalculator | ( | ) | [protected] |
| virtual itk::Statistics::WeightedCovarianceCalculator< TSample >::~WeightedCovarianceCalculator | ( | ) | [protected, virtual] |
Member Function Documentation
| unsigned long itk::Object::AddObserver | ( | const EventObject & | event, | |
| Command * | ||||
| ) | const [inherited] |
| unsigned long itk::Object::AddObserver | ( | const EventObject & | event, | |
| Command * | ||||
| ) | [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
| static void itk::LightObject::BreakOnError | ( | ) | [static, inherited] |
This method is called when itkExceptionMacro executes. It allows the debugger to break on error.
| void itk::Statistics::WeightedCovarianceCalculator< TSample >::ComputeCovarianceWithGivenMean | ( | void | ) | [protected] |
| void itk::Statistics::WeightedCovarianceCalculator< TSample >::ComputeCovarianceWithoutGivenMean | ( | void | ) | [protected] |
| virtual LightObject::Pointer itk::Object::CreateAnother | ( | ) | const [virtual, inherited] |
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::LightObject.
| virtual void itk::Object::DebugOff | ( | ) | const [virtual, inherited] |
Turn debugging output off.
| virtual void itk::Object::DebugOn | ( | ) | const [virtual, inherited] |
Turn debugging output on.
| virtual void itk::LightObject::Delete | ( | ) | [virtual, inherited] |
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.
| void itk::Statistics::WeightedCovarianceCalculator< TSample >::GenerateData | ( | void | ) | [protected, virtual] |
Calculates the covariance and save it
Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.
| 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.
| bool itk::Object::GetDebug | ( | ) | const [inherited] |
Get the value of the debug flag.
| static bool itk::Object::GetGlobalWarningDisplay | ( | ) | [static, inherited] |
| const TSample * itk::Statistics::SampleAlgorithmBase< TSample >::GetInputSample | ( | ) | const [inline, inherited] |
Definition at line 82 of file itkSampleAlgorithmBase.h.
| MeanType* itk::Statistics::WeightedCovarianceCalculator< TSample >::GetMean | ( | void | ) |
Gets the mean
| virtual MeasurementVectorSizeType itk::Statistics::SampleAlgorithmBase< TSample >::GetMeasurementVectorSize | ( | ) | const [virtual, inherited] |
Get Macro to get the length of a measurement vector. This is equal to the length of each measurement vector contained in the samples that are plugged in as input to this class. GetMeasurementVectorSize() will return zero until the SetInputSample() method has been called
| const MetaDataDictionary& itk::Object::GetMetaDataDictionary | ( | void | ) | const [inherited] |
- Returns:
- A constant reference to this objects MetaDataDictionary.
| MetaDataDictionary& itk::Object::GetMetaDataDictionary | ( | void | ) | [inherited] |
| virtual unsigned long itk::Object::GetMTime | ( | ) | const [virtual, inherited] |
Return this objects modified time.
Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::ImageAdaptor< TImage, TAccessor >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, itk::SceneSpatialObject< TSpaceDimension >, itk::SpatialObject< TDimension >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.
Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().
| virtual const char* itk::Statistics::WeightedCovarianceCalculator< TSample >::GetNameOfClass | ( | ) | const [virtual] |
Standard Macros
Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.
| OutputType* itk::Statistics::WeightedCovarianceCalculator< TSample >::GetOutput | ( | void | ) |
Returns the covariance matrix of the target sample data
| virtual int itk::LightObject::GetReferenceCount | ( | ) | const [inline, virtual, inherited] |
Gets the reference count on this object.
Definition at line 106 of file itkLightObject.h.
| WeightFunctionType* itk::Statistics::WeightedCovarianceCalculator< TSample >::GetWeightFunction | ( | void | ) |
Gets the weight function
| WeightArrayType* itk::Statistics::WeightedCovarianceCalculator< TSample >::GetWeights | ( | void | ) |
Gets the weights array
| static void itk::Object::GlobalWarningDisplayOff | ( | ) | [inline, static, inherited] |
| static void itk::Object::GlobalWarningDisplayOn | ( | ) | [inline, static, inherited] |
| bool itk::Object::HasObserver | ( | const EventObject & | event | ) | const [inherited] |
Return true if an observer is registered for this event.
| void itk::Object::InvokeEvent | ( | const EventObject & | ) | const [inherited] |
Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.
| void itk::Object::InvokeEvent | ( | const EventObject & | ) | [inherited] |
Call Execute on all the Commands observing this event id.
| virtual void itk::Object::Modified | ( | ) | const [virtual, inherited] |
Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.
Reimplemented in itk::NormalizeImageFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, itk::RankImageFilter< TInputImage, TInputImage, itk::FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >.
Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().
| static Pointer itk::Statistics::WeightedCovarianceCalculator< TSample >::New | ( | ) | [static] |
Standard Macros
Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.
| void itk::LightObject::Print | ( | std::ostream & | os, | |
| Indent | indent = 0 | |||
| ) | const [inherited] |
Cause the object to print itself out.
Referenced by itk::WeakPointer< itk::ProcessObject >::Print(), and itk::SmartPointer< itk::MutualInformationImageToImageMetric >::Print().
| virtual void itk::LightObject::PrintHeader | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
| bool itk::Object::PrintObservers | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, inherited] |
| void itk::Statistics::WeightedCovarianceCalculator< TSample >::PrintSelf | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual] |
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.
Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.
| virtual void itk::LightObject::PrintTrailer | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
| virtual void itk::Object::Register | ( | ) | const [virtual, inherited] |
Increase the reference count (mark as used by another object).
Reimplemented from itk::LightObject.
| void itk::Object::RemoveAllObservers | ( | ) | [inherited] |
Remove all observers .
| void itk::Object::RemoveObserver | ( | unsigned long | tag | ) | [inherited] |
Remove the observer with this tag value.
| void itk::Object::SetDebug | ( | bool | debugFlag | ) | const [inherited] |
Set the value of the debug flag. A non-zero value turns debugging on.
| static void itk::Object::SetGlobalWarningDisplay | ( | bool | flag | ) | [static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().
| void itk::Statistics::SampleAlgorithmBase< TSample >::SetInputSample | ( | const TSample * | sample | ) | [inline, inherited] |
Stores the sample pointer
Definition at line 63 of file itkSampleAlgorithmBase.h.
| void itk::Statistics::WeightedCovarianceCalculator< TSample >::SetMean | ( | MeanType * | mean | ) |
Sets the mean (input)
| virtual void itk::Statistics::SampleAlgorithmBase< TSample >::SetMeasurementVectorSize | ( | MeasurementVectorSizeType | _arg | ) | [virtual, inherited] |
| void itk::Object::SetMetaDataDictionary | ( | const MetaDataDictionary & | rhs | ) | [inherited] |
- Returns:
- Set the MetaDataDictionary
| virtual void itk::Object::SetReferenceCount | ( | int | ) | [virtual, inherited] |
Sets the reference count (use with care)
Reimplemented from itk::LightObject.
| void itk::Statistics::WeightedCovarianceCalculator< TSample >::SetWeightFunction | ( | WeightFunctionType * | func | ) |
Sets the weights using an function the function should have a method, Evaluate(MeasurementVectorType&).
| void itk::Statistics::WeightedCovarianceCalculator< TSample >::SetWeights | ( | WeightArrayType * | array | ) |
Sets the weights using an array
| virtual void itk::Object::UnRegister | ( | ) | const [virtual, inherited] |
Decrease the reference count (release by another object).
Reimplemented from itk::LightObject.
Referenced by itk::SmartPointer< itk::MutualInformationImageToImageMetric >::operator=().
| void itk::Statistics::SampleAlgorithmBase< TSample >::Update | ( | void | ) | [inline, inherited] |
dummy function that calls the GenerateData() function to generate output. It exists for future compatibility with ProcessObject without streaming
Definition at line 88 of file itkSampleAlgorithmBase.h.
Member Data Documentation
InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited] |
Number of uses of this object by other objects.
Definition at line 144 of file itkLightObject.h.
SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited] |
Mutex lock to protect modification to the reference count
Definition at line 147 of file itkLightObject.h.
The documentation for this class was generated from the following file:
