a set of histograms More...
#include <vtkKWHistogramSet.h>


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 int | AddHistogram (vtkKWHistogram *, const char *name) |
| virtual vtkKWHistogram * | AllocateAndAddHistogram (const char *name) |
| virtual int | GetNumberOfHistograms () |
Static Public Member Functions | |
| static vtkKWHistogramSet * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkKWHistogramSet * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkKWHistogramSet () | |
| ~vtkKWHistogramSet () | |
Protected Attributes | |
| vtkKWHistogramSetInternals * | Internals |
|
| |
| static int | ComputeHistogramName (const char *array_name, int comp, const char *tag, char *buffer) |
| 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) |
a set of histograms
A set of histograms.
Definition at line 31 of file vtkKWHistogramSet.h.
Reimplemented from vtkObject.
Definition at line 36 of file vtkKWHistogramSet.h.
| vtkKWHistogramSet::vtkKWHistogramSet | ( | ) | [protected] |
| vtkKWHistogramSet::~vtkKWHistogramSet | ( | ) | [protected] |
| static vtkKWHistogramSet* vtkKWHistogramSet::New | ( | ) | [static] |
Reimplemented from vtkObject.
| virtual const char* vtkKWHistogramSet::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
| static int vtkKWHistogramSet::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkObject.
| virtual int vtkKWHistogramSet::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkObject.
| static vtkKWHistogramSet* vtkKWHistogramSet::SafeDownCast | ( | vtkObject * | o | ) | [static] |
| void vtkKWHistogramSet::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Reimplemented from vtkObject.
| 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] |
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 vtkKWHistogram* vtkKWHistogramSet::GetNthHistogram | ( | int | index | ) | [virtual] |
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::HasHistogramWithName | ( | const char * | name | ) | [virtual] |
Query if the pool has a given histogram
| virtual int vtkKWHistogramSet::HasHistogram | ( | vtkKWHistogram * | hist | ) | [virtual] |
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::RemoveHistogramWithName | ( | const char * | name | ) | [virtual] |
Remove one or all histograms. Return 1 on success, 0 otherwise.
| virtual int vtkKWHistogramSet::RemoveHistogram | ( | vtkKWHistogram * | hist | ) | [virtual] |
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 void vtkKWHistogramSet::RemoveAllHistograms | ( | ) | [virtual] |
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.
| static 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.
vtkKWHistogramSetInternals* vtkKWHistogramSet::Internals [protected] |
Definition at line 104 of file vtkKWHistogramSet.h.
1.6.1