vtkKWHistogram Class Reference

an histogram More...

#include <vtkKWHistogram.h>

Inheritance diagram for vtkKWHistogram:

[legend]

Collaboration diagram for vtkKWHistogram:

[legend]

List of all members.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkIdType	GetNumberOfBins ()
virtual double	GetOccurenceAtValue (double value)
virtual void	BuildHistogram (vtkDataArray *scalars, int component)
virtual void	AccumulateHistogram (vtkDataArray *scalars, int component)
virtual void	EmptyHistogram ()
Static Public Member Functions
static vtkKWHistogram *	New ()
static int	IsTypeOf (const char *type)
static vtkKWHistogram *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWHistogram ()
	~vtkKWHistogram ()
virtual void	ComputeStatistics ()
Protected Attributes
double	Range [2]
vtkDoubleArray *	Bins
vtkImageData *	Image
vtkIntArray *	ImageCoordinates
unsigned long	LastImageBuildTime
unsigned long	LastTransferFunctionTime
int	LogMode
vtkIdType	MaximumNumberOfBins
unsigned long	LastStatisticsBuildTime
double	MinimumOccurence
double	MaximumOccurence
double	TotalOccurence

vtkKWHistogram::ImageDescriptor *	LastImageDescriptor
virtual double *	GetRange ()
virtual void	GetRange (double &, double &)
virtual void	GetRange (double[2])
virtual vtkDoubleArray *	GetBins ()
virtual void	SetMaximumNumberOfBins (vtkIdType)
virtual vtkIdType	GetMaximumNumberOfBins ()
virtual double	GetMinimumOccurence ()
virtual double	GetMaximumOccurence ()
virtual double	GetTotalOccurence ()
virtual double	GetValueAtAccumulatedOccurence (double acc, double *exclude_value=0)
virtual void	SetRange (double, double)
void	SetRange (double[2])
virtual void	EstimateHistogramRange (vtkDataArray *scalars, int component, double range[2])
virtual void	SetLogMode (int)
virtual void	LogModeOn ()
virtual void	LogModeOff ()
virtual int	GetLogMode ()
virtual int	IsImageUpToDate (const ImageDescriptor *desc=0)
virtual vtkImageData *	GetImage (ImageDescriptor *desc)
virtual vtkIntArray *	GetImageCoordinates (ImageDescriptor *desc)
virtual void	UpdateHistogram (vtkDataArray *scalars, int component, int reset_range)
virtual void	EstimateHistogramRangeAndNumberOfBins (vtkDataArray scalars, int component, double range[2], vtkIdType nb_of_bins)
virtual int	RefreshImage (ImageDescriptor *desc)

Detailed Description

an histogram

Events:: vtkCommand::StartEvent vtkCommand::ProgressEvent vtkCommand::EndEvent

Definition at line 34 of file vtkKWHistogram.h.

Member Typedef Documentation

typedef vtkObject vtkKWHistogram::Superclass

Reimplemented from vtkObject.

Definition at line 39 of file vtkKWHistogram.h.

Constructor & Destructor Documentation

vtkKWHistogram::vtkKWHistogram ( ) [protected]

vtkKWHistogram::~vtkKWHistogram ( ) [protected]

Member Function Documentation

static vtkKWHistogram* vtkKWHistogram::New ( ) [static]

Reimplemented from vtkObject.

virtual const char* vtkKWHistogram::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

static int vtkKWHistogram::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkObject.

virtual int vtkKWHistogram::IsA ( const char * type ) [virtual]

Reimplemented from vtkObject.

static vtkKWHistogram* vtkKWHistogram::SafeDownCast ( vtkObject * o ) [static]

void vtkKWHistogram::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Reimplemented from vtkObject.

virtual double* vtkKWHistogram::GetRange ( ) [virtual]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual void vtkKWHistogram::GetRange	(	double &	,
		double &
	)			`[virtual]`

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual void vtkKWHistogram::GetRange ( double [2] ) [virtual]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual vtkDoubleArray* vtkKWHistogram::GetBins ( ) [virtual]

Direct access to the bins

virtual vtkIdType vtkKWHistogram::GetNumberOfBins ( ) [virtual]

Get the number of bins

virtual void vtkKWHistogram::SetMaximumNumberOfBins ( vtkIdType ) [virtual]

Set/Get the maximum number of bins that should be used when creating the histogram

virtual vtkIdType vtkKWHistogram::GetMaximumNumberOfBins ( ) [virtual]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual double vtkKWHistogram::GetMinimumOccurence ( ) [virtual]

Get min, max, total occurence

virtual double vtkKWHistogram::GetMaximumOccurence ( ) [virtual]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual double vtkKWHistogram::GetTotalOccurence ( ) [virtual]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual double vtkKWHistogram::GetOccurenceAtValue ( double value ) [virtual]

Get the occurence for the bin holding a given value.

virtual double vtkKWHistogram::GetValueAtAccumulatedOccurence	(	double	acc,
		double *	exclude_value = `0`
	)			`[virtual]`

Get the value at a given accumulated occurence in the histogram. 'exclude_value' is not NULL, it is a pointer to a value which bin will be ignored from the computation.

virtual void vtkKWHistogram::BuildHistogram	(	vtkDataArray *	scalars,
		int	component
	)			`[virtual]`

Build/update the histogram from scalars (given a component) The Range and number of bins are modified automatically

