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

vtkStatisticsAlgorithm - Base class for statistics algorithms More...

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

List of all members.

Public Types

enum  InputPorts { INPUT_DATA = 0, INPUT_MODEL = 2, LEARN_PARAMETERS = 1 }
 Undocumented Block. More...
enum  OutputIndices { ASSESSMENT = 2, OUTPUT_DATA = 0, OUTPUT_MODEL = 1, OUTPUT_TEST = 2 }
 Undocumented Block. More...

Public Member Functions

 vtkStatisticsAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual void Aggregate (vtkDataObjectCollection arg0, vtkMultiBlockDataSet arg1)
 Given a collection of models, calculate aggregate model.
virtual vtkStringArray GetAssessNames ()
 Set/get assessment names.
virtual bool GetAssessOption ()
 Set/Get the Assess option.
virtual vtkStringArray GetAssessParameters ()
 Set/get assessment parameters.
virtual string GetColumnForRequest (int r, int c)
 Provide the name of the c-th column for the r-th request.
virtual bool GetDeriveOption ()
 Set/Get the Derive option.
virtual bool GetLearnOption ()
 Set/Get the Learn option.
virtual int GetNumberOfColumnsForRequest (int request)
 Return the number of columns for a given request.
virtual int GetNumberOfPrimaryTables ()
 Set/Get the number of tables in the primary model.
virtual int GetNumberOfRequests ()
 Return the number of requests. This does not include any request that is in the column-status buffer but for which RequestSelectedColumns() has not yet been called (even though it is possible this request will be honored when the filter is run -- see SetColumnStatus() for more information).
virtual bool GetTestOption ()
 Set/Get the Test option.
override int IsA (string type)
 Undocumented Block.
new vtkStatisticsAlgorithm NewInstance ()
 Undocumented Block.
virtual int RequestSelectedColumns ()
 Use the current column status values to produce a new request for statistics to be produced when RequestData() is called. See SetColumnStatus() for more information.
virtual void ResetAllColumnStates ()
 Set the the status of each and every column in the current request to OFF (0).
virtual void ResetRequests ()
 Empty the list of current requests.
virtual void SetAssessNames (vtkStringArray arg0)
 Set/get assessment names.
virtual void SetAssessOption (bool _arg)
 Set/Get the Assess option.
virtual void SetAssessParameters (vtkStringArray arg0)
 Set/get assessment parameters.
virtual void SetColumnStatus (string namCol, int status)
 Add or remove a column from the current analysis request. Once all the column status values are set, call RequestSelectedColumns() before selecting another set of columns for a different analysis request. The way that columns selections are used varies from algorithm to algorithm.
virtual void SetDeriveOption (bool _arg)
 Set/Get the Derive option.
virtual void SetInputModel (vtkDataObject model)
 A convenience method for setting the input model (if one is expected or allowed). It is equivalent to calling SetInput( 2, model );.
virtual void SetInputModelConnection (vtkAlgorithmOutput model)
 A convenience method for setting the input model connection (if one is expected or allowed). It is equivalent to calling SetInputConnection( 2, model );.
virtual void SetLearnOption (bool _arg)
 Set/Get the Learn option.
virtual void SetLearnOptionParameterConnection (vtkAlgorithmOutput arg0)
 A convenience method for setting learn input parameters (if one is expected or allowed). It is equivalent to calling SetInputConnection( 1, params );.
virtual void SetLearnOptionParameters (vtkDataObject arg0)
 A convenience method for setting learn input parameters (if one is expected or allowed). It is equivalent to calling SetInput( 1, params );.
virtual void SetNumberOfPrimaryTables (int _arg)
 Set/Get the number of tables in the primary model.
virtual void SetTestOption (bool _arg)
 Set/Get the Test option.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "22vtkStatisticsAlgorithm"
 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 vtkStatisticsAlgorithm_Aggregate_01 (HandleRef pThis, HandleRef arg0, HandleRef arg1)
