vtkPOrderStatistics Class Reference

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

#include <vtkPOrderStatistics.h>

Inheritance diagram for vtkPOrderStatistics:

Collaboration diagram for vtkPOrderStatistics:

List of all members.

Public Types
typedef vtkOrderStatistics	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkPOrderStatistics *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetController (vtkMultiProcessController *)
virtual vtkMultiProcessController *	GetController ()
virtual void	Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *)
Static Public Member Functions
static vtkPOrderStatistics *	New ()
static int	IsTypeOf (const char *type)
static vtkPOrderStatistics *	SafeDownCast (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 Attributes
vtkMultiProcessController *	Controller

---

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

typedef vtkOrderStatistics vtkPOrderStatistics::Superclass

Reimplemented from vtkOrderStatistics.

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]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkOrderStatistics.

static int vtkPOrderStatistics::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkOrderStatistics.

virtual int vtkPOrderStatistics::IsA

(

const char *

name

)

[virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkOrderStatistics.

static vtkPOrderStatistics* vtkPOrderStatistics::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkOrderStatistics.

virtual vtkObjectBase* vtkPOrderStatistics::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkOrderStatistics.

vtkPOrderStatistics* vtkPOrderStatistics::NewInstance

(

)

const

Reimplemented from vtkOrderStatistics.

void vtkPOrderStatistics::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkOrderStatistics.

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:

• dox/Filters/ParallelStatistics/vtkPOrderStatistics.h