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.vtkBivariateStatisticsAlgorithm Class Reference

vtkBivariateStatistics - Base class for bivariate statistics algorithms More...

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

List of all members.

Public Member Functions

 vtkBivariateStatisticsAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
void AddColumnPair (string namColX, string namColY)
 Convenience method to create a request with a single column name pair (namColX, namColY) in a single call; this is the preferred method to select columns pairs, ensuring selection consistency (a pair of columns per request).
override int IsA (string type)
 Undocumented Block.
new vtkBivariateStatisticsAlgorithm NewInstance ()
 Undocumented Block.
override int RequestSelectedColumns ()
 Use the current column status values to produce a new request for statistics to be produced when RequestData() is called. Unlike the superclass implementation, this version adds a new request for every possible pairing of the selected columns instead of a single request containing all the columns.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "31vtkBivariateStatisticsAlgorithm"
 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 void vtkBivariateStatisticsAlgorithm_AddColumnPair_01 (HandleRef pThis, string namColX, string namColY)
static internal int vtkBivariateStatisticsAlgorithm_IsA_02 (HandleRef pThis, string type)
static internal int vtkBivariateStatisticsAlgorithm_IsTypeOf_03 (string type)
static internal IntPtr vtkBivariateStatisticsAlgorithm_NewInstance_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkBivariateStatisticsAlgorithm_RequestSelectedColumns_05 (HandleRef pThis)
static internal IntPtr vtkBivariateStatisticsAlgorithm_SafeDownCast_06 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)

Static Private Member Functions

static vtkBivariateStatisticsAlgorithm ()
 Automatically generated type registration mechanics.

Detailed Description

vtkBivariateStatistics - Base class for bivariate statistics algorithms

Description This class specializes statistics algorithms to the bivariate case, where a number of pairs of columns of interest can be selected in the input data set. This is done by the means of the following functions:

ResetColumns() - reset the list of columns of interest. Add/RemoveColum( namColX, namColY ) - try to add/remove column pair ( namColX, namColy ) to/from the list. SetColumnStatus ( namCol, status ) - mostly for UI wrapping purposes, try to add/remove (depending on status) namCol from a list of buffered columns, from which all possible pairs are generated. The verb "try" is used in the sense that neither attempting to repeat an existing entry nor to remove a non-existent entry will work.

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.vtkBivariateStatisticsAlgorithm.vtkBivariateStatisticsAlgorithm ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

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


Member Function Documentation

void Kitware.VTK.vtkBivariateStatisticsAlgorithm.AddColumnPair ( string  namColX,
string  namColY 
)

Convenience method to create a request with a single column name pair (namColX, namColY) in a single call; this is the preferred method to select columns pairs, ensuring selection consistency (a pair of columns per request).

Unlike SetColumnStatus(), you need not call RequestSelectedColumns() after AddColumnPair().

Warning: namColX and namColY are only checked for their validity as strings; no check is made that either are valid column names.

override void Kitware.VTK.vtkBivariateStatisticsAlgorithm.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.vtkStatisticsAlgorithm.

Reimplemented in Kitware.VTK.vtkExtractHistogram2D, Kitware.VTK.vtkCorrelativeStatistics, Kitware.VTK.vtkPExtractHistogram2D, Kitware.VTK.vtkContingencyStatistics, Kitware.VTK.vtkPContingencyStatistics, and Kitware.VTK.vtkPCorrelativeStatistics.

override int Kitware.VTK.vtkBivariateStatisticsAlgorithm.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtkBivariateStatisticsAlgorithm.IsTypeOf ( string  type) [static]

Use the current column status values to produce a new request for statistics to be produced when RequestData() is called. Unlike the superclass implementation, this version adds a new request for every possible pairing of the selected columns instead of a single request containing all the columns.

Reimplemented from Kitware.VTK.vtkStatisticsAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkStatisticsAlgorithm.

Reimplemented in Kitware.VTK.vtkExtractHistogram2D, Kitware.VTK.vtkPContingencyStatistics, Kitware.VTK.vtkPCorrelativeStatistics, Kitware.VTK.vtkPExtractHistogram2D, Kitware.VTK.vtkCorrelativeStatistics, and Kitware.VTK.vtkContingencyStatistics.

Here is the call graph for this function:

static internal void Kitware.VTK.vtkBivariateStatisticsAlgorithm.vtkBivariateStatisticsAlgorithm_AddColumnPair_01 ( HandleRef  pThis,
string  namColX,
string  namColY 
) [private]
static internal int Kitware.VTK.vtkBivariateStatisticsAlgorithm.vtkBivariateStatisticsAlgorithm_IsA_02 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkBivariateStatisticsAlgorithm.vtkBivariateStatisticsAlgorithm_NewInstance_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkBivariateStatisticsAlgorithm.vtkBivariateStatisticsAlgorithm_SafeDownCast_06 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkBivariateStatisticsAlgorithm.MRClassNameKey = "31vtkBivariateStatisticsAlgorithm" [static]
new const string Kitware.VTK.vtkBivariateStatisticsAlgorithm.MRFullTypeName = "Kitware.VTK.vtkBivariateStatisticsAlgorithm"

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