#include <itkKLMSegmentationRegion.h>
Inheritance diagram for itk::KLMSegmentationRegion:
itkKLMSegmentationRegion is the base class for the KLMSegmentationRegion objects. It provides the basic function definitions that are inherent to KLMSegmentationRegion objects.
This object supports data handling of multiband images. The object accepts images in vector format, where each pixel is a vector and each element of the vector corresponds to an entry from 1 particular band of a multiband dataset.
We expect the user to provide the input to the routine in vector format. A single band image is treated as a vector image with a single element for every vector.
Data structure for a region: A region is defined as a closed area in the image that is surrounded by a list of borders objects (see itkKLMSegmentationBorder class).
Shown below is an initial two-dimensional 8x9 image with a 4x3 grid size partition. The initial region blocks are labelled in hexadecimal. Below the grid partition, the borders are shown as E, where C is an image pixel from the initial image. Note that each border is placed in between two regions. Each two-dimensional region is surrounded by four borders.
Initial regions of a 8 by 9 image with a 4 by 3 grid partition.
Region borders are shown as ``E''.
Definition at line 89 of file itkKLMSegmentationRegion.h.
typedef SmartPointer<const Self> itk::KLMSegmentationRegion::ConstPointer |
Reimplemented from itk::SegmentationRegion.
Definition at line 100 of file itkKLMSegmentationRegion.h.
Reimplemented from itk::SegmentationRegion.
Definition at line 99 of file itkKLMSegmentationRegion.h.
typedef RegionBorderVectorType::const_iterator itk::KLMSegmentationRegion::RegionBorderVectorConstIterator |
Type definition for the const region border vector iterators to be used.
Definition at line 116 of file itkKLMSegmentationRegion.h.
typedef RegionBorderVectorType::iterator itk::KLMSegmentationRegion::RegionBorderVectorIterator |
Type definition for the region border vector iterators to be used.
Definition at line 113 of file itkKLMSegmentationRegion.h.
typedef std::vector< KLMSegmentationBorder * > itk::KLMSegmentationRegion::RegionBorderVectorType |
Type definition for vector container that stores the borders associated with a current region.
Definition at line 106 of file itkKLMSegmentationRegion.h.
type definition for the region label type.
Reimplemented from itk::SegmentationRegion.
Definition at line 119 of file itkKLMSegmentationRegion.h.
Standard class typedefs.
Reimplemented from itk::SegmentationRegion.
Definition at line 97 of file itkKLMSegmentationRegion.h.
Reimplemented from itk::SegmentationRegion.
Definition at line 98 of file itkKLMSegmentationRegion.h.
itk::KLMSegmentationRegion::KLMSegmentationRegion | ( | ) | [protected] |
itk::KLMSegmentationRegion::~KLMSegmentationRegion | ( | ) | [protected] |
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
virtual void itk::SegmentationRegion::ApplySegmentationRegion | ( | ) | [inline, virtual, inherited] |
Define a virtual SegmentationRegion function that is meant to be used in derived classes if some operation needs to be performed on a region object.
Definition at line 66 of file itkSegmentationRegion.h.
static void itk::LightObject::BreakOnError | ( | ) | [static, inherited] |
This method is called when itkExceptionMacro executes. It allows the debugger to break on error.
void itk::KLMSegmentationRegion::CombineRegionParameters | ( | const Self * | region | ) |
Set the region with parameter values (mean and area) defining the region when merged with the new region.
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::KLMSegmentationRegion::DeleteAllRegionBorders | ( | ) |
Delete all region borders in the border list.
void itk::KLMSegmentationRegion::DeleteRegionBorder | ( | KLMSegmentationBorder * | pBorderCandidate | ) |
Delete a region border from the border list.
double itk::KLMSegmentationRegion::EnergyFunctional | ( | const Self * | region | ) |
Compute the energy cost (mean squared difference scaled by area) that would result if this region is merged with another region.
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] |
virtual const MeanRegionIntensityType& itk::KLMSegmentationRegion::GetMeanRegionIntensity | ( | ) | [virtual] |
const MetaDataDictionary& itk::Object::GetMetaDataDictionary | ( | void | ) | const [inherited] |
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::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::KLMSegmentationRegion::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods).
Reimplemented from itk::SegmentationRegion.
virtual int itk::LightObject::GetReferenceCount | ( | ) | const [inline, virtual, inherited] |
Gets the reference count on this object.
Definition at line 98 of file itkLightObject.h.
virtual const double& itk::SegmentationRegion::GetRegionArea | ( | ) | [virtual, inherited] |
RegionBorderVectorConstIterator itk::KLMSegmentationRegion::GetRegionBorderConstItBegin | ( | ) |
RegionBorderVectorConstIterator itk::KLMSegmentationRegion::GetRegionBorderConstItEnd | ( | ) |
RegionBorderVectorIterator itk::KLMSegmentationRegion::GetRegionBorderItBegin | ( | ) |
Get a head pointer to the vector container storing the borders associated with a region.
RegionBorderVectorIterator itk::KLMSegmentationRegion::GetRegionBorderItEnd | ( | ) |
Get a tail pointer to the vector container storing the borders associated with a region.
int itk::KLMSegmentationRegion::GetRegionBorderSize | ( | ) | const |
Get the number of borders in the vector container storing the borders associated with a region.
virtual const RegionLabelType& itk::SegmentationRegion::GetRegionLabel | ( | ) | [virtual, inherited] |
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::KLMSegmentationRegion::InsertRegionBorder | ( | RegionBorderVectorIterator | it, | |
KLMSegmentationBorder * | pBorderCandidate | |||
) |
Insert a region border into the border list at a given location.
void itk::KLMSegmentationRegion::InsertRegionBorder | ( | KLMSegmentationBorder * | pBorderCandidate | ) |
Insert a region border to the list, where position is unknown (sorting based on region labels is done to maintain consistency).
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::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 > >, and itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >.
Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), 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::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().
static Pointer itk::KLMSegmentationRegion::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::SegmentationRegion.
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().
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::KLMSegmentationRegion::PrintRegionInfo | ( | ) |
Function to print the region parameters using std::cout.
void itk::KLMSegmentationRegion::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::SegmentationRegion.
virtual void itk::LightObject::PrintTrailer | ( | std::ostream & | os, | |
Indent | indent | |||
) | const [protected, virtual, inherited] |
void itk::KLMSegmentationRegion::PushBackRegionBorder | ( | KLMSegmentationBorder * | pBorderCandidate | ) |
Insert a region border to the back of the list.
void itk::KLMSegmentationRegion::PushFrontRegionBorder | ( | KLMSegmentationBorder * | pBorderCandidate | ) |
Insert a region border to the front of the list.
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::KLMSegmentationRegion::ResetRegionLabelAndUpdateBorders | ( | Self * | region | ) |
Reset a region's label to that of the supplied region and update the regions borders to that of the supplied region.
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().
virtual void itk::KLMSegmentationRegion::SetMeanRegionIntensity | ( | MeanRegionIntensityType | _arg | ) | [virtual] |
Set/Get the mean pixel intensity in the region.
void itk::Object::SetMetaDataDictionary | ( | const MetaDataDictionary & | rhs | ) | [inherited] |
virtual void itk::Object::SetReferenceCount | ( | int | ) | [virtual, inherited] |
Sets the reference count (use with care)
Reimplemented from itk::LightObject.
virtual void itk::SegmentationRegion::SetRegionArea | ( | double | _arg | ) | [virtual, inherited] |
Set/Get the area of the region.
virtual void itk::SegmentationRegion::SetRegionLabel | ( | RegionLabelType | _arg | ) | [virtual, inherited] |
Set/Get the region with parameter values defining the region.
void itk::KLMSegmentationRegion::SetRegionParameters | ( | MeanRegionIntensityType | meanRegionIntensity, | |
double | regionArea, | |||
RegionLabelType | label | |||
) |
Set the region with parameter values defining the region.
void itk::KLMSegmentationRegion::SpliceRegionBorders | ( | Self * | region | ) |
Splice the regions borders from the new region into the current region. If duplicate borders are found, the duplicate border region is not inserted into the new region borders list, rather, it has its pointers to region1 and region2 set to NULL and Lambda set to -1.0.
For example, take an image with 3 regions A, B, C
where region A has region borders A-B and A-C; region B has region borders A-B and B-C; and region C has region borders A-C and B-C.
Suppose region border A-B has been removed, so that region B can be merged into region A. When splicing the region borders from A and B into the new region A, duplicate region borders A-C and A-C (one of which was formerly B-C) will be present. In this case, one of the region borders A-C is given the combined length of the two former borders and is put into the region borders list. The other is nullified by having its pointers to region1 and region2 set to NULL and its Lambda value set to -1.0.
virtual void itk::Object::UnRegister | ( | ) | const [virtual, inherited] |
Decrease the reference count (release by another object).
Reimplemented from itk::LightObject.
void itk::KLMSegmentationRegion::UpdateRegionBorderLambda | ( | ) |
Recalculate the Lambda values using EvaluateLambda() for all the borders defining the region.
int itk::LightObject::m_ReferenceCount [mutable, protected, inherited] |
Number of uses of this object by other objects.
Definition at line 119 of file itkLightObject.h.
SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited] |
Mutex lock to protect modification to the reference count
Definition at line 122 of file itkLightObject.h.