vtkKWHistogramSet Class Reference

an histogram More...

#include <vtkKWHistogramSet.h>

List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkKWHistogramSet, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	AddHistogram (vtkKWHistogram *, const char *name)
virtual vtkKWHistogram *	AllocateAndAddHistogram (const char *name)
virtual int	GetNumberOfHistograms ()
virtual vtkKWHistogram *	GetHistogramWithName (const char *name)
virtual const char *	GetHistogramName (vtkKWHistogram *hist)
virtual vtkKWHistogram *	GetNthHistogram (int index)
virtual int	HasHistogramWithName (const char *name)
virtual int	HasHistogram (vtkKWHistogram *hist)
virtual int	RemoveHistogramWithName (const char *name)
virtual int	RemoveHistogram (vtkKWHistogram *hist)
virtual void	RemoveAllHistograms ()
virtual int	AddHistograms (vtkDataArray *array, const char *tag=NULL, int skip_components_mask=0)
Static Public Member Functions
vtkKWHistogramSet *	New ()
int	ComputeHistogramName (const char *array_name, int comp, const char *tag, char *buffer)
Protected Member Functions
	vtkKWHistogramSet ()
	~vtkKWHistogramSet ()
Protected Attributes
vtkKWHistogramSetInternals *	Internals

---

Detailed Description

an histogram

A set of histograms.

Definition at line 31 of file vtkKWHistogramSet.h.

---

Constructor & Destructor Documentation

vtkKWHistogramSet::vtkKWHistogramSet (   )  [protected]

vtkKWHistogramSet::~vtkKWHistogramSet (   )  [protected]

---

Member Function Documentation

vtkKWHistogramSet* vtkKWHistogramSet::New (   )  [static]

vtkKWHistogramSet::vtkTypeRevisionMacro (  vtkKWHistogramSet  , vtkObject  )

void vtkKWHistogramSet::PrintSelf (  ostream &  os, vtkIndent  indent )

virtual int vtkKWHistogramSet::AddHistogram (  vtkKWHistogram *  , const char *  name )  [virtual]

Add an histogram to the pool under a given name. Return 1 on success, 0 otherwise.

virtual vtkKWHistogram* vtkKWHistogramSet::AllocateAndAddHistogram (  const char *  name  )  [virtual]

Allocate an histogram and add it in the pool under a given name. Return a pointer to the new histogram on success, NULL otherwise.

virtual int vtkKWHistogramSet::GetNumberOfHistograms (   )  [virtual]

Get the number of histogram in the pool

virtual vtkKWHistogram* vtkKWHistogramSet::GetHistogramWithName (  const char *  name  )  [virtual]

Retrieve an histogram (or its name) from the pool.

virtual const char* vtkKWHistogramSet::GetHistogramName (  vtkKWHistogram *  hist  )  [virtual]

Retrieve an histogram (or its name) from the pool.

virtual vtkKWHistogram* vtkKWHistogramSet::GetNthHistogram (  int  index  )  [virtual]

Retrieve an histogram (or its name) from the pool.

virtual int vtkKWHistogramSet::HasHistogramWithName (  const char *  name  )  [virtual]

Query if the pool has a given histogram

virtual int vtkKWHistogramSet::HasHistogram (  vtkKWHistogram *  hist  )  [virtual]

Query if the pool has a given histogram

virtual int vtkKWHistogramSet::RemoveHistogramWithName (  const char *  name  )  [virtual]

Remove one or all histograms. Return 1 on success, 0 otherwise.

virtual int vtkKWHistogramSet::RemoveHistogram (  vtkKWHistogram *  hist  )  [virtual]

Remove one or all histograms. Return 1 on success, 0 otherwise.

virtual void vtkKWHistogramSet::RemoveAllHistograms (   )  [virtual]

Remove one or all histograms. Return 1 on success, 0 otherwise.

int vtkKWHistogramSet::ComputeHistogramName (  const char *  array_name, int  comp, const char *  tag, char *  buffer )  [static]

The histogram set class is designed to share histogram between several classes in an application. As such, since histogram are retrieved by names, it makes sense to follow some naming guidelines. This method provides such a guideline by computing an histogram name given the name of the array this histogram will be built upon, the component that will be used in that array, and an optional tag. The histogram name is stored in 'buffer', which should be large enough. Return 1 on success, 0 otherwise.

virtual int vtkKWHistogramSet::AddHistograms (  vtkDataArray *  array, const char *  tag = NULL, int  skip_components_mask = 0 )  [virtual]

Allocate, add and build histograms for all components of a scalar array. Each histogram name is built by calling ComputeHistogramName with the scalar array, component index and 'tag' arguments. The 'skip_components_mask' is a binary mask specifying which component should be skipped (i.e., if the n-th bit in that mask is set, then the histogram for that n-th component will not be considered) Return 1 on success, 0 otherwise.

---

Member Data Documentation

vtkKWHistogramSetInternals* vtkKWHistogramSet::Internals [protected]

Definition at line 101 of file vtkKWHistogramSet.h.

---

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

• GUI/Widgets/vtkKWHistogramSet.h

---