Medical Imaging Interaction Toolkit  2018.4.99-bd7b41ba
Medical Imaging Interaction Toolkit
mitk::UndirectedGraph< TVertex, TEdge > Class Template Reference

Template class for undirected graphs.Paramters should be the vertex and edge classes, which contains the information. More...

#include <mitkUndirectedGraph.h>

Inheritance diagram for mitk::UndirectedGraph< TVertex, TEdge >:
Collaboration diagram for mitk::UndirectedGraph< TVertex, TEdge >:

Public Types

typedef TVertex VertexType
 
typedef TEdge EdgeType
 
typedef boost::adjacency_list< boost::listS, boost::vecS, boost::undirectedS, boost::property< vertex_properties_t, VertexType >, boost::property< edge_properties_t, EdgeType > > GraphType
 
typedef boost::graph_traits< GraphType >::vertex_descriptor VertexDescriptorType
 
typedef boost::graph_traits< GraphType >::edge_descriptor EdgeDescriptorType
 
typedef boost::graph_traits< GraphType >::vertex_iterator VertexIteratorType
 
typedef boost::graph_traits< GraphType >::edge_iterator EdgeIteratorType
 
typedef boost::graph_traits< GraphType >::adjacency_iterator AdjacenyIteratorType
 
typedef boost::graph_traits< GraphType >::out_edge_iterator OutEdgeIteratorType
 
typedef boost::graph_traits< GraphType >::in_edge_iterator InEdgeIteratorType
 
- Public Types inherited from mitk::BaseData
typedef BaseData Self
 
typedef itk::DataObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::Identifiable
using UIDType = std::string
 

Public Member Functions

 mitkClassMacro (UndirectedGraph, BaseData)
 
void UpdateOutputInformation () override
 
void SetRequestedRegionToLargestPossibleRegion () override
 Set the RequestedRegion to the LargestPossibleRegion. More...
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 Determine whether the RequestedRegion is outside of the BufferedRegion. More...
 
bool VerifyRequestedRegion () override
 Verify that the RequestedRegion is within the LargestPossibleRegion. More...
 
void SetRequestedRegion (const itk::DataObject *) override
 Set the requested region from this data object to match the requested region of the data object passed in as a parameter. More...
 
VertexDescriptorType AddVertex (const VertexType &vertexData)
 
void RemoveVertex (const VertexDescriptorType &vertex)
 
VertexType GetVertex (const VertexDescriptorType &vertex)
 
void SetVertex (const VertexDescriptorType &vertex, const VertexType &vertexData)
 
VertexDescriptorType GetVertexDescriptor (const VertexType &vertexData) const
 
EdgeDescriptorType AddEdge (const VertexDescriptorType &vertexA, const VertexDescriptorType &vertexB, const EdgeType &edgeData)
 
void RemoveEdge (const EdgeDescriptorType &edge)
 
EdgeType GetEdge (const EdgeDescriptorType &edge)
 
void SetEdge (const EdgeDescriptorType &edge, const EdgeType &edgeData)
 
EdgeDescriptorType GetEdgeDescriptor (const EdgeType &edgeData) const
 
std::pair< VertexType, VertexTypeGetVerticesOfAnEdge (const EdgeDescriptorType &edge) const
 
EdgeDescriptorType GetEdgeDescriptorByVerices (const VertexDescriptorType &vertexA, const VertexDescriptorType &vertexB) const
 
std::vector< EdgeTypeGetAllEdgesOfAVertex (const VertexDescriptorType &vertex) const
 
int GetNumberOfVertices () const
 
int GetNumberOfEdges () const
 
std::vector< VertexTypeGetVectorOfAllVertices () const
 
std::vector< EdgeTypeGetVectorOfAllEdges () const
 
void Clear () override
 
const GraphTypeGetGraph () const
 
UndirectedGraph< VertexType, EdgeType > & operator= (const UndirectedGraph< VertexType, EdgeType > &rhs)
 
- Public Member Functions inherited from mitk::BaseData
virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
BaseProperty::ConstPointer GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
 Get property by its key. More...
 
