vtkPVProminentValuesInformation Class Reference

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

#include <vtkPVProminentValuesInformation.h>

Inheritance diagram for vtkPVProminentValuesInformation:

Collaboration diagram for vtkPVProminentValuesInformation:

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) override
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 nullptr (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	SetSubsetAssemblyName (const char *)
	Set/get subset assembly's name. More...
virtual char *	GetSubsetAssemblyName ()
	Set/get subset assembly's name. More...
virtual void	SetSubsetSelector (const char *)
	Set/get subset selector's name. More...
virtual char *	GetSubsetSelector ()
	Set/get subset selector's name. 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	SetForce (bool)
	Set/get the force flag that will be used when recovering the prominents values. More...
virtual bool	GetForce ()
	Set/get the force flag that will be used when recovering the prominents values. More...
virtual bool	GetValid ()
	Get the validity of the information. More...
int	Compare (vtkPVProminentValuesInformation *info)
	Returns 1 if the array can be combined. More...
void	DeepCopy (vtkPVProminentValuesInformation *other)
	Copy information from an other object. More...
void	CopyFromObject (vtkObject *) override
	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...
void	AddInformation (vtkPVInformation *other) override
	Merge another information object. More...
void	CopyToStream (vtkClientServerStream *) override
	Manage a serialized version of the information. More...
void	CopyFromStream (const vtkClientServerStream *) override
	Set/get the force flag that will be used when recovering the prominents values. More...
void	CopyParametersToStream (vtkMultiProcessStream &) override
	Push/pop parameters controlling which array to sample onto/off of the stream. More...
void	CopyParametersFromStream (vtkMultiProcessStream &) override
	Push/pop parameters controlling which array to sample onto/off of the stream. More...
Public Member Functions inherited from vtkPVInformation
virtual int	GetRootOnly ()
	Set/get whether to gather information only from the root. More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPVProminentValuesInformation *	New ()
static int	IsTypeOf (const char *type)
static vtkPVProminentValuesInformation *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkPVInformation
static int	IsTypeOf (const char *type)
static vtkPVInformation *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVProminentValuesInformation ()
	~vtkPVProminentValuesInformation () override
void	DeepCopyParameters (vtkPVProminentValuesInformation *other)
void	CopyFromCompositeDataSet (vtkCompositeDataSet *)
void	CopyFromLeafDataObject (vtkDataObject *)
	vtkPVProminentValuesInformation (const vtkPVProminentValuesInformation &)=delete
void	operator= (const vtkPVProminentValuesInformation &)=delete
Protected Member Functions inherited from vtkPVInformation
	vtkPVInformation ()
	~vtkPVInformation () override
virtual void	SetRootOnly (int)
	vtkPVInformation (const vtkPVInformation &)=delete
void	operator= (const vtkPVInformation &)=delete
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	PortNumber
	Information parameters. More...
char *	SubsetAssemblyName
	Information parameters. More...
char *	SubsetSelector
	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...
bool	Force
	Information parameters. More...
bool	Valid
	Information parameters. More...
vtkInternalDistinctValues *	DistinctValues
Protected Attributes inherited from vtkPVInformation
int	RootOnly
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 32 of file vtkPVProminentValuesInformation.h.

Member Typedef Documentation

Superclass

typedef vtkPVInformation vtkPVProminentValuesInformation::Superclass

Definition at line 36 of file vtkPVProminentValuesInformation.h.

Constructor & Destructor Documentation

vtkPVProminentValuesInformation() [1/2]

vtkPVProminentValuesInformation::vtkPVProminentValuesInformation ( )

protected

~vtkPVProminentValuesInformation()

vtkPVProminentValuesInformation::~vtkPVProminentValuesInformation ( )

overrideprotected

vtkPVProminentValuesInformation() [2/2]

vtkPVProminentValuesInformation::vtkPVProminentValuesInformation ( const vtkPVProminentValuesInformation &  )

protecteddelete

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  )

overridevirtual

Reimplemented from vtkPVInformation.

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.

SetSubsetAssemblyName()

virtual void vtkPVProminentValuesInformation::SetSubsetAssemblyName ( const char *  )

virtual

Set/get subset assembly's name.

GetSubsetAssemblyName()

virtual char* vtkPVProminentValuesInformation::GetSubsetAssemblyName ( )

virtual

Set/get subset assembly's name.

SetSubsetSelector()

virtual void vtkPVProminentValuesInformation::SetSubsetSelector ( const char *  )

virtual

Set/get subset selector's name.