virtual void vtkKWHistogram::SetRange	(	double	,
		double
	)			`[virtual]`

Set the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter. Nevertheless, you might want to set the Range manually, either after calling the BuildHistogram method to restrict the histogram to a subset, or before calling the AccumulateHistogram method, which accumulates values and update the histogram. Use the EstimateHistogramRange method to compute the range that is needed to store a set of scalars.

void vtkKWHistogram::SetRange ( double [2] )

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual void vtkKWHistogram::EstimateHistogramRange	(	vtkDataArray *	scalars,
		int	component,
		double	range[2]
	)			`[virtual]`

Estimate the range that will be used by BuildHistogram from scalars (given a component)

virtual void vtkKWHistogram::AccumulateHistogram	(	vtkDataArray *	scalars,
		int	component
	)			`[virtual]`

Accumulate the histogram from scalars (given a component) The Range is *not* modified automatically, you have to set it appropriately before calling this method using either: - a call to SetRange followed by a call to EmptyHistogram (use the EstimateHistogramRange method to compute the range that is needed to store a set of scalars)

or a call to BuildHistogram first, with the appropriate 'scalars'. This method can be called multiple times with a different 'scalars':
the 'scalars' range has to lie within the Range ivar. - the bins are not reset to 0, the values of 'scalars' are used to update the histogram with more data (accumulate) => EmptyHistogram will reset the histogram (remove all bins, forcing all bins to be set to 0 the next time the number of bins is changed).

virtual void vtkKWHistogram::EmptyHistogram ( ) [virtual]

Empty this histogram (0 bins). The next time the number of bins is changed (BuildHistogram or AccumulateHistogram), each bin is set to 0.

virtual void vtkKWHistogram::SetLogMode ( int ) [virtual]

Compute the image of the histogram in log space (default).

virtual void vtkKWHistogram::LogModeOn ( ) [virtual]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual void vtkKWHistogram::LogModeOff ( ) [virtual]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual int vtkKWHistogram::GetLogMode ( ) [virtual]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual void vtkKWHistogram::ComputeStatistics ( ) [protected, virtual]

virtual void vtkKWHistogram::UpdateHistogram	(	vtkDataArray *	scalars,
		int	component,
		int	reset_range
	)			`[protected, virtual]`

Update the histogram from scalars (given a component) Either reset the range (BuildHistogram) or not (AccumulateHistogram)

virtual void vtkKWHistogram::EstimateHistogramRangeAndNumberOfBins	(	vtkDataArray *	scalars,
		int	component,
		double	range[2],
		vtkIdType *	nb_of_bins
	)			`[protected, virtual]`

Estimate the range that will be used by BuildHistogram from scalars (given a component), and the number of bins

virtual int vtkKWHistogram::IsImageUpToDate ( const ImageDescriptor * desc = 0 ) [virtual]

Get an image of the histogram. The image parameters are described through an instance of the above ImageDescriptor. The histogram can be drawn for a given data range. If DrawBackground is false, the background pixels are set to be transparent and the resulting image is created in RGBA space instead of RGB. BTX

virtual vtkImageData* vtkKWHistogram::GetImage ( ImageDescriptor * desc ) [virtual]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual vtkIntArray* vtkKWHistogram::GetImageCoordinates ( ImageDescriptor * desc ) [virtual]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

virtual int vtkKWHistogram::RefreshImage ( ImageDescriptor * desc ) [protected, virtual]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

Member Data Documentation

double vtkKWHistogram::Range[2] [protected]

Definition at line 137 of file vtkKWHistogram.h.

vtkDoubleArray* vtkKWHistogram::Bins [protected]

Definition at line 139 of file vtkKWHistogram.h.

vtkImageData* vtkKWHistogram::Image [protected]

Definition at line 141 of file vtkKWHistogram.h.

vtkIntArray* vtkKWHistogram::ImageCoordinates [protected]

Definition at line 142 of file vtkKWHistogram.h.

unsigned long vtkKWHistogram::LastImageBuildTime [protected]

Definition at line 144 of file vtkKWHistogram.h.

unsigned long vtkKWHistogram::LastTransferFunctionTime [protected]

Definition at line 145 of file vtkKWHistogram.h.

int vtkKWHistogram::LogMode [protected]

Definition at line 146 of file vtkKWHistogram.h.

vtkIdType vtkKWHistogram::MaximumNumberOfBins [protected]

Definition at line 147 of file vtkKWHistogram.h.

unsigned long vtkKWHistogram::LastStatisticsBuildTime [protected]

Definition at line 150 of file vtkKWHistogram.h.

double vtkKWHistogram::MinimumOccurence [protected]

Definition at line 152 of file vtkKWHistogram.h.

double vtkKWHistogram::MaximumOccurence [protected]

Definition at line 153 of file vtkKWHistogram.h.

double vtkKWHistogram::TotalOccurence [protected]

Definition at line 154 of file vtkKWHistogram.h.

vtkKWHistogram::ImageDescriptor* vtkKWHistogram::LastImageDescriptor [protected]

Get the histogram range. Note that Range[1] is exclusive. The Range is updated automatically by the BuildHistogram method to match the range of the vtkDataArray passed as parameter.

Definition at line 250 of file vtkKWHistogram.h.

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

vtkKWHistogram.h

vtkKWHistogram Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation