cvn::GCNGraph Class Reference

GCNGraph, basic input for the GCN. More...

#include <GCNGraph.h>

Public Member Functions
	GCNGraph ()
	Default constructor. More...
	GCNGraph (std::vector< std::vector< float >> positions, std::vector< std::vector< float >> features)
	Constructor with position and feature vectors. More...
	GCNGraph (std::vector< GCNGraphNode > nodes)
	Construct graph from a vector of GCNGraphNodes. More...
	~GCNGraph ()
	Destructor. More...
void	AddNode (std::vector< float > position, std::vector< float > features)
	Add a new node. More...
void	AddNode (std::vector< float > position, std::vector< float > features, std::vector< float > groundTruth)
void	AddNode (GCNGraphNode node)
const unsigned int	GetNumberOfNodes () const
	Get the number of nodes. More...
const GCNGraphNode &	GetNode (const unsigned int index) const
	Access nodes. More...
GCNGraphNode &	GetNodeEditable (const unsigned int index)
const std::vector< std::pair< float, float > >	GetMinMaxPositions () const
	Return minimum and maximum position coordinate values. More...
const std::pair< float, float >	GetCoordinateMinMax (unsigned int index) const
const std::vector< float >	GetSpacialExtent () const
	Get the extent in each dimension. More...
const float	GetCoordinateSpacialExtent (unsigned int index) const
const std::vector< float >	ConvertGraphToVector () const
	Function to linearise the graph to a vector for zlib file creation. More...
const unsigned int	GetNumberOfNodeCoordinates () const
	Return the number of coordinates for each node. More...
const unsigned int	GetNumberOfNodeFeatures () const
	Return the number of features for each node. More...

Private Attributes
std::vector< GCNGraphNode >	fNodes
	Store the nodes. More...

Detailed Description

GCNGraph, basic input for the GCN.

Definition at line 18 of file GCNGraph.h.

Constructor & Destructor Documentation

cvn::GCNGraph::GCNGraph

(

)

Default constructor.

Definition at line 16 of file GCNGraph.cxx.

  {}

cvn::GCNGraph::GCNGraph	(	std::vector< std::vector< float >>	positions,
		std::vector< std::vector< float >>	features
	)

Constructor with position and feature vectors.

Definition at line 25 of file GCNGraph.cxx.

  {
    if(positions.size() != features.size()){
      std::cerr << "The number of nodes must be the same for the position and feature vectors" << std::endl;
      assert(0);
    }
    for(unsigned int n = 0; n < positions.size(); ++n){
      this->AddNode(positions.at(n),features.at(n));
    }
  }

cvn::GCNGraph::GCNGraph

(

std::vector< GCNGraphNode >

nodes

)

Construct graph from a vector of GCNGraphNodes.

Definition at line 19 of file GCNGraph.cxx.

                                                 :
  fNodes(nodes)
  {

  }

cvn::GCNGraph::~GCNGraph ( )

inline

Destructor.

Definition at line 29 of file GCNGraph.h.

{};

Member Function Documentation

void cvn::GCNGraph::AddNode	(	std::vector< float >	position,
		std::vector< float >	features
	)

Add a new node.

Definition at line 37 of file GCNGraph.cxx.

                                                                            {
    GCNGraphNode newNode(position,features);
    AddNode(newNode);
  }

void cvn::GCNGraph::AddNode	(	std::vector< float >	position,
		std::vector< float >	features,
		std::vector< float >	groundTruth
	)

Definition at line 43 of file GCNGraph.cxx.

                                 {
    GCNGraphNode newNode(position,features,groundTruth);
    AddNode(newNode);
  }

void cvn::GCNGraph::AddNode

(

cvn::GCNGraphNode

node

)

Definition at line 49 of file GCNGraph.cxx.

                                            {
    fNodes.push_back(node);
  }

const std::vector< float > cvn::GCNGraph::ConvertGraphToVector

(

)

const

Function to linearise the graph to a vector for zlib file creation.

Definition at line 138 of file GCNGraph.cxx.

                                                             {

    std::vector<float> nodeVector;

    for(const GCNGraphNode &node : fNodes){
      // First add the position components
      for(const float pos : node.GetPosition()){
        nodeVector.push_back(pos);
      }
      // Now add the features
      for(const float feat : node.GetFeatures()){
        nodeVector.push_back(feat);
      }
      // Now add the ground truth
      for (const float truth : node.GetGroundTruth()) {
        nodeVector.push_back(truth);
      }
    }

    return nodeVector; 
  }

