STIRA  0.1
Public Member Functions | List of all members
stira::histogram::JointHistogram Class Reference

conditional or joint histogram class WARNING: currently only works for default case when bin size is 1 More...

#include <JointHistogram.h>

Public Member Functions

 JointHistogram (double horizontalBinSize, double verticalBinSize, double horizontalMin, double horizontalMax, double verticalMin, double verticalMax, int nrBands=1)
 constructor More...
 
 JointHistogram (Image *pImage1, Image *pImage2, bool useAbsoluteValues=false)
 constructor Initializes and builds conditional histogram based on the two input images More...
 
 JointHistogram (ArrayGrid< double > *pGrid1, int xTop1, int yTop1, int xBottom1, int yBottom1, ArrayGrid< double > *pGrid2, int xTop2, int yTop2, int xBottom2, int yBottom2, bool useAbsoluteValues=false)
 constructor Initializes and builds conditional histogram based on the two input grids More...
 
 JointHistogram (ArrayGrid< double > *pGrid1, ArrayGrid< double > *pGrid2, bool useAbsoluteValues=false)
 constructor Initializes and builds conditional histogram based on the two input grids More...
 
 ~JointHistogram ()
 destructor
 
bool Write (std::string fileName)
 writes current histogram to text file
 
int GetNrOfHorizontalBins ()
 Gets nr of bins on the horizontal axis in the histogram.
 
int GetNrOfVerticalBins ()
 Gets nr of bins on the vertical axis in the histogram.
 
int GetBinValue (int bandNr, int binX, int binY)
 
double GetNormalizedBinValue (int bandNr, int binX, int binY)
 
FloatHistogramGetMarginalPDF1 ()
 
FloatHistogramGetMarginalPDF2 ()
 
ImageVisualizeAsImage ()
 visualizes the current conditional histogram as an image
 
void ExportText (std::string fileName)
 

Detailed Description

conditional or joint histogram class WARNING: currently only works for default case when bin size is 1

Constructor & Destructor Documentation

stira::histogram::JointHistogram::JointHistogram ( double  horizontalBinSize,
double  verticalBinSize,
double  horizontalMin,
double  horizontalMax,
double  verticalMin,
double  verticalMax,
int  nrBands = 1 
)

constructor

Parameters
horizontalBinSizesize of a bin on the horizontal axis
verticalBinSizesize of a bin on the vertical axis
horizontalMinminimum value on the horizontal axis
horizontalMaxmaximum value on the horizontal axis
verticalMinminimum value on the vertical axis
verticalMaxminimum value on the vertical axis All histogram values are initialized to 0
stira::histogram::JointHistogram::JointHistogram ( Image pImage1,
Image pImage2,
bool  useAbsoluteValues = false 
)

constructor Initializes and builds conditional histogram based on the two input images

Parameters
pImage1first input image
pImage2second input image
useAbsoluteValuesflag to use absolute values instead of normal values

References stira::imagedata::Image::GetBands(), stira::imagedata::Image::GetHeight(), stira::imagedata::Image::GetNumberOfBands(), and stira::imagedata::Image::GetWidth().

stira::histogram::JointHistogram::JointHistogram ( ArrayGrid< double > *  pGrid1,
int  xTop1,
int  yTop1,
int  xBottom1,
int  yBottom1,
ArrayGrid< double > *  pGrid2,
int  xTop2,
int  yTop2,
int  xBottom2,
int  yBottom2,
bool  useAbsoluteValues = false 
)

constructor Initializes and builds conditional histogram based on the two input grids

Parameters
pGrid1first input grid
pGrid2second input grid
useAbsoluteValuesflag to use absolute values instead of normal values

References stira::imagedata::ArrayGrid< T >::GetHeight(), and stira::imagedata::ArrayGrid< T >::GetWidth().

stira::histogram::JointHistogram::JointHistogram ( ArrayGrid< double > *  pGrid1,
ArrayGrid< double > *  pGrid2,
bool  useAbsoluteValues = false 
)

constructor Initializes and builds conditional histogram based on the two input grids

Parameters
pGrid1first input grid
pGrid2second input grid
useAbsoluteValuesflag to use absolute values instead of normal values

References stira::imagedata::ArrayGrid< T >::GetHeight(), and stira::imagedata::ArrayGrid< T >::GetWidth().


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