static internal IntPtr vtkStatisticsAlgorithm_GetAssessNames_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkStatisticsAlgorithm_GetAssessOption_03 (HandleRef pThis)
static internal IntPtr vtkStatisticsAlgorithm_GetAssessParameters_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkStatisticsAlgorithm_GetColumnForRequest_05 (HandleRef pThis, int r, int c)
static internal byte vtkStatisticsAlgorithm_GetDeriveOption_06 (HandleRef pThis)
static internal byte vtkStatisticsAlgorithm_GetLearnOption_07 (HandleRef pThis)
static internal int vtkStatisticsAlgorithm_GetNumberOfColumnsForRequest_08 (HandleRef pThis, int request)
static internal int vtkStatisticsAlgorithm_GetNumberOfPrimaryTables_09 (HandleRef pThis)
static internal int vtkStatisticsAlgorithm_GetNumberOfRequests_10 (HandleRef pThis)
static internal byte vtkStatisticsAlgorithm_GetTestOption_11 (HandleRef pThis)
static internal int vtkStatisticsAlgorithm_IsA_12 (HandleRef pThis, string type)
static internal int vtkStatisticsAlgorithm_IsTypeOf_13 (string type)
static internal IntPtr vtkStatisticsAlgorithm_NewInstance_14 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkStatisticsAlgorithm_RequestSelectedColumns_15 (HandleRef pThis)
static internal void vtkStatisticsAlgorithm_ResetAllColumnStates_16 (HandleRef pThis)
static internal void vtkStatisticsAlgorithm_ResetRequests_17 (HandleRef pThis)
static internal IntPtr vtkStatisticsAlgorithm_SafeDownCast_18 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkStatisticsAlgorithm_SetAssessNames_19 (HandleRef pThis, HandleRef arg0)
static internal void vtkStatisticsAlgorithm_SetAssessOption_20 (HandleRef pThis, byte _arg)
static internal void vtkStatisticsAlgorithm_SetAssessParameters_21 (HandleRef pThis, HandleRef arg0)
static internal void vtkStatisticsAlgorithm_SetColumnStatus_22 (HandleRef pThis, string namCol, int status)
static internal void vtkStatisticsAlgorithm_SetDeriveOption_23 (HandleRef pThis, byte _arg)
static internal void vtkStatisticsAlgorithm_SetInputModel_24 (HandleRef pThis, HandleRef model)
static internal void vtkStatisticsAlgorithm_SetInputModelConnection_25 (HandleRef pThis, HandleRef model)
static internal void vtkStatisticsAlgorithm_SetLearnOption_26 (HandleRef pThis, byte _arg)
static internal void vtkStatisticsAlgorithm_SetLearnOptionParameterConnection_27 (HandleRef pThis, HandleRef arg0)
static internal void vtkStatisticsAlgorithm_SetLearnOptionParameters_28 (HandleRef pThis, HandleRef arg0)
static internal void vtkStatisticsAlgorithm_SetNumberOfPrimaryTables_29 (HandleRef pThis, int _arg)
static internal void vtkStatisticsAlgorithm_SetTestOption_30 (HandleRef pThis, byte _arg)

Static Private Member Functions

static vtkStatisticsAlgorithm ()
 Automatically generated type registration mechanics.

Detailed Description

vtkStatisticsAlgorithm - Base class for statistics algorithms

Description All statistics algorithms can conceptually be operated with several options: Learn: given an input data set, calculate a minimal statistical model (e.g., sums, raw moments, joint probabilities). Derive: given an input minimal statistical model, derive the full model (e.g., descriptive statistics, quantiles, correlations, conditional probabilities). NB: It may be, or not be, a problem that a full model was not derived. For instance, when doing parallel calculations, one only wants to derive the full model after all partial calculations have completed. On the other hand, one can also directly provide a full model, that was previously calculated or guessed, and not derive a new one. Assess: given an input data set, input statistics, and some form of threshold, assess a subset of the data set. Test: perform at least one statistical test. Therefore, a vtkStatisticsAlgorithm has the following vtkTable ports 3 input ports: Data (mandatory) Parameters to the learn phase (optional) Input model (optional) 3 output port (called Output): Data (annotated with assessments when the Assess option is ON). Output model (identical to the the input model when Learn option is OFF). Output of statistical tests. Some engines do not offer such tests yet, in which case this output will always be empty even when the Test option is ON.

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


Member Enumeration Documentation

Undocumented Block.

Enumerator:
INPUT_DATA 

enum member

INPUT_MODEL 

enum member

LEARN_PARAMETERS 

enum member

Undocumented Block.

Enumerator:
ASSESSMENT 

enum member

OUTPUT_DATA 

enum member

OUTPUT_MODEL 

enum member

OUTPUT_TEST 

enum member

Reimplemented in Kitware.VTK.vtkExtractHistogram2D, and Kitware.VTK.vtkPairwiseExtractHistogram2D.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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


Member Function Documentation

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

Set/get assessment names.

Here is the call graph for this function:

Set/Get the Assess option.

Set/get assessment parameters.

Here is the call graph for this function:

virtual string Kitware.VTK.vtkStatisticsAlgorithm.GetColumnForRequest ( int  r,
int  c 
) [virtual]

Provide the name of the c-th column for the r-th request.