GetSubsetSelector()

virtual char* vtkPVProminentValuesInformation::GetSubsetSelector ( )

virtual

Set/get subset selector's name.

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.

SetForce()

virtual void vtkPVProminentValuesInformation::SetForce ( bool  )

virtual

Set/get the force flag that will be used when recovering the prominents values.

If not set, a maximum of vtkAbstractArray::MAX_DISCRETE_VALUES (32) values will be recovered, if there is more, none will be recovered and the information will be considered invalid. If the force flag is set, there is no maximum number of prominent values recovered and the information should be valid even with a high number of prominent values.

GetForce()

virtual bool vtkPVProminentValuesInformation::GetForce ( )

virtual

Set/get the force flag that will be used when recovering the prominents values.

If not set, a maximum of vtkAbstractArray::MAX_DISCRETE_VALUES (32) values will be recovered, if there is more, none will be recovered and the information will be considered invalid. If the force flag is set, there is no maximum number of prominent values recovered and the information should be valid even with a high number of prominent values.

GetValid()

virtual bool vtkPVProminentValuesInformation::GetValid ( )

virtual

Get the validity of the information.

The flag has a meaning after trying to recover prominent values, if true, the data can be used, if false, this information should be considered invalid.

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()

void vtkPVProminentValuesInformation::CopyFromObject ( vtkObject *  )

overridevirtual

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()

void vtkPVProminentValuesInformation::AddInformation ( vtkPVInformation *  other )

overridevirtual

Merge another information object.

Reimplemented from vtkPVInformation.

CopyToStream()

void vtkPVProminentValuesInformation::CopyToStream ( vtkClientServerStream *  )

overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

CopyFromStream()

void vtkPVProminentValuesInformation::CopyFromStream ( const vtkClientServerStream *  )

overridevirtual

Set/get the force flag that will be used when recovering the prominents values.

If not set, a maximum of vtkAbstractArray::MAX_DISCRETE_VALUES (32) values will be recovered, if there is more, none will be recovered and the information will be considered invalid. If the force flag is set, there is no maximum number of prominent values recovered and the information should be valid even with a high number of prominent values.

Reimplemented from vtkPVInformation.

CopyParametersToStream()

void vtkPVProminentValuesInformation::CopyParametersToStream ( vtkMultiProcessStream &  )

overridevirtual

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

Reimplemented from vtkPVInformation.

CopyParametersFromStream()

void vtkPVProminentValuesInformation::CopyParametersFromStream ( vtkMultiProcessStream &  )

overridevirtual

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 nullptr (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 &  )

protecteddelete

Member Data Documentation

PortNumber

int vtkPVProminentValuesInformation::PortNumber

protected

Information parameters.

Definition at line 212 of file vtkPVProminentValuesInformation.h.

SubsetAssemblyName

char* vtkPVProminentValuesInformation::SubsetAssemblyName

protected

Information parameters.

Definition at line 213 of file vtkPVProminentValuesInformation.h.

SubsetSelector

char* vtkPVProminentValuesInformation::SubsetSelector

protected

Information parameters.

Definition at line 214 of file vtkPVProminentValuesInformation.h.

NumberOfComponents

int vtkPVProminentValuesInformation::NumberOfComponents

protected

Information parameters.

Definition at line 215 of file vtkPVProminentValuesInformation.h.

FieldName

char* vtkPVProminentValuesInformation::FieldName

protected

Information parameters.

Definition at line 216 of file vtkPVProminentValuesInformation.h.

FieldAssociation

char* vtkPVProminentValuesInformation::FieldAssociation

protected

Information parameters.

Definition at line 217 of file vtkPVProminentValuesInformation.h.

Fraction

double vtkPVProminentValuesInformation::Fraction

protected

Information parameters.

Definition at line 218 of file vtkPVProminentValuesInformation.h.

Uncertainty

double vtkPVProminentValuesInformation::Uncertainty

protected

Information parameters.

Definition at line 219 of file vtkPVProminentValuesInformation.h.

Force

bool vtkPVProminentValuesInformation::Force

protected

Information parameters.

Definition at line 220 of file vtkPVProminentValuesInformation.h.

Valid

bool vtkPVProminentValuesInformation::Valid

protected

Information parameters.

Definition at line 221 of file vtkPVProminentValuesInformation.h.

DistinctValues

vtkInternalDistinctValues* vtkPVProminentValuesInformation::DistinctValues

protected

Definition at line 227 of file vtkPVProminentValuesInformation.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkPVProminentValuesInformation.h