std::vector< std::string > GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
 Query keys of existing properties. More...
 
std::vector< std::string > GetPropertyContextNames () const override
 Query names of existing contexts. More...
 
BasePropertyGetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
 Get property by its key. More...
 
void SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Add new or change existent property. More...
 
void RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Removes a property. If the property does not exist, nothing will be done. More...
 
const mitk::TimeGeometryGetTimeGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
const mitk::TimeGeometryGetTimeSlicedGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
mitk::TimeGeometryGetTimeGeometry ()
 Return the TimeGeometry of the data as pointer. More...
 
const mitk::TimeGeometryGetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::TimeGeometryGetUpdatedTimeSliceGeometry ()
 Return the TimeGeometry of the data. More...
 
virtual void Expand (unsigned int timeSteps)
 Expands the TimeGeometry to a number of TimeSteps. More...
 
const mitk::BaseGeometryGetUpdatedGeometry (int t=0)
 Return the BaseGeometry of the data at time t. More...
 
mitk::BaseGeometryGetGeometry (int t=0) const
 Return the geometry, which is a TimeGeometry, of the data as non-const pointer. More...
 
void UpdateOutputInformation () override
 Update the information for this BaseData (the geometry in particular) so that it can be used as an output of a BaseProcess. More...
 
void CopyInformation (const itk::DataObject *data) override
 Copy information from the specified data set. More...
 
virtual bool IsInitialized () const
 Check whether the data has been initialized, i.e., at least the Geometry and other header data has been set. More...
 
virtual bool IsEmptyTimeStep (unsigned int t) const
 Check whether object contains data (at a specified time), e.g., a set of points may be empty. More...
 
virtual bool IsEmpty () const
 Check whether object contains data (at least at one point in time), e.g., a set of points may be empty. More...
 
void ExecuteOperation (Operation *operation) override
 overwrite if the Data can be called by an Interactor (StateMachine). More...
 
virtual void SetGeometry (BaseGeometry *aGeometry3D)
 Set the BaseGeometry of the data, which will be referenced (not copied!). Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry which saves the given BaseGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetTimeGeometry (TimeGeometry *geometry)
 Set the TimeGeometry of the data, which will be referenced (not copied!). More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D)
 Set a clone of the provided Geometry as Geometry of the data. Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetClonedTimeGeometry (const TimeGeometry *geometry)
 Set a clone of the provided TimeGeometry as TimeGeometry of the data. More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
 Set a clone of the provided geometry as BaseGeometry of a given time step. More...
 
mitk::PropertyList::Pointer GetPropertyList () const
 Get the data's property list. More...
 
void SetPropertyList (PropertyList *propertyList)
 Set the data's property list. More...
 
mitk::BaseProperty::Pointer GetProperty (const char *propertyKey) const
 Get the property (instance of BaseProperty) with key propertyKey from the PropertyList, and set it to this, respectively;. More...
 
void SetProperty (const char *propertyKey, BaseProperty *property)
 
virtual void SetOrigin (const Point3D &origin)
 Convenience method for setting the origin of the BaseGeometry instances of all time steps. More...
 
itk::SmartPointer< mitk::BaseDataSourceGetSource () const
 Get the process object that generated this data object. More...
 
unsigned int GetTimeSteps () const
 Get the number of time steps from the TimeGeometry As the base data has not a data vector given by itself, the number of time steps is defined over the time sliced geometry. In sub classes, a better implementation could be over the length of the data vector. More...
 
unsigned long GetMTime () const override
 Get the modified time of the last change of the contents this data object or its geometry. More...
 
void Graft (const DataObject *) override
 
- Public Member Functions inherited from mitk::OperationActor
 itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()
 
- Public Member Functions inherited from mitk::Identifiable
 Identifiable ()
 
 Identifiable (const UIDType &uid)
 
 Identifiable (const Identifiable &)=delete
 
 Identifiable (Identifiable &&) noexcept
 
virtual ~Identifiable ()
 
Identifiableoperator= (const Identifiable &)=delete
 
Identifiableoperator= (Identifiable &&other) noexcept
 
virtual UIDType GetUID () const
 Get unique ID of an object. More...
 
