ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPSciVizDescriptiveStats Class Reference

Provide access to VTK descriptive statistics. More...

#include <vtkPSciVizDescriptiveStats.h>

Inheritance diagram for vtkPSciVizDescriptiveStats:
Inheritance graph
[legend]
Collaboration diagram for vtkPSciVizDescriptiveStats:
Collaboration graph
[legend]

Public Types

typedef vtkSciVizStatistics Superclass
 
- Public Types inherited from vtkSciVizStatistics
enum  Tasks { MODEL_INPUT, CREATE_MODEL, ASSESS_INPUT, MODEL_AND_ASSESS }
 Possible tasks the filter can perform. More...
 
typedef vtkTableAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetSignedDeviations (int)
 
virtual int GetSignedDeviations ()
 
- Public Member Functions inherited from vtkSciVizStatistics
int GetNumberOfAttributeArrays ()
 Return the number of columns available for the current value of AttributeMode. More...
 
const char * GetAttributeArrayName (int n)
 Get the name of the n-th array ffor the current value of AttributeMode. More...
 
int GetAttributeArrayStatus (const char *arrName)
 Get the status of the specified array (i.e., whether or not it is a column of interest). More...
 
vtkInformationIntegerKey * MULTIPLE_MODELS ()
 A key used to mark the output model data object (output port 0) when it is a multiblock of models (any of which may be multiblock dataset themselves) as opposed to a multiblock dataset containing a single model. More...
 
virtual int GetAttributeMode ()
 Set/get the type of field attribute (cell, point, field) More...
 
virtual void SetAttributeMode (int)
 Set/get the type of field attribute (cell, point, field) More...
 
void EnableAttributeArray (const char *arrName)
 An alternate interface for preparing a selection of arrays in ParaView. More...
 
void ClearAttributeArrays ()
 An alternate interface for preparing a selection of arrays in ParaView. More...
 
virtual void SetTrainingFraction (double)
 Set/get the amount of data to be used for training. More...
 
virtual double GetTrainingFraction ()
 Set/get the amount of data to be used for training. More...
 
virtual void SetTask (int)
 Set/get whether this filter should create a model of the input or assess the input or both. More...
 
virtual int GetTask ()
 Set/get whether this filter should create a model of the input or assess the input or both. More...
 

Static Public Member Functions

static vtkPSciVizDescriptiveStatsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPSciVizDescriptiveStatsSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSciVizStatistics
static int IsTypeOf (const char *type)
 
static vtkSciVizStatisticsSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPSciVizDescriptiveStats ()
 
virtual ~vtkPSciVizDescriptiveStats ()
 
virtual int LearnAndDerive (vtkMultiBlockDataSet *model, vtkTable *inData)
 Method subclasses must override to calculate a full model from the given input data. More...
 
virtual int AssessData (vtkTable *observations, vtkDataObject *dataset, vtkMultiBlockDataSet *model)
 Method subclasses must override to assess an input table given a model of the proper type. More...
 
- Protected Member Functions inherited from vtkSciVizStatistics
 vtkSciVizStatistics ()
 
virtual ~vtkSciVizStatistics ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **input, vtkInformationVector *output)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **input, vtkInformationVector *output)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **input, vtkInformationVector *output)
 
virtual int RequestData (vtkCompositeDataSet *compDataOu, vtkCompositeDataSet *compModelOu, vtkCompositeDataSet *compDataIn, vtkCompositeDataSet *compModelIn, vtkDataObject *singleModel)
 
virtual int RequestData (vtkDataObject *observationsOut, vtkDataObject *modelOut, vtkDataObject *observationsIn, vtkDataObject *modelIn)
 
virtual int PrepareFullDataTable (vtkTable *table, vtkFieldData *dataAttrIn)
 
virtual int PrepareTrainingTable (vtkTable *trainingTable, vtkTable *fullDataTable, vtkIdType numObservations)
 
virtual vtkIdType GetNumberOfObservationsForTraining (vtkTable *observations)
 Subclasses may (but need not) override this function to guarantee that some minimum number of observations are included in the training data. More...
 

Protected Attributes

int SignedDeviations
 
- Protected Attributes inherited from vtkSciVizStatistics
int AttributeMode
 
int Task
 
double TrainingFraction
 
vtkSciVizStatisticsPP
 

Detailed Description

Provide access to VTK descriptive statistics.

This filter provides access to the features of vtkDescriptiveStatistics. See VTK documentation for details

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

Definition at line 38 of file vtkPSciVizDescriptiveStats.h.

Member Typedef Documentation

§ Superclass

Definition at line 42 of file vtkPSciVizDescriptiveStats.h.

Constructor & Destructor Documentation

§ vtkPSciVizDescriptiveStats()

vtkPSciVizDescriptiveStats::vtkPSciVizDescriptiveStats ( )
protected

§ ~vtkPSciVizDescriptiveStats()

virtual vtkPSciVizDescriptiveStats::~vtkPSciVizDescriptiveStats ( )
protectedvirtual

Member Function Documentation

§ New()

static vtkPSciVizDescriptiveStats* vtkPSciVizDescriptiveStats::New ( )
static

§ GetClassName()

virtual const char* vtkPSciVizDescriptiveStats::GetClassName ( )
virtual

Reimplemented from vtkSciVizStatistics.

§ IsTypeOf()

static int vtkPSciVizDescriptiveStats::IsTypeOf ( const char *  type)
static

§ IsA()

virtual int vtkPSciVizDescriptiveStats::IsA ( const char *  type)
virtual

Reimplemented from vtkSciVizStatistics.

§ SafeDownCast()

static vtkPSciVizDescriptiveStats* vtkPSciVizDescriptiveStats::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

virtual void vtkPSciVizDescriptiveStats::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkSciVizStatistics.

§ SetSignedDeviations()

virtual void vtkPSciVizDescriptiveStats::SetSignedDeviations ( int  )
virtual

§ GetSignedDeviations()

virtual int vtkPSciVizDescriptiveStats::GetSignedDeviations ( )
virtual

§ LearnAndDerive()

virtual int vtkPSciVizDescriptiveStats::LearnAndDerive ( vtkMultiBlockDataSet *  model,
vtkTable *  inData 
)
protectedvirtual

Method subclasses must override to calculate a full model from the given input data.

The model should be placed on the first output port of the passed vtkInformationVector as well as returned in the model parameter.

Implements vtkSciVizStatistics.

§ AssessData()

virtual int vtkPSciVizDescriptiveStats::AssessData ( vtkTable *  observations,
vtkDataObject *  dataset,
vtkMultiBlockDataSet *  model 
)
protectedvirtual

Method subclasses must override to assess an input table given a model of the proper type.

The dataset parameter contains a shallow copy of input port 0 and should be modified to include the assessment.

Adding new arrays to point/cell/vertex/edge data should not pose a problem, but any alterations to the dataset itself will probably require that you create a deep copy before modification.

Parameters
observations- a table containing the field data of the dataset converted to a table
dataset- a shallow copy of the input dataset that should be altered to include an assessment of the output.
model- the statistical model with which to assess the observations.

Implements vtkSciVizStatistics.

Member Data Documentation

§ SignedDeviations

int vtkPSciVizDescriptiveStats::SignedDeviations
protected

Definition at line 56 of file vtkPSciVizDescriptiveStats.h.


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