HyperPlot  v1
Bin and visualise multidimensional datasets
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
BinningBase Class Referenceabstract

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

The base class for any Binning object

Definition at line 27 of file BinningBase.h.

#include <BinningBase.h>

Inheritance diagram for BinningBase:
HyperBinning UniformBinning HyperBinningDiskRes HyperBinningMemRes

Public Member Functions

void setNames (HyperName names)
 
HyperName getNames () const
 
const int & getDimension () const
 
double getMin (int dimension) const
 
double getMax (int dimension) const
 
TString getBinningType () const
 
bool isSameBinningType (const BinningBase &other) const
 
virtual bool isDiskResident () const
 
virtual TString filename () const
 
virtual void load (TString filename, TString option="READ")=0
 
virtual void save (TString filename) const =0
 
virtual void save () const =0
 
virtual BinningBaseclone () const =0
 
virtual int getNumBins () const =0
 
virtual int getBinNum (const HyperPoint &coords) const =0
 
virtual HyperVolume getBinHyperVolume (int binNumber) const =0
 
virtual void mergeBinnings (const BinningBase &other)=0
 
virtual HyperPoint getAverageBinWidth () const =0
 
virtual HyperCuboid getLimits () const =0
 
virtual void reserveCapacity (int nElements)
 
virtual std::vector< int > getBinNum (const HyperPointSet &coords) const
 

Protected Member Functions

virtual void setDimension (int dimension)
 
void setBinningType (TString binningType)
 

Private Attributes

int _dimension
 
HyperName _axisNames
 
TString _binningType
 

Member Function Documentation

const int & BinningBase::getDimension ( ) const

get the dimensionality of the binning

Definition at line 30 of file BinningBase.cpp.

HyperName BinningBase::getNames ( ) const

get the a names for each dimension

Definition at line 25 of file BinningBase.cpp.

void BinningBase::setDimension ( int  dimension)
protectedvirtual

set the dimensionality of the binning

Reimplemented in HyperBinning, HyperBinningMemRes, and HyperBinningDiskRes.

Definition at line 34 of file BinningBase.cpp.

void BinningBase::setNames ( HyperName  names)

set the a name for each dimension

Definition at line 21 of file BinningBase.cpp.

Member Data Documentation

HyperName BinningBase::_axisNames
private

Possible to assign names to each dimension, which will be used for plotting etc

Definition at line 36 of file BinningBase.h.

TString BinningBase::_binningType
private

Useful to know what kind of binning this actually is (will be set by derrived type)

Definition at line 41 of file BinningBase.h.

int BinningBase::_dimension
private

Dimensionality of the binning. Can only be set ONCE with setDimension();

Definition at line 31 of file BinningBase.h.


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