#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.
![\[\begin{tabular}{|c|c|c|c|c|c|c|c|c|} \hline 1 & 1 & 1 & 2 & 2 & 2 & 3 & 3 & 3 \\ \hline 1 & 1 & 1 & 2 & 2 & 2 & 3 & 3 & 3 \\ \hline 4 & 4 & 4 & 5 & 5 & 5 & 6 & 6 & 6 \\ \hline 4 & 4 & 4 & 5 & 5 & 5 & 6 & 6 & 6 \\ \hline 7 & 7 & 7 & 8 & 8 & 8 & 9 & 9 & 9 \\ \hline 7 & 7 & 7 & 8 & 8 & 8 & 9 & 9 & 9 \\ \hline a & a & a & b & b & b & c & c & c \\ \hline a & a & a & b & b & b & c & c & c \\ \hline \end{tabular}\]](form_153.png)
Region borders are shown as ``E''.
![\[\begin{tabular}{|c|c|c|c|c|c|c|c|c|c|} \hline C & C & C & & C & C & C & & C & C & C \\ \hline C & C & C & E & C & C & C & E & C & C & C \\ \hline & E & & & & E & & & & E & \\ \hline C & C & C & & C & C & C & & C & C & C \\ \hline C & C & C & E & C & C & C & E & C & C & C \\ \hline & E & & & & E & & & & E & \\ \hline C & C & C & & C & C & C & & C & C & C \\ \hline C & C & C & E & C & C & C & E & C & C & C \\ \hline & E & & & & E & & & & E & \\ \hline C & C & C & & C & C & C & & C & C & C \\ \hline C & C & C & E & C & C & C & E & C & C & C \\ \hline \end{tabular}\]](form_154.png)
Definition at line 89 of file itkKLMSegmentationRegion.h.
Public Types | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef SmartPointer< Self > | Pointer |
| typedef RegionBorderVectorType::const_iterator | RegionBorderVectorConstIterator |
| typedef RegionBorderVectorType::iterator | RegionBorderVectorIterator |
| typedef std::vector< KLMSegmentationBorder * > | RegionBorderVectorType |
| typedef Superclass::RegionLabelType | RegionLabelType |
| typedef KLMSegmentationRegion | Self |
| typedef SegmentationRegion | Superclass |
Public Member Functions | |
| virtual void | ApplySegmentationRegion () |
| and *region C has region borders A C and B C **Suppose region border A B has been so that region B *can be merged into region A When splicing the region *borders from A and B into the new region duplicate *region borders A C and A | C (one of which was formerly B-C)*will be present.In this case |
| void | CombineRegionParameters (const Self *region) |
| virtual LightObject::Pointer | CreateAnother () const |
| virtual void | DebugOff () const |
| virtual void | DebugOn () const |
| virtual void | Delete () |
| void | DeleteAllRegionBorders () |
| void | DeleteRegionBorder (KLMSegmentationBorder *pBorderCandidate) |
| double | EnergyFunctional (const Self *region) |
| Command * | GetCommand (unsigned long tag) |
| bool | GetDebug () const |
| virtual const MeanRegionIntensityType & | GetMeanRegionIntensity () |
| const MetaDataDictionary & | GetMetaDataDictionary (void) const |
| MetaDataDictionary & | GetMetaDataDictionary (void) |
| virtual unsigned long | GetMTime () const |
| virtual const char * | GetNameOfClass () const |
| virtual int | GetReferenceCount () const |
| virtual const double & | GetRegionArea () |
| RegionBorderVectorConstIterator | GetRegionBorderConstItBegin () |
| RegionBorderVectorConstIterator | GetRegionBorderConstItEnd () |
| Get a head pointer to the vector container storing the borders *associated with a region *RegionBorderVectorIterator | GetRegionBorderItBegin () |
| Get a tail pointer to the vector container storing the borders *associated with a region *RegionBorderVectorIterator | GetRegionBorderItEnd () |
| int | GetRegionBorderSize () const |
| virtual const RegionLabelType & | GetRegionLabel () |
| bool | HasObserver (const EventObject &event) const |
| void | InsertRegionBorder (RegionBorderVectorIterator it, KLMSegmentationBorder *pBorderCandidate) |
| void | InsertRegionBorder (KLMSegmentationBorder *pBorderCandidate) |
| void | InvokeEvent (const EventObject &) const |
| void | InvokeEvent (const EventObject &) |
| virtual void | Modified () const |
| void | Print (std::ostream &os, Indent indent=0) const |
| void | PrintRegionInfo () |
| void | PushBackRegionBorder (KLMSegmentationBorder *pBorderCandidate) |
| void | PushFrontRegionBorder (KLMSegmentationBorder *pBorderCandidate) |
| virtual void | Register () const |
| void | RemoveAllObservers () |
| void | RemoveObserver (unsigned long tag) |
| void | ResetRegionLabelAndUpdateBorders (Self *region) |
| void | SetDebug (bool debugFlag) const |
| virtual void | SetMeanRegionIntensity (MeanRegionIntensityType _arg) |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| virtual void | SetReferenceCount (int) |
| Set Get the area of the region *virtual void | SetRegionArea (double _arg) |
| Set Get the region with parameter values *defining the region *virtual void | SetRegionLabel (RegionLabelType _arg) |
| void | SetRegionParameters (MeanRegionIntensityType meanRegionIntensity, double regionArea, RegionLabelType label) |
| and *region C has region borders A C and B C **Suppose region border A B has been so that region B *can be merged into region A When splicing the region *borders from A and B into the new region duplicate *region borders A C and A 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 *void | SpliceRegionBorders (Self *region) |
| virtual void | UnRegister () const |
| void | UpdateRegionBorderLambda () |
Static Public Member Functions | |
| static void | BreakOnError () |
| static bool | GetGlobalWarningDisplay () |
| static void | GlobalWarningDisplayOff () |
| static void | GlobalWarningDisplayOn () |
| static Pointer | New () |
| This is a global flag that controls whether any warning *or error messages are displayed *static void | SetGlobalWarningDisplay (bool flag) |
Public Attributes | |
| and *region C has region borders A C and B C **Suppose region border A B has been so that region B *can be merged into region A When splicing the region *borders from A and B into the new region | A |
| Splice the regions borders from the new region into the current *region If duplicate borders are the duplicate border *region is not inserted into the new region borders *it has its pointers to region1 and region2 set to NULL and *Lambda set to **For take an image with regions | A |
| 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 unsigned lon | AddObserver )(const EventObject &event, Command *) const |
| Splice the regions borders from the new region into the current *region If duplicate borders are the duplicate border *region is not inserted into the new region borders *it has its pointers to region1 and region2 set to NULL and *Lambda set to **For take an image with regions | B |
| *region B has region borders A B and B | C |
| Splice the regions borders from the new region into the current *region If duplicate borders are the duplicate border *region is not inserted into the new region borders *it has its pointers to region1 and region2 set to NULL and *Lambda set to **For take an image with regions C *f *[\begin{tabular}{|c|c|}*\hline *A &A\\\hline *B &C\\\hline *\end{tabular}\f] where region A has region borders A B and A | C |
| This is a global flag that controls whether any | debug |
| Splice the regions borders from the new region into the current *region If duplicate borders are the duplicate border *region is not inserted into the new region borders *it has its pointers to region1 and region2 set to NULL and *Lambda set to **For | example |
| Splice the regions borders from the new region into the current *region If duplicate borders are | found |
| Splice the regions borders from the new region into the current *region If duplicate borders are the duplicate border *region is not inserted into the new region borders | list |
| Splice the regions borders from the new region into the current *region If duplicate borders are the duplicate border *region is not inserted into the new region borders | rather |
| and *region C has region borders A C and B C **Suppose region border A B has been | removed |
Protected Member Functions | |
| KLMSegmentationRegion () | |
| 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 |
| ~KLMSegmentationRegion () | |
Protected Attributes | |
| int | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
| Methods invoked by virtual 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.*/virtual void PrintSelf(std voi | PrintHeader )(std::ostream &os, Indent indent) const |
|
|
Reimplemented from itk::SegmentationRegion. Definition at line 100 of file itkKLMSegmentationRegion.h. |
|
|
Reimplemented from itk::SegmentationRegion. Definition at line 99 of file itkKLMSegmentationRegion.h. |
|
|
Type definition for the const region border vector iterators to be used. Definition at line 116 of file itkKLMSegmentationRegion.h. |
|
|
Type definition for the region border vector iterators to be used. Definition at line 113 of file itkKLMSegmentationRegion.h. |
|
|
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. |
|
|
|
|
|
|
|
|
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. |
|
|
This method is called when itkExceptionMacro executes. It allows the debugger to break on error. |
|
|
|
|
|
Set the region with parameter values (mean and area) defining the region when merged with the new region. |
|
|
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. |
|
|
Turn debugging output off. |
|
|
Turn debugging output on. |
|
|
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 all region borders in the border list. |
|
|
Delete a region border from the border list. |
|
|
Compute the energy cost (mean squared difference scaled by area) that would result if this region is merged with another region. |
|
|
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. |
|
|
Get the value of the debug flag. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Run-time type information (and related methods). Reimplemented from itk::SegmentationRegion. |
|
|
Gets the reference count on this object. Definition at line 98 of file itkLightObject.h. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Get the number of borders in the vector container storing the borders associated with a region. |
|
|
|
|
|
Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Return true if an observer is registered for this event. |
|
||||||||||||
|
Insert a region border into the border list at a given location. |
|
|
Insert a region border to the list, where position is unknown (sorting based on region labels is done to maintain consistency). |
|
|
Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object. |
|
|
Call Execute on all the Commands observing this event id. |
|
|
|
Method for creation through the object factory. Reimplemented from itk::SegmentationRegion. |
|
||||||||||||
|
Cause the object to print itself out. |
|
||||||||||||
|
|
|
|
Function to print the region parameters using std::cout. |
|
||||||||||||
|
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. |
|
||||||||||||
|
|
|
|
Insert a region border to the back of the list. |
|
|
Insert a region border to the front of the list. |
|
|
Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject. |
|
|
Remove all observers . |
|
|
Remove the observer with this tag value. |
|
|
Reset a region's label to that of the supplied region and update the regions borders to that of the supplied region. |
|
|
Set the value of the debug flag. A non-zero value turns debugging on. |
|
|
Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn(). |
|
|
Set/Get the mean pixel intensity in the region. |
|
|
|
|
|
Sets the reference count (use with care) Reimplemented from itk::LightObject. |
|
|
|
|
|
|
|
||||||||||||||||
|
Set the region with parameter values defining the region. |
|
|
|
|
|
Decrease the reference count (release by another object). Reimplemented from itk::LightObject. |
|
|
Recalculate the Lambda values using EvaluateLambda() for all the borders defining the region. |
|
|
Definition at line 198 of file itkKLMSegmentationRegion.h. |
|
|
Definition at line 183 of file itkKLMSegmentationRegion.h. |
|
|
|
|
|
Definition at line 183 of file itkKLMSegmentationRegion.h. |
|
|
Definition at line 195 of file itkKLMSegmentationRegion.h. |
|
|
Definition at line 183 of file itkKLMSegmentationRegion.h. |
|
|
Definition at line 94 of file itkObject.h. |
|
|
Definition at line 183 of file itkKLMSegmentationRegion.h. |
|
|
Definition at line 183 of file itkKLMSegmentationRegion.h. |
|
|
Definition at line 183 of file itkKLMSegmentationRegion.h. |
|
|
Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h. |
|
|
Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h. |
|
|
|
|
|
Definition at line 183 of file itkKLMSegmentationRegion.h. |
|
|
Definition at line 198 of file itkKLMSegmentationRegion.h. |
1.4.2 written by Dimitri van Heesch,
© 1997-2000