For the version of this routine that returns an integer, if the request or column does not exist because r or c is out of bounds, this routine returns 0 and the value of columnName is unspecified. Otherwise, it returns 1 and the value of columnName is set.

For the version of this routine that returns const char*, if the request or column does not exist because r or c is out of bounds, the routine returns NULL. Otherwise it returns the column name. This version is not thread-safe.

Set/Get the Derive option.

Set/Get the Learn option.

Return the number of columns for a given request.

Set/Get the number of tables in the primary model.

Return the number of requests. This does not include any request that is in the column-status buffer but for which RequestSelectedColumns() has not yet been called (even though it is possible this request will be honored when the filter is run -- see SetColumnStatus() for more information).

Set/Get the Test option.

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

Use the current column status values to produce a new request for statistics to be produced when RequestData() is called. See SetColumnStatus() for more information.

Reimplemented in Kitware.VTK.vtkBivariateStatisticsAlgorithm, and Kitware.VTK.vtkUnivariateStatisticsAlgorithm.

Set the the status of each and every column in the current request to OFF (0).

Empty the list of current requests.

Set/get assessment names.

virtual void Kitware.VTK.vtkStatisticsAlgorithm.SetAssessOption ( bool  _arg) [virtual]

Set/Get the Assess option.

Set/get assessment parameters.

virtual void Kitware.VTK.vtkStatisticsAlgorithm.SetColumnStatus ( string  namCol,
int  status 
) [virtual]

Add or remove a column from the current analysis request. Once all the column status values are set, call RequestSelectedColumns() before selecting another set of columns for a different analysis request. The way that columns selections are used varies from algorithm to algorithm.

Note: the set of selected columns is maintained in vtkStatisticsAlgorithmPrivate::Buffer until RequestSelectedColumns() is called, at which point the set is appended to vtkStatisticsAlgorithmPrivate::Requests. If there are any columns in vtkStatisticsAlgorithmPrivate::Buffer at the time RequestData() is called, RequestSelectedColumns() will be called and the selection added to the list of requests.

virtual void Kitware.VTK.vtkStatisticsAlgorithm.SetDeriveOption ( bool  _arg) [virtual]

Set/Get the Derive option.

A convenience method for setting the input model (if one is expected or allowed). It is equivalent to calling SetInput( 2, model );.

A convenience method for setting the input model connection (if one is expected or allowed). It is equivalent to calling SetInputConnection( 2, model );.

virtual void Kitware.VTK.vtkStatisticsAlgorithm.SetLearnOption ( bool  _arg) [virtual]

Set/Get the Learn option.

A convenience method for setting learn input parameters (if one is expected or allowed). It is equivalent to calling SetInputConnection( 1, params );.

A convenience method for setting learn input parameters (if one is expected or allowed). It is equivalent to calling SetInput( 1, params );.

Set/Get the number of tables in the primary model.

virtual void Kitware.VTK.vtkStatisticsAlgorithm.SetTestOption ( bool  _arg) [virtual]

Set/Get the Test option.

static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_Aggregate_01 ( HandleRef  pThis,
HandleRef  arg0,
HandleRef  arg1 
) [private]
static internal IntPtr Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_GetAssessNames_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_GetAssessOption_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_GetAssessParameters_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_GetColumnForRequest_05 ( HandleRef  pThis,
int  r,
int  c 
) [private]
static internal byte Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_GetDeriveOption_06 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_GetLearnOption_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_GetNumberOfColumnsForRequest_08 ( HandleRef  pThis,
int  request 
) [private]
static internal byte Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_GetTestOption_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_IsA_12 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_IsTypeOf_13 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_NewInstance_14 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_ResetAllColumnStates_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_ResetRequests_17 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SafeDownCast_18 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetAssessNames_19 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetAssessOption_20 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetAssessParameters_21 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetColumnStatus_22 ( HandleRef  pThis,
string  namCol,
int  status 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetDeriveOption_23 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetInputModel_24 ( HandleRef  pThis,
HandleRef  model 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetInputModelConnection_25 ( HandleRef  pThis,
HandleRef  model 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetLearnOption_26 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetLearnOptionParameterConnection_27 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetLearnOptionParameters_28 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetNumberOfPrimaryTables_29 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkStatisticsAlgorithm.vtkStatisticsAlgorithm_SetTestOption_30 ( HandleRef  pThis,
byte  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkStatisticsAlgorithm.MRClassNameKey = "22vtkStatisticsAlgorithm" [static]
new const string Kitware.VTK.vtkStatisticsAlgorithm.MRFullTypeName = "Kitware.VTK.vtkStatisticsAlgorithm"

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