casacore
|
#include <LatticeHistograms.h>
Public Member Functions | |
LatticeHistograms (const MaskedLattice< T > &lattice, LogIO &os, Bool showProgress=True, Bool forceDisk=False) | |
Constructor takes the MaskedLattice and a LogIO object for logging. More... | |
LatticeHistograms (const MaskedLattice< T > &lattice, Bool showProgress=True, Bool forceDisk=False) | |
Constructor takes the MaskedLattice only. More... | |
LatticeHistograms (const LatticeHistograms< T > &other) | |
Copy constructor (copy semantics) More... | |
virtual | ~LatticeHistograms () |
Destructor. More... | |
LatticeHistograms< T > & | operator= (const LatticeHistograms< T > &other) |
Assignment operator (copy semantics) More... | |
Bool | setAxes (const Vector< Int > &cursorAxes) |
Set the cursor axes (0 relative). More... | |
Bool | setNBins (const uInt &nBins) |
Set the number of bins for the histogram. More... | |
Bool | setIncludeRange (const Vector< T > &include) |
Specify a pixel intensity range for which all pixels in that range are included. More... | |
Bool | setGaussian (const Bool &doGauss) |
Specify that a Gaussian overlay should be plotted on the histogram. More... | |
Bool | setForm (const Bool &doLog, const Bool &doCumu) |
Specify the form of the histogram. More... | |
Bool | setStatsList (const Bool &doList) |
This function allows you to control whether some statistics of the data that contributed to the histogram are written to the output stream. More... | |
Bool | setPlotting (PGPlotter &plotter, const Vector< Int > &nxy) |
This function sets the name of the PGPLOT plotting device and the number of subplots in x and y per page. More... | |
Bool | display () |
Display the histograms by plotting them. More... | |
void | closePlotting () |
CLose the plotter. More... | |
Vector< Int > | displayAxes () const |
Return the display axes. More... | |
Bool | getHistograms (Array< T > &values, Array< T > &counts) |
This function retrieves the histograms into Array . More... | |
Bool | getHistograms (Array< T > &values, Array< T > &counts, Array< Vector< T > > &stats) |
in this version, the set of stats for each histogram is also returned. More... | |
Bool | getHistogram (Vector< T > &values, Vector< T > &counts, const IPosition &pos, const Bool posInLattice=False) |
This function retrieves the histogram at the specified location into Vectors . More... | |
void | resetError () |
Reset argument error condition. More... | |
String | errorMessage () const |
Recover last error message. More... | |
Bool | setNewLattice (const MaskedLattice< T > &lattice) |
Set a MaskedLattice. More... | |
Protected Member Functions | |
IPosition | locHistInLattice (const IPosition &histPosition, Bool relativeToParent=True) const |
Given a location in the histogram storage lattice, convert those locations on the non-histogram axis (the first one) relative to the parent or current lattice. More... | |
Protected Attributes | |
LogIO | os_p |
These things are protected only so that they are available to ImageHistograms which inherits from LatticeHistograms. More... | |
Bool | goodParameterStatus_p |
Vector< Int > | cursorAxes_p |
Vector< Int > | displayAxes_p |
String | error_p |
Private Types | |
typedef NumericTraits< T >::PrecisionType | AccumType |
A useful typedef. More... | |
Private Member Functions | |
Bool | displayHistograms () |
Display histograms as a function of display axis. More... | |
Bool | displayOneHistogram (const T &linearSum, const T &linearYMax, const IPosition &histPos, const Vector< T > &stats, const Vector< T > &values, const Vector< T > &counts, PGPlotter &plotter) |
Display one histogram. More... | |
void | extractOneHistogram (T &linearSum, T &linearYMax, Vector< T > &values, Vector< T > &counts, const Vector< T > &stats, const Vector< T > &intCounts) |
Fish out and convert to the appropriate form one histogram from the storage lattice. More... | |
Bool | generateStorageLattice () |
Iterate through the lattice and generate the histogram accumulation lattice. More... | |
void | getStatistics (Vector< T > &stats, const IPosition &pos) const |
Get the statistics from the statistics object for the current location of either the input lattice, or the histogram storage lattice. More... | |
void | listStatistics (LogIO &os, const Vector< T > &stats, T binWidth) |
List statistics. More... | |
void | makeHistograms () |
Fill histograms storage lattice. More... | |
Bool | makeStatistics () |
Create and fill statistics object. More... | |
Bool | setInclude (Vector< T > &range, Bool &noInclude, const Vector< T > &include, ostream &os) |
Check/set include pixel range. More... | |
void | setStream (ostream &os, Int oPrec) |
Set stream attributes. More... | |
virtual String | writeCoordinates (const IPosition &histPos) const |
Make a string with pixel coordinates of display axes. More... | |
Bool | writeDispAxesValues (const String &coords, PGPlotter &plotter, Float nchar) const |
Write values of display axes on plots. More... | |
Static Private Member Functions | |
static Float | convertT (const T value) |
Convert a T to a Float for plotting. More... | |
static T | convertF (const Float value) |
Convert a Float (from plotting) to a T More... | |
Private Attributes | |
const MaskedLattice< T > * | pInLattice_p |
TempLattice< T > * | pStoreLattice_p |
LatticeStatistics< T > * | pStats_p |
Bool | binAll_p |
Bool | needStorageLattice_p |
Bool | doCumu_p |
Bool | doGauss_p |
Bool | doList_p |
Bool | doLog_p |
Bool | haveLogger_p |
Bool | showProgress_p |
Bool | forceDisk_p |
uInt | nBins_p |
PGPlotter | plotter_p |
Vector< Int > | nxy_p |
Vector< T > | range_p |
IPosition | blcParent_p |
Displays histograms of regions from a lattice.
Public interface
This is a class designed to display histograms from MaskedLattices
This class enable you to display and/or retrieve histograms evaluated over specified regions from a MaskedLattice. The dimension of the region is arbitrary, but the size of each dimension is always the size of the corresponding lattice axis. The histograms are displayed as a function of location of the axes not used to evaluate the histograms over. The axes which you evaluate the histograms over are called the cursor axes, the others are called the display axes.
For example, consider a lattice cube (call the axes xyz or [0,1,2]). You could display histograms from xy planes (cursor axes [0,1]) as a function of z (display axes [2]). Or you could retrieve histograms from the z axis (cursor axes [2]) for each [x,y] location (display axes [0,1]).
This class generates a "storage lattice" into which it writes the histograms. It is from this storage lattice that the plotting and retrieval arrays are drawn. The storage lattice is either in core or on disk depending upon its size (if > 10% of memory given by.aipsrc system.resources.memory then it goes into a disk-based PagedArray). If on disk, the storage lattice is deleted when the LatticeHistograms
object destructs.
Tip: Note that for complex lattices, real and imaginary are treated independently; They are binned and plotted separately;
Tip: If you ignore return error statuses from the functions that set the state of the class, the internal status of the class is set to bad; This means it will just keep on returning error conditions until you explicitly recover the situation; A message describing the last
error condition can be recovered with function errorMessage;
In this example, a PagedImage
is constructed. We set the cursor axes to be the y and z axes so we make a histogram of each yz plane as a function of x location on the PGPLOT device "/xs" with 9 subplots per page. After the plotting we also retrieve the histograms into an array.
The generation of histograms from an image is a basic and necessary capability.
Definition at line 159 of file LatticeHistograms.h.
|
private |
A useful typedef.
Definition at line 311 of file LatticeHistograms.h.
casacore::LatticeHistograms< T >::LatticeHistograms | ( | const MaskedLattice< T > & | lattice, |
LogIO & | os, | ||
Bool | showProgress = True , |
||
Bool | forceDisk = False |
||
) |
Constructor takes the MaskedLattice and a LogIO
object for logging.
You can also specify whether you want to see progress meters or not. You can force the storage lattice to be disk based, otherwise the decision for core or disk is taken for you.
casacore::LatticeHistograms< T >::LatticeHistograms | ( | const MaskedLattice< T > & | lattice, |
Bool | showProgress = True , |
||
Bool | forceDisk = False |
||
) |
Constructor takes the MaskedLattice only.
In the absence of a logger you get no messages. This includes error messages and potential listing of statistics. You can specify whether you want to see progress meters or not. You can force the storage lattice to be disk based, otherwise the decision for core or disk is taken for you.
casacore::LatticeHistograms< T >::LatticeHistograms | ( | const LatticeHistograms< T > & | other | ) |
Copy constructor (copy semantics)
|
virtual |
Destructor.
void casacore::LatticeHistograms< T >::closePlotting | ( | ) |
CLose the plotter.
|
inlinestaticprivate |
Convert a Float
(from plotting) to a T
Definition at line 330 of file LatticeHistograms.h.
References casacore::value().
|
inlinestaticprivate |
Convert a T
to a Float
for plotting.
Definition at line 327 of file LatticeHistograms.h.
References casacore::real(), and casacore::value().
Bool casacore::LatticeHistograms< T >::display | ( | ) |
Display the histograms by plotting them.
A return value of False
indicates an invalid plotting device, or that the internal status of the class is bad. If you don't call this function you won't see any histograms.
|
inline |
Return the display axes.
Definition at line 251 of file LatticeHistograms.h.
References casacore::LatticeHistograms< T >::displayAxes_p.
|
private |
Display histograms as a function of display axis.
|
private |
Display one histogram.
|
inline |
Recover last error message.
Definition at line 288 of file LatticeHistograms.h.
References casacore::LatticeHistograms< T >::error_p.
|
private |
Fish out and convert to the appropriate form one histogram from the storage lattice.
|
private |
Iterate through the lattice and generate the histogram accumulation lattice.
Bool casacore::LatticeHistograms< T >::getHistogram | ( | Vector< T > & | values, |
Vector< T > & | counts, | ||
const IPosition & | pos, | ||
const Bool | posInLattice = False |
||
) |
This function retrieves the histogram at the specified location into Vectors
.
The histogram is retrieved in the form specified by the setForm
function. The vectors are resized internally. If posInLattice=True
then the location is a location in the input lattice. Any positions on the display axes are ignored. Otherwise, you should just give locations for the display axes only. A return value of False
indicates that the internal status of the class is bad.
Bool casacore::LatticeHistograms< T >::getHistograms | ( | Array< T > & | values, |
Array< T > & | counts | ||
) |
This function retrieves the histograms into Array
.
The shape of the first dimension of this array is the number of bins. The rest of the shape of the array is the shape of the display axes (e.g. if the shape of the lattice is [nx,ny,nz] and you ask for histograms of the y axis the shape of the returned array would be [nbins,nx,nz]. The histograms are retrieved in the form specified by the setForm
function. The arrays are resized internally. A return value of False
indicates that the internal status of the class is bad.
Bool casacore::LatticeHistograms< T >::getHistograms | ( | Array< T > & | values, |
Array< T > & | counts, | ||
Array< Vector< T > > & | stats | ||
) |
in this version, the set of stats for each histogram is also returned.
The stats array has the shape of the display axes.
|
private |
Get the statistics from the statistics object for the current location of either the input lattice, or the histogram storage lattice.
|
private |
List statistics.
|
protected |
Given a location in the histogram storage lattice, convert those locations on the non-histogram axis (the first one) relative to the parent or current lattice.
|
private |
Fill histograms storage lattice.
|
private |
Create and fill statistics object.
LatticeHistograms<T>& casacore::LatticeHistograms< T >::operator= | ( | const LatticeHistograms< T > & | other | ) |
Assignment operator (copy semantics)
|
inline |
Reset argument error condition.
If you specify invalid arguments to one of the above set
functions, an internal flag will be set which will prevent the work functions from doing anything (should you have chosen to ignore the Boolean return values of the set
functions). This function allows you to reset that internal state to good.
Definition at line 285 of file LatticeHistograms.h.
References casacore::LatticeHistograms< T >::goodParameterStatus_p, and casacore::True.
Bool casacore::LatticeHistograms< T >::setAxes | ( | const Vector< Int > & | cursorAxes | ) |
Set the cursor axes (0 relative).
A return value of False
indicates you have asked for an invalid axis or that the internal status of the class is bad. The default state of the class is to set the cursor axes to all axes in the lattice.
Bool casacore::LatticeHistograms< T >::setForm | ( | const Bool & | doLog, |
const Bool & | doCumu | ||
) |
Specify the form of the histogram.
It can be plotted linearly or logarithmically, and cumulatively or non-cumulatively. A return value of False
indicates that the internal status of the class is bad. The default state of the class is to draw the histograms linearly and non-cumulatively.
Bool casacore::LatticeHistograms< T >::setGaussian | ( | const Bool & | doGauss | ) |
Specify that a Gaussian overlay should be plotted on the histogram.
This Gaussian has the same mean and standard deviation as the data that were binned, and the same integral as the histogram. A return value of False
indicates that the internal status of the class is bad. The default state of the class is to not draw a Gaussian overlay.
|
private |
Check/set include pixel range.
Bool casacore::LatticeHistograms< T >::setIncludeRange | ( | const Vector< T > & | include | ) |
Specify a pixel intensity range for which all pixels in that range are included.
A vector of length 1 for include
means that the range will be set to -abs(include(0))
to abs(include(0))
. A return value of False
indicates that the internal status of the class is bad. If you don't call this function, the default state of the class is to include all pixels.
Bool casacore::LatticeHistograms< T >::setNBins | ( | const uInt & | nBins | ) |
Set the number of bins for the histogram.
Note that the bin width is worked out for each histogram separately from the data minimum and maximum. The default state of the class is to set 25 bins. A return value of False
indicates you gave a non-positive bin width or that the internal status of the class is bad.
Bool casacore::LatticeHistograms< T >::setNewLattice | ( | const MaskedLattice< T > & | lattice | ) |
Set a MaskedLattice.
A return value of False
indicates the lattice had an invalid type or that the internal status of the class is bad.
Bool casacore::LatticeHistograms< T >::setPlotting | ( | PGPlotter & | plotter, |
const Vector< Int > & | nxy | ||
) |
This function sets the name of the PGPLOT plotting device and the number of subplots in x and y per page.
If you set plotter
but offer a zero length array for nxy
then nxy
is set to [1,1]. A return value of False
indicates invalid plotting arguments or that the internal status of the class is bad. If you don't call this function, the default state of the class is to not set a plotting device.
Bool casacore::LatticeHistograms< T >::setStatsList | ( | const Bool & | doList | ) |
This function allows you to control whether some statistics of the data that contributed to the histogram are written to the output stream.
A return value of False
indicates that the internal status of the class is bad. The default state of the class is to not list statistics.
|
private |
Set stream attributes.
|
privatevirtual |
Make a string with pixel coordinates of display axes.
This function is over-ridden by ImageHistograms which inherits from LatticeHistograms.
|
private |
Write values of display axes on plots.
|
private |
Definition at line 316 of file LatticeHistograms.h.
|
private |
Definition at line 323 of file LatticeHistograms.h.
|
protected |
Definition at line 300 of file LatticeHistograms.h.
|
protected |
Definition at line 300 of file LatticeHistograms.h.
Referenced by casacore::LatticeHistograms< T >::displayAxes().
|
private |
Definition at line 317 of file LatticeHistograms.h.
|
private |
Definition at line 317 of file LatticeHistograms.h.
|
private |
Definition at line 317 of file LatticeHistograms.h.
|
private |
Definition at line 317 of file LatticeHistograms.h.
|
protected |
Definition at line 301 of file LatticeHistograms.h.
Referenced by casacore::LatticeHistograms< T >::errorMessage().
|
private |
Definition at line 318 of file LatticeHistograms.h.
|
protected |
Definition at line 299 of file LatticeHistograms.h.
Referenced by casacore::LatticeHistograms< T >::resetError().
|
private |
Definition at line 318 of file LatticeHistograms.h.
|
private |
Definition at line 319 of file LatticeHistograms.h.
|
private |
Definition at line 316 of file LatticeHistograms.h.
|
private |
Definition at line 321 of file LatticeHistograms.h.
|
protected |
These things are protected only so that they are available to ImageHistograms which inherits from LatticeHistograms.
Definition at line 298 of file LatticeHistograms.h.
|
private |
Definition at line 313 of file LatticeHistograms.h.
|
private |
Definition at line 320 of file LatticeHistograms.h.
|
private |
Definition at line 315 of file LatticeHistograms.h.
|
private |
Definition at line 314 of file LatticeHistograms.h.
|
private |
Definition at line 322 of file LatticeHistograms.h.
|
private |
Definition at line 318 of file LatticeHistograms.h.