LatticeHistSpecialize.h

Classes

LatticeHistSpecialize -- Specialized functions for LatticeHistograms (full description)

class LatticeHistSpecialize

Interface

Public Members
static void makeCumulative (Vector<Float>& counts, Float& yMax, uInt nBins, Float scale)
static void makeCumulative (Vector<Complex>& counts, Complex& yMax, uInt nBins, Float scale)
static void makeLogarithmic (Vector<Float>& counts, Float& yMax, uInt nBins)
static void makeLogarithmic (Vector<Complex>& counts, Complex& yMax, uInt nBins)
static Float mul(Float v1, Float v2)
static Complex mul(Complex v1, Complex v2)
static void plot(PGPlotter& plot, Bool doGauss, Bool doCumu, Bool doLog, Float linearSum, Float yMax, Float binWidth, const Vector<Float>& values, const Vector<Float>& counts, const Vector<Float>& stats, uInt whereLabel, uInt ci, Bool page)
static void plot(PGPlotter& plot, Bool doGauss, Bool doCumu, Bool doLog, Complex linearSum, Complex yMax, Complex binWidth, const Vector<Complex>& values, const Vector<Complex>& counts, const Vector<Complex>& stats, uInt whereLabel, uInt ci, Bool page)
static void process (const Float* pInData, const Bool* pInMask, Block<Float>* pHist, const Vector<Float>& clip, Float binWidth, uInt offset, uInt nrval, uInt nBins, uInt inIncr)
static void process (const Complex* pInData, const Bool* pInMask, Block<Complex>* pHist, const Block<Complex>& clip, Complex binWidth, uInt offset, uInt nrval, uInt nBins, uInt inIncr)
static Float setBinWidth (Float dmin, Float dmax, uInt nBins)
static Complex setBinWidth(Complex dmin, Complex dmax, uInt nBins)
Private Members
static uInt bin(Float datum, Float min, Float width, uInt nBins)
static void makeGauss(uInt& nGPts, Float& gMax, Vector<Float>& gX, Vector<Float>& gY, Float dMean, Float dSigma, Float dSum, Float xMin, Float xMax, Float binWidth, Bool doCumu, Bool doLog)
static void plotHist (const Vector<Float>& x, const Vector<Float>& y, PGPlotter& plotter)

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Specialized code is type specific. This code is for LatticeHistograms.

Synopsis

This class provides specialized static functions to handle Type dependent (Float, Complex) processing for LatticeHistograms. I couldn't do it all with templated functions.

Motivation

To Do

Member Description

static void makeCumulative (Vector<Float>& counts, Float& yMax, uInt nBins, Float scale)

Make historgam cumulative

static void makeCumulative (Vector<Complex>& counts, Complex& yMax, uInt nBins, Float scale)

static void makeLogarithmic (Vector<Float>& counts, Float& yMax, uInt nBins)

Make histogram logarithmic

static void makeLogarithmic (Vector<Complex>& counts, Complex& yMax, uInt nBins)

static Float mul(Float v1, Float v2)

Multiply. Real and imaginary treated as independent C1*C2 = (r1*r2,i1*i2)

static Complex mul(Complex v1, Complex v2)

static void plot(PGPlotter& plot, Bool doGauss, Bool doCumu, Bool doLog, Float linearSum, Float yMax, Float binWidth, const Vector<Float>& values, const Vector<Float>& counts, const Vector<Float>& stats, uInt whereLabel, uInt ci, Bool page)

Plot histograms

static void plot(PGPlotter& plot, Bool doGauss, Bool doCumu, Bool doLog, Complex linearSum, Complex yMax, Complex binWidth, const Vector<Complex>& values, const Vector<Complex>& counts, const Vector<Complex>& stats, uInt whereLabel, uInt ci, Bool page)

static void process (const Float* pInData, const Bool* pInMask, Block<Float>* pHist, const Vector<Float>& clip, Float binWidth, uInt offset, uInt nrval, uInt nBins, uInt inIncr)

Process data chunk creating histogram.

static void process (const Complex* pInData, const Bool* pInMask, Block<Complex>* pHist, const Block<Complex>& clip, Complex binWidth, uInt offset, uInt nrval, uInt nBins, uInt inIncr)

static Float setBinWidth (Float dmin, Float dmax, uInt nBins)

Set bin width. For complex, real and imaginary treated separately

static Complex setBinWidth(Complex dmin, Complex dmax, uInt nBins)

static uInt bin(Float datum, Float min, Float width, uInt nBins)

static void makeGauss(uInt& nGPts, Float& gMax, Vector<Float>& gX, Vector<Float>& gY, Float dMean, Float dSigma, Float dSum, Float xMin, Float xMax, Float binWidth, Bool doCumu, Bool doLog)

static void plotHist (const Vector<Float>& x, const Vector<Float>& y, PGPlotter& plotter)