- Public Member Functions inherited from mitk::IPropertyOwner
 ~IPropertyOwner () override
 
- Public Member Functions inherited from mitk::IPropertyProvider
virtual ~IPropertyProvider ()
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseData
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 UndirectedGraph ()
 
 ~UndirectedGraph () override
 
- Protected Member Functions inherited from mitk::BaseData
 BaseData ()
 
 BaseData (const BaseData &other)
 
 ~BaseData () override
 
virtual void InitializeTimeGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void InitializeTimeSlicedGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void ClearData ()
 reset to non-initialized state, release memory More...
 
virtual void InitializeEmpty ()
 Pure virtual; Must be used in subclasses to get a data object to a valid state. Should at least create one empty object and call Superclass::InitializeTimeGeometry() to ensure an existing valid geometry. More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::Identifiable
virtual void SetUID (const UIDType &uid)
 

Protected Attributes

GraphType m_Graph
 
- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Detailed Description

template<class TVertex, class TEdge>
class mitk::UndirectedGraph< TVertex, TEdge >

Template class for undirected graphs.Paramters should be the vertex and edge classes, which contains the information.

Definition at line 45 of file mitkUndirectedGraph.h.

Member Typedef Documentation

◆ AdjacenyIteratorType

template<class TVertex, class TEdge>
typedef boost::graph_traits<GraphType>::adjacency_iterator mitk::UndirectedGraph< TVertex, TEdge >::AdjacenyIteratorType

Definition at line 73 of file mitkUndirectedGraph.h.

◆ EdgeDescriptorType

template<class TVertex, class TEdge>
typedef boost::graph_traits<GraphType>::edge_descriptor mitk::UndirectedGraph< TVertex, TEdge >::EdgeDescriptorType

Definition at line 69 of file mitkUndirectedGraph.h.

◆ EdgeIteratorType

template<class TVertex, class TEdge>
typedef boost::graph_traits<GraphType>::edge_iterator mitk::UndirectedGraph< TVertex, TEdge >::EdgeIteratorType

Definition at line 72 of file mitkUndirectedGraph.h.

◆ EdgeType

template<class TVertex, class TEdge>
typedef TEdge mitk::UndirectedGraph< TVertex, TEdge >::EdgeType

Definition at line 51 of file mitkUndirectedGraph.h.

◆ GraphType

template<class TVertex, class TEdge>
typedef boost::adjacency_list<boost::listS, boost::vecS, boost::undirectedS, boost::property<vertex_properties_t, VertexType>, boost::property<edge_properties_t, EdgeType> > mitk::UndirectedGraph< TVertex, TEdge >::GraphType

Creating the graph type listS: Represents the OutEdgeList as a std::list vecS: Represents the VertexList as a std::vector undirectedS: Representation for an undirected graph VertexProperty: Defines that all vertex are represented by VertexType EdgeProperty: Defines that all edges are represented by EdgeType

Definition at line 65 of file mitkUndirectedGraph.h.

◆ InEdgeIteratorType

template<class TVertex, class TEdge>
typedef boost::graph_traits<GraphType>::in_edge_iterator mitk::UndirectedGraph< TVertex, TEdge >::InEdgeIteratorType

Definition at line 75 of file mitkUndirectedGraph.h.

◆ OutEdgeIteratorType

template<class TVertex, class TEdge>
typedef boost::graph_traits<GraphType>::out_edge_iterator mitk::UndirectedGraph< TVertex, TEdge >::OutEdgeIteratorType

Definition at line 74 of file mitkUndirectedGraph.h.

◆ VertexDescriptorType

template<class TVertex, class TEdge>
typedef boost::graph_traits<GraphType>::vertex_descriptor mitk::UndirectedGraph< TVertex, TEdge >::VertexDescriptorType

Definition at line 68 of file mitkUndirectedGraph.h.

◆ VertexIteratorType

template<class TVertex, class TEdge>
typedef boost::graph_traits<GraphType>::vertex_iterator mitk::UndirectedGraph< TVertex, TEdge >::VertexIteratorType

