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

Prominent values a data array takes on. More...

#include <vtkPVProminentValuesInformation.h>

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

Public Types

typedef vtkPVInformation Superclass
 
- Public Types inherited from vtkPVInformation
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int Compare (vtkPVProminentValuesInformation *info)
 Returns 1 if the array can be combined. More...
 
void DeepCopy (vtkPVProminentValuesInformation *other)
 Copy information from an other object. More...
 
virtual void CopyFromObject (vtkObject *)
 Transfer information about a single object into this object. More...
 
virtual void CopyDistinctValuesFromObject (vtkAbstractArray *)
 Transfer information about a single vtkAbstractArray's prominent values into this object. More...
 
virtual void AddInformation (vtkPVInformation *other)
 Merge another information object. More...
 
void InitializeParameters ()
 Remove all parameter information. More...
 
void Initialize ()
 Remove all gathered information (but not parameters). More...
 
void AddDistinctValues (vtkPVProminentValuesInformation *)
 Merge another list of prominent values. More...
 
vtkAbstractArray * GetProminentComponentValues (int component)
 Returns either NULL (array component appears to be continuous) or a pointer to a vtkAbstractArray (array component appears to be discrete) containing a sorted list of all distinct prominent values encountered in the array component. More...
 
virtual void SetPortNumber (int)
 Set/get the output port whose dataset should be queried. More...
 
virtual int GetPortNumber ()
 Set/get the output port whose dataset should be queried. More...
 
virtual void SetFieldAssociation (const char *)
 Set/get array's association. More...
 
virtual char * GetFieldAssociation ()
 Set/get array's association. More...
 
virtual void SetFieldName (const char *)
 Set/get array's name. More...
 
virtual char * GetFieldName ()
 Set/get array's name. More...
 
void SetNumberOfComponents (int numComps)
 Changing the number of components clears the ranges back to the default. More...
 
virtual int GetNumberOfComponents ()
 Changing the number of components clears the ranges back to the default. More...
 
virtual void SetFraction (double)
 Set/get the minimum fraction of the array that should be composed of a value (between 0 and 1) in order for it to be considered prominent. More...
 
virtual double GetFraction ()
 Set/get the minimum fraction of the array that should be composed of a value (between 0 and 1) in order for it to be considered prominent. More...
 
virtual void SetUncertainty (double)
 Set/get the maximum uncertainty allowed in the detection of prominent values. More...
 
virtual double GetUncertainty ()
 Set/get the maximum uncertainty allowed in the detection of prominent values. More...
 
virtual void CopyToStream (vtkClientServerStream *)
 Manage a serialized version of the information. More...
 
virtual void CopyFromStream (const vtkClientServerStream *)
 Manage a serialized version of the information. More...
 
virtual void CopyParametersToStream (vtkMultiProcessStream &)
 Push/pop parameters controlling which array to sample onto/off of the stream. More...
 
virtual void CopyParametersFromStream (vtkMultiProcessStream &)
 Push/pop parameters controlling which array to sample onto/off of the stream. More...
 
- Public Member Functions inherited from vtkPVInformation
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetRootOnly ()
 Set/get whether to gather information only from the root. More...
 

Static Public Member Functions

static vtkPVProminentValuesInformationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVProminentValuesInformationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVInformation
static int IsTypeOf (const char *type)
 
static vtkPVInformationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVProminentValuesInformation ()
 
 ~vtkPVProminentValuesInformation ()
 
void DeepCopyParameters (vtkPVProminentValuesInformation *other)
 
void CopyFromCompositeDataSet (vtkCompositeDataSet *)
 
void CopyFromLeafDataObject (vtkDataObject *)
 
 vtkPVProminentValuesInformation (const vtkPVProminentValuesInformation &) VTK_DELETE_FUNCTION
 
void operator= (const vtkPVProminentValuesInformation &) VTK_DELETE_FUNCTION
 
- Protected Member Functions inherited from vtkPVInformation
 vtkPVInformation ()
 
 ~vtkPVInformation ()
 
virtual void SetRootOnly (int)
 
 vtkPVInformation (const vtkPVInformation &) VTK_DELETE_FUNCTION
 
void operator= (const vtkPVInformation &) VTK_DELETE_FUNCTION
 

Protected Attributes

int PortNumber
 Information parameters. More...
 
int NumberOfComponents
 Information parameters. More...
 
char * FieldName
 Information parameters. More...
 
char * FieldAssociation
 Information parameters. More...
 
