ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkDescriptiveStatistics Class Reference

vtkDescriptiveStatistics - A class for univariate descriptive statistics More...

Inheritance diagram for Kitware.VTK.vtkDescriptiveStatistics:
[legend]
Collaboration diagram for Kitware.VTK.vtkDescriptiveStatistics:
[legend]

List of all members.

Public Member Functions

 vtkDescriptiveStatistics (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkDescriptiveStatistics ()
 Undocumented Block.
override void Aggregate (vtkDataObjectCollection arg0, vtkMultiBlockDataSet arg1)
 Given a collection of models, calculate aggregate model.
virtual void G1SkewnessOff ()
 Set/get whether the G1 estimator for the skewness should be used, or if the g1 skewness will be calculated. The default is that the g1 skewness estimator will be used.
virtual void G1SkewnessOn ()
 Set/get whether the G1 estimator for the skewness should be used, or if the g1 skewness will be calculated. The default is that the g1 skewness estimator will be used.
virtual void G2KurtosisOff ()
 Set/get whether the G2 estimator for the kurtosis should be used, or if the g2 kurtosis will be calculated. The default is that the g2 kurtosis estimator will be used.
virtual void G2KurtosisOn ()
 Set/get whether the G2 estimator for the kurtosis should be used, or if the g2 kurtosis will be calculated. The default is that the g2 kurtosis estimator will be used.
virtual int GetG1Skewness ()
 Set/get whether the G1 estimator for the skewness should be used, or if the g1 skewness will be calculated. The default is that the g1 skewness estimator will be used.
virtual int GetG2Kurtosis ()
 Set/get whether the G2 estimator for the kurtosis should be used, or if the g2 kurtosis will be calculated. The default is that the g2 kurtosis estimator will be used.
virtual int GetSignedDeviations ()
 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 GetUnbiasedVariance ()
 Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.
override int IsA (string type)
 Undocumented Block.
new vtkDescriptiveStatistics NewInstance ()
 Undocumented Block.
void SetDeviationParameter (string 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 SetG1Skewness (int _arg)
 Set/get whether the G1 estimator for the skewness should be used, or if the g1 skewness will be calculated. The default is that the g1 skewness estimator will be used.
virtual void SetG2Kurtosis (int _arg)
 Set/get whether the G2 estimator for the kurtosis should be used, or if the g2 kurtosis will be calculated. The default is that the g2 kurtosis estimator will be used.
void SetNominalParameter (string 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.
virtual void SetSignedDeviations (int _arg)
 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 SetUnbiasedVariance (int _arg)
 Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.
virtual void SignedDeviationsOff ()
 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 SignedDeviationsOn ()
 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 UnbiasedVarianceOff ()
 Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.
virtual void UnbiasedVarianceOn ()
 Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.

Static Public Member Functions

static new vtkDescriptiveStatistics New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkDescriptiveStatistics SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkDescriptiveStatistics"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "24vtkDescriptiveStatistics"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkDescriptiveStatistics_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkDescriptiveStatistics_Aggregate_01 (HandleRef pThis, HandleRef arg0, HandleRef arg1)
static internal void vtkDescriptiveStatistics_G1SkewnessOff_02 (HandleRef pThis)
static internal void vtkDescriptiveStatistics_G1SkewnessOn_03 (HandleRef pThis)
static internal void vtkDescriptiveStatistics_G2KurtosisOff_04 (HandleRef pThis)
static internal void vtkDescriptiveStatistics_G2KurtosisOn_05 (HandleRef pThis)
static internal int vtkDescriptiveStatistics_GetG1Skewness_06 (HandleRef pThis)
static internal int vtkDescriptiveStatistics_GetG2Kurtosis_07 (HandleRef pThis)
static internal int vtkDescriptiveStatistics_GetSignedDeviations_08 (HandleRef pThis)
static internal int vtkDescriptiveStatistics_GetUnbiasedVariance_09 (HandleRef pThis)
static internal int vtkDescriptiveStatistics_IsA_10 (HandleRef pThis, string type)
static internal int vtkDescriptiveStatistics_IsTypeOf_11 (string type)
static internal IntPtr vtkDescriptiveStatistics_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkDescriptiveStatistics_SafeDownCast_14 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkDescriptiveStatistics_SetDeviationParameter_15 (HandleRef pThis, string name)
static internal void vtkDescriptiveStatistics_SetG1Skewness_16 (HandleRef pThis, int _arg)
static internal void vtkDescriptiveStatistics_SetG2Kurtosis_17 (HandleRef pThis, int _arg)
static internal void vtkDescriptiveStatistics_SetNominalParameter_18 (HandleRef pThis, string name)
static internal void vtkDescriptiveStatistics_SetSignedDeviations_19 (HandleRef pThis, int _arg)
static internal void vtkDescriptiveStatistics_SetUnbiasedVariance_20 (HandleRef pThis, int _arg)
static internal void vtkDescriptiveStatistics_SignedDeviationsOff_21 (HandleRef pThis)
static internal void vtkDescriptiveStatistics_SignedDeviationsOn_22 (HandleRef pThis)
static internal void vtkDescriptiveStatistics_UnbiasedVarianceOff_23 (HandleRef pThis)
static internal void vtkDescriptiveStatistics_UnbiasedVarianceOn_24 (HandleRef pThis)

Static Private Member Functions

static vtkDescriptiveStatistics ()
 Automatically generated type registration mechanics.

Detailed Description

vtkDescriptiveStatistics - A class for univariate descriptive statistics

Description Given a selection of columns of interest in an input data table, this class provides the following functionalities, depending on the chosen execution options: Learn: calculate extremal values, sample mean, and M2, M3, and M4 aggregates (cf. P. Pebay, Formulas for robust, one-pass parallel computation of covariances and Arbitrary-Order Statistical Moments, Sandia Report SAND2008-6212, Sep 2008, http://infoserve.sandia.gov/sand_doc/2008/086212.pdf for details) Derive: calculate unbiased variance estimator, standard deviation estimator, two skewness estimators, and two kurtosis excess estimators. Assess: given an input data set, a reference value and a non-negative deviation, mark each datum with corresponding relative deviation (1-dimensional Mahlanobis distance). If the deviation is zero, then mark each datum which are equal to the reference value with 0, and all others with 1. By default, the reference value and the deviation are, respectively, the mean and the standard deviation of the input model. Test: calculate Jarque-Bera statistic and, if VTK to R interface is available, retrieve corresponding p-value for normality testing.

Thanks Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

Given a collection of models, calculate aggregate model.

Reimplemented from Kitware.VTK.vtkStatisticsAlgorithm.

override void Kitware.VTK.vtkDescriptiveStatistics.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkUnivariateStatisticsAlgorithm.

Reimplemented in Kitware.VTK.vtkPDescriptiveStatistics.

Set/get whether the G1 estimator for the skewness should be used, or if the g1 skewness will be calculated. The default is that the g1 skewness estimator will be used.

Set/get whether the G1 estimator for the skewness should be used, or if the g1 skewness will be calculated. The default is that the g1 skewness estimator will be used.

Set/get whether the G2 estimator for the kurtosis should be used, or if the g2 kurtosis will be calculated. The default is that the g2 kurtosis estimator will be used.

Set/get whether the G2 estimator for the kurtosis should be used, or if the g2 kurtosis will be calculated. The default is that the g2 kurtosis estimator will be used.

Set/get whether the G1 estimator for the skewness should be used, or if the g1 skewness will be calculated. The default is that the g1 skewness estimator will be used.

Set/get whether the G2 estimator for the kurtosis should be used, or if the g2 kurtosis will be calculated. The default is that the g2 kurtosis estimator will be used.

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.

Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.

override int Kitware.VTK.vtkDescriptiveStatistics.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkUnivariateStatisticsAlgorithm.

Reimplemented in Kitware.VTK.vtkPDescriptiveStatistics.

static new int Kitware.VTK.vtkDescriptiveStatistics.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkUnivariateStatisticsAlgorithm.

Reimplemented in Kitware.VTK.vtkPDescriptiveStatistics.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

Reimplemented in Kitware.VTK.vtkPDescriptiveStatistics.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkUnivariateStatisticsAlgorithm.

Reimplemented in Kitware.VTK.vtkPDescriptiveStatistics.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkUnivariateStatisticsAlgorithm.

Reimplemented in Kitware.VTK.vtkPDescriptiveStatistics.

Here is the call graph for this function:

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 Kitware.VTK.vtkDescriptiveStatistics.SetG1Skewness ( int  _arg) [virtual]

Set/get whether the G1 estimator for the skewness should be used, or if the g1 skewness will be calculated. The default is that the g1 skewness estimator will be used.

virtual void Kitware.VTK.vtkDescriptiveStatistics.SetG2Kurtosis ( int  _arg) [virtual]

Set/get whether the G2 estimator for the kurtosis should be used, or if the g2 kurtosis will be calculated. The default is that the g2 kurtosis estimator will be used.

A convenience method (in particular for UI wrapping) to set the name of the column that contains the nominal value for the Assess option.

virtual void Kitware.VTK.vtkDescriptiveStatistics.SetSignedDeviations ( int  _arg) [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 Kitware.VTK.vtkDescriptiveStatistics.SetUnbiasedVariance ( int  _arg) [virtual]

Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.

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.

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.

Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.

Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.

static internal void Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_Aggregate_01 ( HandleRef  pThis,
HandleRef  arg0,
HandleRef  arg1 
) [private]
static internal void Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_G1SkewnessOff_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_G1SkewnessOn_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_G2KurtosisOff_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_G2KurtosisOn_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_GetG1Skewness_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_GetG2Kurtosis_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_IsTypeOf_11 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_SafeDownCast_14 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_SetDeviationParameter_15 ( HandleRef  pThis,
string  name 
) [private]
static internal void Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_SetG1Skewness_16 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_SetG2Kurtosis_17 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_SetNominalParameter_18 ( HandleRef  pThis,
string  name 
) [private]
static internal void Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_SetSignedDeviations_19 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDescriptiveStatistics.vtkDescriptiveStatistics_SetUnbiasedVariance_20 ( HandleRef  pThis,
int  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkDescriptiveStatistics.MRClassNameKey = "24vtkDescriptiveStatistics" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkUnivariateStatisticsAlgorithm.

Reimplemented in Kitware.VTK.vtkPDescriptiveStatistics.

new const string Kitware.VTK.vtkDescriptiveStatistics.MRFullTypeName = "Kitware.VTK.vtkDescriptiveStatistics"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkUnivariateStatisticsAlgorithm.

Reimplemented in Kitware.VTK.vtkPDescriptiveStatistics.


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