Definition at line 71 of file mitkUndirectedGraph.h.

◆ VertexType

template<class TVertex, class TEdge>
typedef TVertex mitk::UndirectedGraph< TVertex, TEdge >::VertexType

Definition at line 50 of file mitkUndirectedGraph.h.

Constructor & Destructor Documentation

◆ UndirectedGraph()

template<class TVertex, class TEdge>
mitk::UndirectedGraph< TVertex, TEdge >::UndirectedGraph ( )
protected

◆ ~UndirectedGraph()

template<class TVertex, class TEdge>
mitk::UndirectedGraph< TVertex, TEdge >::~UndirectedGraph ( )
overrideprotected

Member Function Documentation

◆ AddEdge()

template<class TVertex, class TEdge>
EdgeDescriptorType mitk::UndirectedGraph< TVertex, TEdge >::AddEdge ( const VertexDescriptorType vertexA,
const VertexDescriptorType vertexB,
const EdgeType edgeData 
)

Add a new edge between the given vertices to the graph

◆ AddVertex()

template<class TVertex, class TEdge>
VertexDescriptorType mitk::UndirectedGraph< TVertex, TEdge >::AddVertex ( const VertexType vertexData)

Add a new vertex to the graph

◆ Clear()

template<class TVertex, class TEdge>
void mitk::UndirectedGraph< TVertex, TEdge >::Clear ( )
overridevirtual

clear the graph

Reimplemented from mitk::BaseData.

◆ GetAllEdgesOfAVertex()

template<class TVertex, class TEdge>
std::vector<EdgeType> mitk::UndirectedGraph< TVertex, TEdge >::GetAllEdgesOfAVertex ( const VertexDescriptorType vertex) const

Get all edges of the given vertex

◆ GetEdge()

template<class TVertex, class TEdge>
EdgeType mitk::UndirectedGraph< TVertex, TEdge >::GetEdge ( const EdgeDescriptorType edge)

Get the edge data of the given edge descriptor

◆ GetEdgeDescriptor()

template<class TVertex, class TEdge>
EdgeDescriptorType mitk::UndirectedGraph< TVertex, TEdge >::GetEdgeDescriptor ( const EdgeType edgeData) const

Returns the descriptor if the edge exist in the graph, otherwise undefined

◆ GetEdgeDescriptorByVerices()

template<class TVertex, class TEdge>
EdgeDescriptorType mitk::UndirectedGraph< TVertex, TEdge >::GetEdgeDescriptorByVerices ( const VertexDescriptorType vertexA,
const VertexDescriptorType vertexB 
) const

Returns the edge descriptor from the edge which has the given vertices as source and target

◆ GetGraph()

template<class TVertex, class TEdge>
const GraphType& mitk::UndirectedGraph< TVertex, TEdge >::GetGraph ( ) const

get the graph

◆ GetNumberOfEdges()

template<class TVertex, class TEdge>
int mitk::UndirectedGraph< TVertex, TEdge >::GetNumberOfEdges ( ) const

get overall number of edges in the graph

◆ GetNumberOfVertices()

template<class TVertex, class TEdge>
int mitk::UndirectedGraph< TVertex, TEdge >::GetNumberOfVertices ( ) const

Get overall number of vertices in the graph

◆ GetVectorOfAllEdges()

template<class TVertex, class TEdge>
std::vector<EdgeType> mitk::UndirectedGraph< TVertex, TEdge >::GetVectorOfAllEdges ( ) const

get vector containing all the edges of the network

◆ GetVectorOfAllVertices()

template<class TVertex, class TEdge>
std::vector<VertexType> mitk::UndirectedGraph< TVertex, TEdge >::GetVectorOfAllVertices ( ) const

get vector containing all the vertices of the graph

◆ GetVertex()

template<class TVertex, class TEdge>
VertexType mitk::UndirectedGraph< TVertex, TEdge >::GetVertex ( const VertexDescriptorType vertex)

Get the vertex data of the given vertex descriptor

◆ GetVertexDescriptor()

template<class TVertex, class TEdge>
VertexDescriptorType mitk::UndirectedGraph< TVertex, TEdge >::GetVertexDescriptor ( const VertexType vertexData) const

