GCNGraph.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
/// \file    GCNGraph.h
/// \brief   GCNGraph for GCN
/// \author  Leigh H. Whitehead - leigh.howard.whitehead@cern.ch
////////////////////////////////////////////////////////////////////////

#ifndef CVN_GCNGRAPH_H
#define CVN_GCNGRAPH_H

#include <ostream>
#include <vector>
#include "dunereco/CVN/func/GCNGraphNode.h"

namespace cvn
{

  /// GCNGraph, basic input for the GCN
  class GCNGraph
  {
  public:

    /// Default constructor
    GCNGraph();
    /// Constructor with position and feature vectors
    GCNGraph(std::vector<std::vector<float>> positions, std::vector<std::vector<float>> features);
    /// Construct graph from a vector of GCNGraphNodes
    GCNGraph(std::vector<GCNGraphNode> nodes);
    /// Destructor
    ~GCNGraph(){};

    /// Add a new node
    void AddNode(std::vector<float> position, std::vector<float> features);
    void AddNode(std::vector<float> position, std::vector<float> features,
      std::vector<float> groundTruth);
    void AddNode(GCNGraphNode node);
    
    /// Get the number of nodes
    const unsigned int GetNumberOfNodes() const;

    /// Access nodes
    const GCNGraphNode& GetNode(const unsigned int index) const;
    GCNGraphNode& GetNodeEditable(const unsigned int index);

    /// Return minimum and maximum position coordinate values 
    const std::vector<std::pair<float,float>> GetMinMaxPositions() const;
    const std::pair<float,float> GetCoordinateMinMax(unsigned int index) const;

    /// Get the extent in each dimension
    const std::vector<float> GetSpacialExtent() const;
    const float GetCoordinateSpacialExtent(unsigned int index) const;

    /// Function to linearise the graph to a vector for zlib file creation
    const std::vector<float> ConvertGraphToVector() const;

    /// Return the number of coordinates for each node
    const unsigned int GetNumberOfNodeCoordinates() const;

    /// Return the number of features for each node
    const unsigned int GetNumberOfNodeFeatures() const;

  private:

    /// Store the nodes
    std::vector<GCNGraphNode> fNodes;

  };

  std::ostream& operator<<(std::ostream& os, const GCNGraph& m);

}

#endif  // CVN_GCNGRAPH_H