• Docs »
  • OEFastROCSHistogram

OEFastROCSHistogram

class OEFastROCSHistogram

This class is returned from OEDBTracer::GetHistogram during and after a query is sent to OEShapeDatabase::GetScores or OEShapeDatabase::GetSortedScores. It is used to contain a list of frequencies representing the distribution of scores. This same container is used to contain the frequencies of the following 3 score types:

Constructors

OEFastROCSHistogram(size_t numBins=200)

Construct a new histogram with the specified number of “bins” in which to bin the score distribution. The same number of bins is applied to each score type.

OEFastROCSHistogram(const OEFastROCSHistogram &rhs)

Copy constructor for moving a OEFastROCSHistogram in memory.

operator=

OEFastROCSHistogram &operator=(const OEFastROCSHistogram &rhs)

Assignment operator for moving a OEFastROCSHistogram in memory.

GetHistogram

void GetHistogram(std::vector<unsigned int> &frequencies,
                  unsigned int scoreType)

Initializes the frequencies vector to the required size to contain the number of bins for this histogram, then fills it with the number of molecules that falls within each bin for the scoreType specified. The scoreType should be one of the following:

GetNumBins

size_t GetNumBins() const

Returns the number of bins used for this histogram. The number of bins determines the granularity of the scores.

Update

void Update(const OEFastROCSHistogram &rhs)

Sum the histogram rhs into this histogram. This histogram will then reflect the total of the two histograms. Used for aggregating histograms during the execution of OEShapeDatabase::GetScores or OEShapeDatabase::GetSortedScores.

void Update(const OEShapeDatabaseScore &score)

Updates this histogram from an individual OEShapeDatabaseScore object usually representing one molecule during the execution of OEShapeDatabase::GetScores or OEShapeDatabase::GetSortedScores.