Returns the descriptor if the vertex exist in the graph, otherwise undefined

◆ GetVerticesOfAnEdge()

template<class TVertex, class TEdge>
std::pair<VertexType, VertexType> mitk::UndirectedGraph< TVertex, TEdge >::GetVerticesOfAnEdge ( const EdgeDescriptorType edge) const

Get parent and target vertex of the given edge

◆ mitkClassMacro()

template<class TVertex, class TEdge>
mitk::UndirectedGraph< TVertex, TEdge >::mitkClassMacro ( UndirectedGraph< TVertex, TEdge >  ,
BaseData   
)

◆ New()

template<class TVertex, class TEdge>
static Pointer mitk::UndirectedGraph< TVertex, TEdge >::New ( )
static

◆ operator=()

template<class TVertex, class TEdge>
UndirectedGraph<VertexType, EdgeType>& mitk::UndirectedGraph< TVertex, TEdge >::operator= ( const UndirectedGraph< VertexType, EdgeType > &  rhs)

◆ RemoveEdge()

template<class TVertex, class TEdge>
void mitk::UndirectedGraph< TVertex, TEdge >::RemoveEdge ( const EdgeDescriptorType edge)

Remove the edge from the graph

◆ RemoveVertex()

template<class TVertex, class TEdge>
void mitk::UndirectedGraph< TVertex, TEdge >::RemoveVertex ( const VertexDescriptorType vertex)

Remove the vertex from the graph

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

template<class TVertex, class TEdge>
bool mitk::UndirectedGraph< TVertex, TEdge >::RequestedRegionIsOutsideOfTheBufferedRegion ( )
inlineoverridevirtual

Determine whether the RequestedRegion is outside of the BufferedRegion.

This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Implements mitk::BaseData.

Definition at line 88 of file mitkUndirectedGraph.h.

◆ SetEdge()

template<class TVertex, class TEdge>
void mitk::UndirectedGraph< TVertex, TEdge >::SetEdge ( const EdgeDescriptorType edge,
const EdgeType edgeData 
)

Set the edge data of the given edge descriptor

◆ SetRequestedRegion()

template<class TVertex, class TEdge>
void mitk::UndirectedGraph< TVertex, TEdge >::SetRequestedRegion ( const itk::DataObject *  data)
inlineoverridevirtual

Set the requested region from this data object to match the requested region of the data object passed in as a parameter.

This method is implemented in the concrete subclasses of BaseData.

Implements mitk::BaseData.

Definition at line 90 of file mitkUndirectedGraph.h.

◆ SetRequestedRegionToLargestPossibleRegion()

template<class TVertex, class TEdge>
void mitk::UndirectedGraph< TVertex, TEdge >::SetRequestedRegionToLargestPossibleRegion ( )
inlineoverridevirtual

Set the RequestedRegion to the LargestPossibleRegion.

This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Implements mitk::BaseData.

Definition at line 87 of file mitkUndirectedGraph.h.

◆ SetVertex()

template<class TVertex, class TEdge>
void mitk::UndirectedGraph< TVertex, TEdge >::SetVertex ( const VertexDescriptorType vertex,
const VertexType vertexData 
)

Set the vertex data of the given vertex descriptor

◆ UpdateOutputInformation()

template<class TVertex, class TEdge>
void mitk::UndirectedGraph< TVertex, TEdge >::UpdateOutputInformation ( )
inlineoverride

Definition at line 82 of file mitkUndirectedGraph.h.

◆ VerifyRequestedRegion()

template<class TVertex, class TEdge>
bool mitk::UndirectedGraph< TVertex, TEdge >::VerifyRequestedRegion ( )
inlineoverridevirtual

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion.

Implements mitk::BaseData.

Definition at line 89 of file mitkUndirectedGraph.h.

Member Data Documentation

◆ m_Graph

template<class TVertex, class TEdge>
GraphType mitk::UndirectedGraph< TVertex, TEdge >::m_Graph
protected

Definition at line 157 of file mitkUndirectedGraph.h.


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