double Fraction
 Information parameters. More...
 
double Uncertainty
 Information parameters. More...
 
vtkInternalDistinctValues * DistinctValues
 
- Protected Attributes inherited from vtkPVInformation
int RootOnly
 

Detailed Description

Prominent values a data array takes on.

This vtkPVInformation subclass provides a way for clients to discover whether a specific remote vtkAbstractArray instance behaves like a discrete set or a continuum (for each component of its tuples as well as for its tuples as a whole).

If the array behaves discretely (which we define to be: takes on fewer than 33 distinct values over more than 99.9% of its entries to within a given confidence that dictates the number of samples required), then the prominent values are also made available.

This class uses vtkAbstractArray::GetProminentComponentValues().

Definition at line 45 of file vtkPVProminentValuesInformation.h.

Member Typedef Documentation

§ Superclass

Definition at line 50 of file vtkPVProminentValuesInformation.h.

Constructor & Destructor Documentation

§ vtkPVProminentValuesInformation() [1/2]

vtkPVProminentValuesInformation::vtkPVProminentValuesInformation ( )
protected

§ ~vtkPVProminentValuesInformation()

vtkPVProminentValuesInformation::~vtkPVProminentValuesInformation ( )
protected

§ vtkPVProminentValuesInformation() [2/2]

vtkPVProminentValuesInformation::vtkPVProminentValuesInformation ( const vtkPVProminentValuesInformation )
protected

Member Function Documentation

§ New()

static vtkPVProminentValuesInformation* vtkPVProminentValuesInformation::New ( )
static

§ GetClassName()

virtual const char* vtkPVProminentValuesInformation::GetClassName ( )
virtual

Reimplemented from vtkPVInformation.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkPVInformation.

§ SafeDownCast()

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

§ PrintSelf()

void vtkPVProminentValuesInformation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ SetPortNumber()

virtual void vtkPVProminentValuesInformation::SetPortNumber ( int  )
virtual

Set/get the output port whose dataset should be queried.

§ GetPortNumber()

virtual int vtkPVProminentValuesInformation::GetPortNumber ( )
virtual

Set/get the output port whose dataset should be queried.

§ SetFieldAssociation()

virtual void vtkPVProminentValuesInformation::SetFieldAssociation ( const char *  )
virtual

Set/get array's association.

§ GetFieldAssociation()

virtual char* vtkPVProminentValuesInformation::GetFieldAssociation ( )
virtual

Set/get array's association.

§ SetFieldName()

virtual void vtkPVProminentValuesInformation::SetFieldName ( const char *  )
virtual

Set/get array's name.

§ GetFieldName()

virtual char* vtkPVProminentValuesInformation::GetFieldName ( )
virtual

Set/get array's name.

§ SetNumberOfComponents()

void vtkPVProminentValuesInformation::SetNumberOfComponents ( int  numComps)

Changing the number of components clears the ranges back to the default.

§ GetNumberOfComponents()

virtual int vtkPVProminentValuesInformation::GetNumberOfComponents ( )
virtual

Changing the number of components clears the ranges back to the default.

§ SetFraction()

virtual void vtkPVProminentValuesInformation::SetFraction ( double  )
virtual

Set/get the minimum fraction of the array that should be composed of a value (between 0 and 1) in order for it to be considered prominent.

Setting this to one indicates that an array must have every value be identical in order to have any considered prominent.

§ GetFraction()

virtual double vtkPVProminentValuesInformation::GetFraction ( )
virtual

Set/get the minimum fraction of the array that should be composed of a value (between 0 and 1) in order for it to be considered prominent.

Setting this to one indicates that an array must have every value be identical in order to have any considered prominent.

§ SetUncertainty()

virtual void vtkPVProminentValuesInformation::SetUncertainty ( double  )
virtual

Set/get the maximum uncertainty allowed in the detection of prominent values.

The uncertainty is the probability of prominent values going undetected. Setting this to zero forces the entire array to be inspected.

§ GetUncertainty()

virtual double vtkPVProminentValuesInformation::GetUncertainty ( )
virtual

Set/get the maximum uncertainty allowed in the detection of prominent values.

The uncertainty is the probability of prominent values going undetected. Setting this to zero forces the entire array to be inspected.

§ Compare()

int vtkPVProminentValuesInformation::Compare ( vtkPVProminentValuesInformation info)

Returns 1 if the array can be combined.

It must have the same name and number of components.

