#include <HyperName.h>

Public Member Functions
	HyperName (int dim)

	HyperName (std::vector< TString > names)

	HyperName (TString name0)

	HyperName (TString name0, TString name1)

	HyperName (TString name0, TString name1, TString name2)

	HyperName (TString name0, TString name1, TString name2, TString name3)

	HyperName (TString name0, TString name1, TString name2, TString name3, TString name4)

void	setUnits (TString units)

void	setUnits (TString units, int dim)

TString	getAxisString (int dim)

int	getDimension () const

HyperName	slice (std::vector< int > sliceDims)

const TString &	at (int dim) const

TString &	at (int dim)

	~HyperName ()

Private Attributes
std::vector< TString >	_names

std::vector< TString >	_units

Detailed Description

HyperPlot, Author: Sam Harnew, sam.h.nosp@m.arne.nosp@m.w@gma.nosp@m.il.c.nosp@m.om , Date: Dec 2015

Holds a n-dim vector of names that can be associtated to a n-dim Histogram (for axis titles etc). Also possible to store the units.

Definition at line 24 of file HyperName.h.

Constructor & Destructor Documentation

◆ HyperName() [1/7]

HyperName::HyperName ( int dim )

Fill HyperName with the standard names {var_0, var_1, ...}

Definition at line 5 of file HyperName.cpp.

                            {
   for(int i = 0; i < dim; i++){
     TString name = "var_"; name += i;
     _names.push_back( name );
     _units.push_back( " "  );
   }
 }

◆ HyperName() [2/7]

HyperName::HyperName ( std::vector< TString > names )

Fill HyperName with a std::vector<TString> of names

Definition at line 15 of file HyperName.cpp.

                                             {
   _names = names;
   _units = std::vector<TString>(names.size(), " ");
 
 }

◆ HyperName() [3/7]

HyperName::HyperName ( TString name0 )

Make a 1D HyperName with the given name

Definition at line 23 of file HyperName.cpp.

                                  {
   _names.push_back(name0);
   _units.push_back(" ");
 }

◆ HyperName() [4/7]

HyperName::HyperName	(	TString	name0,
		TString	name1
	)

Make a 2D HyperName with the given names

Definition at line 30 of file HyperName.cpp.

                                                 {
   _names.push_back(name0);
   _names.push_back(name1);
   _units.push_back(" ");
   _units.push_back(" ");
 }

◆ HyperName() [5/7]

HyperName::HyperName	(	TString	name0,
		TString	name1,
		TString	name2
	)

Make a 3D HyperName with the given names

Definition at line 39 of file HyperName.cpp.

                                                                {
   _names.push_back(name0);
   _names.push_back(name1);
   _names.push_back(name2);
   _units.push_back(" ");
   _units.push_back(" ");
   _units.push_back(" ");
 }

◆ HyperName() [6/7]

HyperName::HyperName	(	TString	name0,
		TString	name1,
		TString	name2,
		TString	name3
	)

Make a 4D HyperName with the given names

Definition at line 50 of file HyperName.cpp.

                                                                               {
   _names.push_back(name0);
   _names.push_back(name1);
   _names.push_back(name2);
   _names.push_back(name3);
   _units.push_back(" ");
   _units.push_back(" ");
   _units.push_back(" ");
   _units.push_back(" ");
 }

◆ HyperName() [7/7]

HyperName::HyperName	(	TString	name0,
		TString	name1,
		TString	name2,
		TString	name3,
		TString	name4
	)

Make a 5D HyperName with the given names

Definition at line 63 of file HyperName.cpp.

                                                                                              {
   _names.push_back(name0);
   _names.push_back(name1);
   _names.push_back(name2);
   _names.push_back(name3);
   _names.push_back(name4);
   _units.push_back(" ");
   _units.push_back(" ");
   _units.push_back(" ");
   _units.push_back(" ");
   _units.push_back(" ");
 }

◆ ~HyperName()

HyperName::~HyperName ( )

Destructor

Definition at line 147 of file HyperName.cpp.

                      {
 
 }

Member Function Documentation

◆ at() [1/2]

const TString& HyperName::at ( int dim ) const

inline

access an element of the name vector

Definition at line 50 of file HyperName.h.

◆ at() [2/2]

TString& HyperName::at ( int dim )

inline

access an element of the name vector

Definition at line 51 of file HyperName.h.

◆ getAxisString()

TString HyperName::getAxisString ( int dim )

Make a TString sutable for an axis title for a given dimension.

Definition at line 96 of file HyperName.cpp.

                                        {
   if (dim < 0 || dim >= (int)_names.size()){
     std::cout << "Trying call HyperName::getAxisString on an element that doesn't exist" << std::endl;
     return "ERROR";
   }  
   TString retVal = _names.at(dim);
   if (_units.at(dim) != " ") retVal += " [" + _units.at(dim) + "]";
   return retVal;
 }

◆ getDimension()

int HyperName::getDimension ( ) const

Definition at line 107 of file HyperName.cpp.

                                  {
   return _names.size();
 }

◆ setUnits() [1/2]

void HyperName::setUnits ( TString units )

The the units of every dimension to be the given TString

Definition at line 78 of file HyperName.cpp.

                                      {
   for(unsigned i = 0; i < _units.size(); i++){
     _units.at(i) = units;
   }
 }

◆ setUnits() [2/2]

void HyperName::setUnits	(	TString	units,
		int	dim
	)

The the units of the given dimension to be the given TString

Definition at line 86 of file HyperName.cpp.

                                               {
   if (dim < 0 || dim >= (int)_names.size()){
     std::cout << "Trying to set the units of the HyperName element that doesn't exist" << std::endl;
     return;
   }
   _units.at(dim) = units;
 }

◆ slice()

HyperName HyperName::slice ( std::vector< int > sliceDims )

Slice (remove) the given dimesnions, and return new HyperName

Definition at line 114 of file HyperName.cpp.

                                                   {
   
   int nStartingDims = getDimension();
   int nSliceDims    = sliceDims.size();
 
   HyperName names( nStartingDims - nSliceDims );
   int count = 0;
 
   for (int i = 0; i < nStartingDims; i++){
 
     bool doesExist = false;
 
     for (int j = 0; j < nSliceDims; j++){
       int dim = sliceDims.at(j);
       if (i == dim) {
         doesExist = true;
         break;
       }
     }
 
     if (doesExist == false) { 
       names.at(count) = at(i); count++; 
     }
   }
 
   return names;    
 
 }

Member Data Documentation

◆ _names

std::vector<TString> HyperName::_names

private

vector of names

Definition at line 26 of file HyperName.h.

◆ _units

std::vector<TString> HyperName::_units