VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPOrderStatistics Class Reference

A class for parallel univariate order statistics. More...

#include <vtkPOrderStatistics.h>

Inheritance diagram for vtkPOrderStatistics:
[legend]
Collaboration diagram for vtkPOrderStatistics:
[legend]

Public Types

typedef vtkOrderStatistics Superclass
 
- Public Types inherited from vtkOrderStatistics
typedef vtkStatisticsAlgorithm Superclass
 
enum  QuantileDefinitionType { InverseCDF = 0, InverseCDFAveragedSteps = 1, NearestObservation = 2 }
 
- Public Types inherited from vtkStatisticsAlgorithm
typedef vtkTableAlgorithm Superclass
 
enum  InputPorts { INPUT_DATA = 0, LEARN_PARAMETERS = 1, INPUT_MODEL = 2 }
 
enum  OutputIndices { OUTPUT_DATA = 0, OUTPUT_MODEL = 1, ASSESSMENT = 2, OUTPUT_TEST = 2 }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkPOrderStatisticsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetController (vtkMultiProcessController *)
 
virtual vtkMultiProcessController * GetController ()
 
virtual void Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *)
 
- Public Member Functions inherited from vtkOrderStatistics
vtkOrderStatisticsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkIdType GetQuantileDefinition ()
 
virtual void SetNumberOfIntervals (vtkIdType)
 
virtual vtkIdType GetNumberOfIntervals ()
 
virtual void SetQuantileDefinition (QuantileDefinitionType)
 
void SetQuantileDefinition (int)
 
virtual void SetQuantize (bool)
 
virtual bool GetQuantize ()
 
virtual void SetMaximumHistogramSize (vtkIdType)
 
virtual vtkIdType GetMaximumHistogramSize ()
 
virtual bool SetParameter (const char *parameter, int index, vtkVariant value)
 
virtual void Aggregate (vtkDataObjectCollection *, vtkMultiBlockDataSet *)
 
- Public Member Functions inherited from vtkStatisticsAlgorithm
vtkStatisticsAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetColumnStatus (const char *namCol, int status)
 
virtual void ResetAllColumnStates ()
 
virtual int RequestSelectedColumns ()
 
virtual void ResetRequests ()
 
virtual vtkIdType GetNumberOfRequests ()
 
virtual vtkIdType GetNumberOfColumnsForRequest (vtkIdType request)
 
void AddColumn (const char *namCol)
 
void AddColumnPair (const char *namColX, const char *namColY)
 
virtual void SetLearnOptionParameterConnection (vtkAlgorithmOutput *params)
 
virtual void SetLearnOptionParameters (vtkDataObject *params)
 
virtual void SetInputModelConnection (vtkAlgorithmOutput *model)
 
virtual void SetInputModel (vtkDataObject *model)
 
virtual void SetLearnOption (bool)
 
virtual bool GetLearnOption ()
 
virtual void SetDeriveOption (bool)
 
virtual bool GetDeriveOption ()
 
virtual void SetAssessOption (bool)
 
virtual bool GetAssessOption ()
 
virtual void SetTestOption (bool)
 
virtual bool GetTestOption ()
 
virtual void SetNumberOfPrimaryTables (vtkIdType)
 
virtual vtkIdType GetNumberOfPrimaryTables ()
 
virtual void SetAssessNames (vtkStringArray *)
 
virtual vtkStringArray * GetAssessNames ()
 
virtual const char * GetColumnForRequest (vtkIdType r, vtkIdType c)
 
virtual int GetColumnForRequest (vtkIdType r, vtkIdType c, vtkStdString &columnName)
 

Static Public Member Functions

static vtkPOrderStatisticsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPOrderStatisticsSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOrderStatistics
static int IsTypeOf (const char *type)
 
static vtkOrderStatisticsSafeDownCast (vtkObjectBase *o)
 
static vtkOrderStatisticsNew ()
 
- Static Public Member Functions inherited from vtkStatisticsAlgorithm
static int IsTypeOf (const char *type)
 
static vtkStatisticsAlgorithmSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkPOrderStatistics ()
 
 ~vtkPOrderStatistics ()
 
bool Reduce (vtkIdTypeArray *, vtkDataArray *)
 
bool Reduce (vtkIdTypeArray *, vtkIdType &, char *, std::map< vtkStdString, vtkIdType > &)
 