§ DeepCopy()

void vtkPVProminentValuesInformation::DeepCopy ( vtkPVProminentValuesInformation other)

Copy information from an other object.

§ CopyFromObject()

virtual void vtkPVProminentValuesInformation::CopyFromObject ( vtkObject *  )
virtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

§ CopyDistinctValuesFromObject()

virtual void vtkPVProminentValuesInformation::CopyDistinctValuesFromObject ( vtkAbstractArray *  )
virtual

Transfer information about a single vtkAbstractArray's prominent values into this object.

This is called after CopyFromObject has determined the number of components available; this method relies on this->NumberOfComponents being valid.

§ AddInformation()

virtual void vtkPVProminentValuesInformation::AddInformation ( vtkPVInformation other)
virtual

Merge another information object.

Reimplemented from vtkPVInformation.

§ CopyToStream()

virtual void vtkPVProminentValuesInformation::CopyToStream ( vtkClientServerStream )
virtual

Manage a serialized version of the information.

Implements vtkPVInformation.

§ CopyFromStream()

virtual void vtkPVProminentValuesInformation::CopyFromStream ( const vtkClientServerStream )
virtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

§ CopyParametersToStream()

virtual void vtkPVProminentValuesInformation::CopyParametersToStream ( vtkMultiProcessStream &  )
virtual

Push/pop parameters controlling which array to sample onto/off of the stream.

Reimplemented from vtkPVInformation.

§ CopyParametersFromStream()

virtual void vtkPVProminentValuesInformation::CopyParametersFromStream ( vtkMultiProcessStream &  )
virtual

Push/pop parameters controlling which array to sample onto/off of the stream.

Reimplemented from vtkPVInformation.

§ InitializeParameters()

void vtkPVProminentValuesInformation::InitializeParameters ( )

Remove all parameter information.

You must copy/set parameter values before adding data or copying data from an object.

§ Initialize()

void vtkPVProminentValuesInformation::Initialize ( )

Remove all gathered information (but not parameters).

Next add will behave like a copy.

§ AddDistinctValues()

void vtkPVProminentValuesInformation::AddDistinctValues ( vtkPVProminentValuesInformation )

Merge another list of prominent values.

§ GetProminentComponentValues()

vtkAbstractArray* vtkPVProminentValuesInformation::GetProminentComponentValues ( int  component)

Returns either NULL (array component appears to be continuous) or a pointer to a vtkAbstractArray (array component appears to be discrete) containing a sorted list of all distinct prominent values encountered in the array component.

Passing -1 as the component will return information about distinct tuple values as opposed to distinct component values.

§ DeepCopyParameters()

void vtkPVProminentValuesInformation::DeepCopyParameters ( vtkPVProminentValuesInformation other)
protected

§ CopyFromCompositeDataSet()

void vtkPVProminentValuesInformation::CopyFromCompositeDataSet ( vtkCompositeDataSet *  )
protected

§ CopyFromLeafDataObject()

void vtkPVProminentValuesInformation::CopyFromLeafDataObject ( vtkDataObject *  )
protected

§ operator=()

void vtkPVProminentValuesInformation::operator= ( const vtkPVProminentValuesInformation )
protected

Member Data Documentation

§ PortNumber

int vtkPVProminentValuesInformation::PortNumber
protected

Information parameters.

Definition at line 190 of file vtkPVProminentValuesInformation.h.

§ NumberOfComponents

int vtkPVProminentValuesInformation::NumberOfComponents
protected

Information parameters.

Definition at line 191 of file vtkPVProminentValuesInformation.h.

§ FieldName

char* vtkPVProminentValuesInformation::FieldName
protected

Information parameters.

Definition at line 192 of file vtkPVProminentValuesInformation.h.

§ FieldAssociation

char* vtkPVProminentValuesInformation::FieldAssociation
protected

Information parameters.

Definition at line 193 of file vtkPVProminentValuesInformation.h.

§ Fraction

double vtkPVProminentValuesInformation::Fraction
protected

Information parameters.

Definition at line 194 of file vtkPVProminentValuesInformation.h.

§ Uncertainty

double vtkPVProminentValuesInformation::Uncertainty
protected

Information parameters.

Definition at line 195 of file vtkPVProminentValuesInformation.h.

§ DistinctValues

vtkInternalDistinctValues* vtkPVProminentValuesInformation::DistinctValues
protected

Definition at line 201 of file vtkPVProminentValuesInformation.h.


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