const std::pair< float, float > cvn::GCNGraph::GetCoordinateMinMax

(

unsigned int

index

)

const

Definition at line 105 of file GCNGraph.cxx.

                                                                                  {
    if(coord > fNodes.size()){
      std::cerr << "Node index is out of bounds" << std::endl;
      assert(0);
    }
    return this->GetMinMaxPositions()[coord];
  }

const float cvn::GCNGraph::GetCoordinateSpacialExtent

(

unsigned int

index

)

const

Definition at line 126 of file GCNGraph.cxx.

                                                                          {
    if(coord > fNodes.size()){
      std::cerr << "Node index is out of bounds" << std::endl;
      assert(0);
    }
    return this->GetSpacialExtent()[coord];
  }

const std::vector< std::pair< float, float > > cvn::GCNGraph::GetMinMaxPositions

(

)

const

Return minimum and maximum position coordinate values.

Definition at line 78 of file GCNGraph.cxx.

                                                                          {

    std::pair<float,float> dummyPair = std::make_pair(1.e6,-1.e6);
    std::vector<std::pair<float,float>> minMaxVals;

    if(fNodes.size() == 0){
      std::cerr << "No nodes found in the graph, returning empty vector" << std::endl;
      return minMaxVals;
    }

    // Initialise the vector of pairs for the number of coordinates
    for(unsigned int i = 0; i < GetNumberOfNodeCoordinates(); ++i){
      minMaxVals.push_back(dummyPair);
    }

    for(GCNGraphNode node : fNodes){
      std::vector<float> nodePos = node.GetPosition();
      for(unsigned int p = 0; p < nodePos.size(); ++p){
        if(nodePos[p] < minMaxVals[p].first) minMaxVals[p].first = nodePos[p];
        if(nodePos[p] > minMaxVals[p].second) minMaxVals[p].second = nodePos[p];
      }
    }
 
    return minMaxVals;

  }

const GCNGraphNode & cvn::GCNGraph::GetNode

(

const unsigned int

index

)

const

Access nodes.

Definition at line 59 of file GCNGraph.cxx.

                                                                     {
    if(this->GetNumberOfNodes() == 0){
      std::cerr << "GCNGraph::GetNode(): Can't access node with index " << index << std::endl;
      assert(0);
    }

    return fNodes.at(index);
  }

GCNGraphNode & cvn::GCNGraph::GetNodeEditable

(

const unsigned int

index

)

Definition at line 68 of file GCNGraph.cxx.

                                                                 {
    if(this->GetNumberOfNodes() == 0){
      std::cerr << "GCNGraph::GetNode(): Can't access node with index " << index << std::endl;
      assert(0);
    }

    return fNodes.at(index);
  }

const unsigned int cvn::GCNGraph::GetNumberOfNodeCoordinates

(

)

const

Return the number of coordinates for each node.

Definition at line 161 of file GCNGraph.cxx.

                                                               {
    if(fNodes.size() == 0){
      std::cerr << "Graph has no nodes, returning 0" << std::endl;
      return 0;
    }
    else return fNodes[0].GetNumberOfCoordinates();
  }

const unsigned int cvn::GCNGraph::GetNumberOfNodeFeatures

(

)

const

Return the number of features for each node.

Definition at line 170 of file GCNGraph.cxx.

                                                            {
    if(fNodes.size() == 0){
      std::cerr << "Graph has no nodes, returning 0" << std::endl;
      return 0;
    }
    else return fNodes[0].GetNumberOfFeatures();
  }

const unsigned int cvn::GCNGraph::GetNumberOfNodes

(

)

const

Get the number of nodes.

Definition at line 54 of file GCNGraph.cxx.

                                                     {
    return fNodes.size();
  }

const std::vector< float > cvn::GCNGraph::GetSpacialExtent

(

)

const

Get the extent in each dimension.

Definition at line 114 of file GCNGraph.cxx.

                                                         {

    std::vector<std::pair<float,float>> minMaxVals = this->GetMinMaxPositions();

    std::vector<float> extent;
    for(std::pair<float,float> pair : minMaxVals){
      extent.push_back(pair.second - pair.first);
    }

    return extent;
  }

Member Data Documentation

std::vector<GCNGraphNode> cvn::GCNGraph::fNodes

private

Store the nodes.

Definition at line 64 of file GCNGraph.h.

---

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

• dunereco/dunereco/CVN/func/GCNGraph.h
• dunereco/dunereco/CVN/func/GCNGraph.cxx