bool Broadcast (std::map< vtkStdString, vtkIdType > &, vtkIdTypeArray *, vtkStringArray *, vtkIdType)
 
- Protected Member Functions inherited from vtkOrderStatistics
 vtkOrderStatistics ()
 
 ~vtkOrderStatistics ()
 
virtual void Derive (vtkMultiBlockDataSet *)
 
virtual void Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
 
virtual void Assess (vtkTable *inData, vtkMultiBlockDataSet *inMeta, vtkTable *outData)
 
virtual void SelectAssessFunctor (vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)
 
- Protected Member Functions inherited from vtkStatisticsAlgorithm
 vtkStatisticsAlgorithm ()
 
 ~vtkStatisticsAlgorithm ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *, int)
 

Protected Attributes

vtkMultiProcessController * Controller
 
- Protected Attributes inherited from vtkOrderStatistics
int NumberOfIntervals
 
QuantileDefinitionType QuantileDefinition
 
bool Quantize
 
vtkIdType MaximumHistogramSize
 
- Protected Attributes inherited from vtkStatisticsAlgorithm
int NumberOfPrimaryTables
 
bool LearnOption
 
bool DeriveOption
 
bool AssessOption
 
bool TestOption
 
vtkStringArray * AssessNames
 
vtkStatisticsAlgorithmPrivateInternals
 

Detailed Description

A class for parallel univariate order statistics.

vtkPOrderStatistics is vtkOrderStatistics subclass for parallel datasets. It learns and derives the global statistical model on each node, but assesses each individual data points on the node that owns it.

.NOTE: It is assumed that the keys in the histogram table be contained in the set {0,...,n-1} of successive integers, where n is the number of rows of the summary table. If this requirement is not fulfilled, then the outcome of the parallel update of order tables is unpredictable but will most likely be a crash. Note that this requirement is consistent with the way histogram tables are constructed by the (serial) superclass and thus, if you are using this class as it is intended to be ran, then you do not have to worry about this requirement.

Thanks:
Thanks to Philippe Pebay from Sandia National Laboratories for implementing this class.
Tests:
vtkPOrderStatistics (Tests)

Definition at line 56 of file vtkPOrderStatistics.h.

Member Typedef Documentation

Definition at line 60 of file vtkPOrderStatistics.h.

Constructor & Destructor Documentation

vtkPOrderStatistics::vtkPOrderStatistics ( )
protected
vtkPOrderStatistics::~vtkPOrderStatistics ( )
protected

Member Function Documentation

static vtkPOrderStatistics* vtkPOrderStatistics::New ( )
static
static int vtkPOrderStatistics::IsTypeOf ( const char *  type)
static
virtual int vtkPOrderStatistics::IsA ( const char *  type)
virtual

Reimplemented from vtkOrderStatistics.

static vtkPOrderStatistics* vtkPOrderStatistics::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkPOrderStatistics::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOrderStatistics.

vtkPOrderStatistics* vtkPOrderStatistics::NewInstance ( ) const
void vtkPOrderStatistics::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkPOrderStatistics::SetController ( vtkMultiProcessController *  )
virtual

Get/Set the multiprocess controller. If no controller is set, single process is assumed.

virtual vtkMultiProcessController* vtkPOrderStatistics::GetController ( )
virtual

Get/Set the multiprocess controller. If no controller is set, single process is assumed.

virtual void vtkPOrderStatistics::Learn ( vtkTable *  ,
vtkTable *  ,
vtkMultiBlockDataSet *   
)
virtual

Execute the parallel calculations required by the Learn option.

Reimplemented from vtkOrderStatistics.

bool vtkPOrderStatistics::Reduce ( vtkIdTypeArray *  ,
vtkDataArray *   
)
protected

Reduce the collection of local histograms to the global one for data inputs

bool vtkPOrderStatistics::Reduce ( vtkIdTypeArray *  ,
vtkIdType &  ,
char *  ,
std::map< vtkStdString, vtkIdType > &   
)
protected

Reduce the collection of local histograms to the global one for string inputs

bool vtkPOrderStatistics::Broadcast ( std::map< vtkStdString, vtkIdType > &  ,
vtkIdTypeArray *  ,
vtkStringArray *  ,
vtkIdType   
)
protected

Broadcast reduced histogram to all processes in the case of string inputs

Member Data Documentation

vtkMultiProcessController* vtkPOrderStatistics::Controller
protected

Definition at line 108 of file vtkPOrderStatistics.h.


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