vtkDescriptiveStatistics Class Reference
#include <vtkDescriptiveStatistics.h>
Detailed Description
Private implementation for bivariate statistics algorithms.Private implementation for univariate statistics algorithms.
A class for univariate descriptive statistics.
The main purpose of this class is to avoid exposure of STL container through the APIs of the vtkStatistics classes APIs
- Thanks:
- Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
finalize is set to true (default), the final statistics are calculated with CalculateFromSums. Otherwise, only raw sums are output; this option is made for efficient parallel calculations. Note that CalculateFromSums is a static function, so that it can be used directly with no need to instantiate a vtkDescriptiveStatistics object. Assess: given an input data set in port 0, and a reference value x along with an acceptable deviation d>0, assess all entries in the data set which are outside of [x-d,x+d].
- Thanks:
- Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
Definition at line 55 of file vtkDescriptiveStatistics.h.
Public Types | |
| typedef vtkUnivariateStatisticsAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | SetNominalParameter (const char *name) |
| void | SetDeviationParameter (const char *name) |
| virtual void | SetSignedDeviations (int) |
| virtual int | GetSignedDeviations () |
| virtual void | SignedDeviationsOn () |
| virtual void | SignedDeviationsOff () |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkDescriptiveStatistics * | SafeDownCast (vtkObject *o) |
| static vtkDescriptiveStatistics * | New () |
Protected Member Functions | |
| vtkDescriptiveStatistics () | |
| ~vtkDescriptiveStatistics () | |
| virtual void | ExecuteDerive (vtkDataObject *) |
| virtual void | ExecuteLearn (vtkTable *inData, vtkDataObject *outMeta) |
| virtual void | SelectAssessFunctor (vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc) |
Protected Attributes | |
| int | SignedDeviations |
Member Typedef Documentation
Reimplemented from vtkUnivariateStatisticsAlgorithm.
Reimplemented in vtkPDescriptiveStatistics.
Definition at line 58 of file vtkDescriptiveStatistics.h.
Constructor & Destructor Documentation
| vtkDescriptiveStatistics::vtkDescriptiveStatistics | ( | ) | [protected] |
| vtkDescriptiveStatistics::~vtkDescriptiveStatistics | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkDescriptiveStatistics::GetClassName | ( | ) | [virtual] |
| static int vtkDescriptiveStatistics::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkUnivariateStatisticsAlgorithm.
Reimplemented in vtkPDescriptiveStatistics.
| virtual int vtkDescriptiveStatistics::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkUnivariateStatisticsAlgorithm.
Reimplemented in vtkPDescriptiveStatistics.
| static vtkDescriptiveStatistics* vtkDescriptiveStatistics::SafeDownCast | ( | vtkObject * | o | ) | [static] |
| void vtkDescriptiveStatistics::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkUnivariateStatisticsAlgorithm.
Reimplemented in vtkPDescriptiveStatistics.
| static vtkDescriptiveStatistics* vtkDescriptiveStatistics::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkTableAlgorithm.
Reimplemented in vtkPDescriptiveStatistics.
| virtual void vtkDescriptiveStatistics::SetSignedDeviations | ( | int | ) | [virtual] |
Set/get whether the deviations returned should be signed, or should only have their magnitude reported. The default is that signed deviations will be computed.
| virtual int vtkDescriptiveStatistics::GetSignedDeviations | ( | ) | [virtual] |
Set/get whether the deviations returned should be signed, or should only have their magnitude reported. The default is that signed deviations will be computed.
| virtual void vtkDescriptiveStatistics::SignedDeviationsOn | ( | ) | [virtual] |
Set/get whether the deviations returned should be signed, or should only have their magnitude reported. The default is that signed deviations will be computed.
| virtual void vtkDescriptiveStatistics::SignedDeviationsOff | ( | ) | [virtual] |
Set/get whether the deviations returned should be signed, or should only have their magnitude reported. The default is that signed deviations will be computed.
| void vtkDescriptiveStatistics::SetNominalParameter | ( | const char * | name | ) |
A convenience method (in particular for UI wrapping) to set the name of the column that contains the nominal value for the Assess option.
| void vtkDescriptiveStatistics::SetDeviationParameter | ( | const char * | name | ) |
A convenience method (in particular for UI wrapping) to set the name of the column that contains the deviation for the Assess option.
| virtual void vtkDescriptiveStatistics::ExecuteLearn | ( | vtkTable * | inData, | |
| vtkDataObject * | outMeta | |||
| ) | [protected, virtual] |
Execute the calculations required by the Learn option.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPDescriptiveStatistics.
| virtual void vtkDescriptiveStatistics::ExecuteDerive | ( | vtkDataObject * | ) | [protected, virtual] |
Execute the calculations required by the Derive option.
Implements vtkStatisticsAlgorithm.
| virtual void vtkDescriptiveStatistics::SelectAssessFunctor | ( | vtkTable * | outData, | |
| vtkDataObject * | inMeta, | |||
| vtkStringArray * | rowNames, | |||
| AssessFunctor *& | dfunc | |||
| ) | [protected, virtual] |
Provide the appropriate assessment functor.
Implements vtkStatisticsAlgorithm.
Member Data Documentation
int vtkDescriptiveStatistics::SignedDeviations [protected] |
Definition at line 92 of file vtkDescriptiveStatistics.h.
The documentation for this class was generated from the following file:
- dox/Infovis/vtkDescriptiveStatistics.h
