a base class for statistical modeling of other data More...

#include <vtkStatisticalModel.h>

Inheritance diagram for vtkStatisticalModel:

Collaboration diagram for vtkStatisticalModel:

Public Types
enum	TableType { Learned = 0 , Derived = 1 , Test = 2 }
	The types of tables that a model may store. More...

typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
enum	FieldAssociations { FIELD_ASSOCIATION_POINTS , FIELD_ASSOCIATION_CELLS , FIELD_ASSOCIATION_NONE , FIELD_ASSOCIATION_POINTS_THEN_CELLS , FIELD_ASSOCIATION_VERTICES , FIELD_ASSOCIATION_EDGES , FIELD_ASSOCIATION_ROWS , NUMBER_OF_ASSOCIATIONS }
	Possible values for the FIELD_ASSOCIATION information entry. More...

enum	AttributeTypes { POINT , CELL , FIELD , POINT_THEN_CELL , VERTEX , EDGE , ROW , NUMBER_OF_ATTRIBUTE_TYPES }
	Possible attribute types. More...

enum	FieldOperations { FIELD_OPERATION_PRESERVED , FIELD_OPERATION_REINTERPOLATED , FIELD_OPERATION_MODIFIED , FIELD_OPERATION_REMOVED }
	Possible values for the FIELD_OPERATION information entry. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkStatisticalModel *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkMTimeType	GetMTime () override
	Models are composite objects and need to check each table for MTime.

void	Initialize () override
	Restore data object to initial state.

bool	IsEmpty ()
	Return true if the model is empty (i.e., has no tables).

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes).

int	GetDataObjectType () VTK_FUTURE_CONST override
	Return the type of data object.

int	GetNumberOfTables ()
	Get the number of tables across all types.

int	GetNumberOfTables (int type)
	Get the number of tables of the given type.

vtkTable *	GetTable (int type, int index)
	Get the specified table.

std::string	GetTableName (int type, int index)
	Get the name of the specified table (if any is set).

bool	SetNumberOfTables (int type, int number)
	Set the number of model tables of the given type.

bool	SetTable (int type, int index, vtkTable *table, const std::string &tableName)
	Set a specified table at the given type and index.

bool	SetTableName (int type, int index, const std::string &name)
	Set the name of the specified table (if the table exists).


void	ShallowCopy (vtkDataObject *src) override
	Shallow and Deep copy.

void	DeepCopy (vtkDataObject *src) override
	Shallow and Deep copy.


vtkTable *	FindTableByName (int type, const std::string &tableName)
	Find a table by its type and tableName.

vtkTable *	FindTableByName (int type, const std::string &tableName, int &index)
	Find a table by its type and tableName.


virtual void	SetAlgorithmParameters (const char *)
	Set/get a serialization of the statistical algorithm used to create the model tables in this instance.

virtual char *	GetAlgorithmParameters ()
	Set/get a serialization of the statistical algorithm used to create the model tables in this instance.

void	SetAlgorithmParameters (const std::string &algorithmParameters)
	Set/get a serialization of the statistical algorithm used to create the model tables in this instance.

Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () const

void	ReleaseData ()
	Release data back to system to conserve memory resource.

vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).

virtual void	CopyInformationFromPipeline (vtkInformation *info)
	Copy from the pipeline information to the data object's own information.

virtual void	CopyInformationToPipeline (vtkInformation *info)
	Copy information from this data object to the pipeline information.

void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data.

virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted.

virtual int	GetExtentType () VTK_FUTURE_CONST
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.

virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent.

virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type.

virtual vtkUnsignedCharArray *	GetGhostArray (int type)
	Returns the ghost arrays of the data object of the specified attribute type.

virtual bool	SupportsGhostArray (int type)
	Returns if this type of data object support ghost array for specified type.

virtual vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData.

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from.

virtual vtkIdType	GetNumberOfElements (int type)
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this data object.

virtual vtkTypeBool	GetDataReleased ()
	Get the flag indicating the data has been released.

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object.

virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object.

void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkStatisticalModel *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkStatisticalModel *	SafeDownCast (vtkObjectBase *o)

static const char *	GetTableTypeName (int tableType)
	Given a numeric value (a TableType enumerant), return a human-presentable string describing it.

static int	GetTableTypeValue (const std::string &tableType)
	Given a string value (a human-presentable enumerant), return a TableType enumerant integer matching it (or -1 if tableType is invalid).

static int	GetNumberOfTableTypes ()
	Get the number of table types.


static vtkStatisticalModel *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkStatisticalModel *	GetData (vtkInformationVector *vv, int ii=0)
	Retrieve an instance of this class from an information object.

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS)

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name.

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Remove the info associated with an array.

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)
	Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters.

static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e.

static int	GetAssociationTypeFromString (const char *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e.

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_COMPONENT ()
	If present, this key specifies an actual or virtual component of the array.

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	DIRECTION ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.

static void	SetGlobalReleaseDataFlag (vtkTypeBool val)
	Turn on/off flag to control whether every object releases its data after being used by a filter.

static vtkTypeBool	GetGlobalReleaseDataFlag ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Types
using	TableMap = std::map<int, std::vector<vtkSmartPointer<vtkTable>>>

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkStatisticalModel ()

	~vtkStatisticalModel () override

Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()

	~vtkDataObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
TableMap	ModelTables

char *	AlgorithmParameters { nullptr }

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

vtkTypeBool	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

a base class for statistical modeling of other data

vtkStatisticalModel is a subclass of vtkDataObject that holds vtkTables describing statistical models created by vtkStatisticsAlgorithm filters. It may hold any number of tables but each table will have one of the following roles: "learned", "derived", or "test" (the "assess" option of statistical algorithms does not store model data but rather applies it to samples). vtkStatisticalModel also provides methods to configure a vtkStatisticsAlgorithm instance with the same options used to create the model.

See also: vtkTable vtkStatisticsAlgorithm

Examples:: vtkStatisticalModel (Examples)

Tests:: vtkStatisticalModel (Tests)

Definition at line 40 of file vtkStatisticalModel.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObject vtkStatisticalModel::Superclass

Definition at line 44 of file vtkStatisticalModel.h.

◆ TableMap

using vtkStatisticalModel::TableMap = std::map<int, std::vector<vtkSmartPointer<vtkTable>>>

protected

Definition at line 207 of file vtkStatisticalModel.h.

Member Enumeration Documentation

◆ TableType

enum vtkStatisticalModel::TableType

The types of tables that a model may store.

Enumerator
Learned	Raw model data accumulated from samples.
Derived	Quantities dependent on learned data.
Test	Information summarizing a test of model fitness.

Definition at line 86 of file vtkStatisticalModel.h.

Constructor & Destructor Documentation

◆ vtkStatisticalModel()

vtkStatisticalModel::vtkStatisticalModel ( )

protected

◆ ~vtkStatisticalModel()

vtkStatisticalModel::~vtkStatisticalModel ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkStatisticalModel * vtkStatisticalModel::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkStatisticalModel::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkStatisticalModel::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 vtkDataObject.

◆ SafeDownCast()

static vtkStatisticalModel * vtkStatisticalModel::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkStatisticalModel::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObject.

◆ NewInstance()

vtkStatisticalModel * vtkStatisticalModel::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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 vtkDataObject.

◆ GetMTime()

vtkMTimeType vtkStatisticalModel::GetMTime ( )

overridevirtual

Models are composite objects and need to check each table for MTime.

Reimplemented from vtkDataObject.

◆ Initialize()

void vtkStatisticalModel::Initialize ( )

overridevirtual

Restore data object to initial state.

Reimplemented from vtkDataObject.

◆ IsEmpty()

bool vtkStatisticalModel::IsEmpty ( )

Return true if the model is empty (i.e., has no tables).

◆ GetActualMemorySize()

unsigned long vtkStatisticalModel::GetActualMemorySize ( )

overridevirtual

Return the actual size of the data in kibibytes (1024 bytes).

This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value). THIS METHOD IS THREAD SAFE.

Reimplemented from vtkDataObject.

◆ GetDataObjectType()

int vtkStatisticalModel::GetDataObjectType ( )

inlineoverridevirtual

Return the type of data object.

Reimplemented from vtkDataObject.

Definition at line 75 of file vtkStatisticalModel.h.

◆ ShallowCopy()

void vtkStatisticalModel::ShallowCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

◆ DeepCopy()

void vtkStatisticalModel::DeepCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

◆ GetTableTypeName()

static const char * vtkStatisticalModel::GetTableTypeName ( int tableType )

static

Given a numeric value (a TableType enumerant), return a human-presentable string describing it.

◆ GetTableTypeValue()

static int vtkStatisticalModel::GetTableTypeValue ( const std::string & tableType )

static

Given a string value (a human-presentable enumerant), return a TableType enumerant integer matching it (or -1 if tableType is invalid).

◆ GetData() [1/2]

static vtkStatisticalModel * vtkStatisticalModel::GetData ( vtkInformation * info )

static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

static vtkStatisticalModel * vtkStatisticalModel::GetData	(	vtkInformationVector *	vv,
		int	ii = 0 )

static

Retrieve an instance of this class from an information object.

◆ GetNumberOfTableTypes()

static int vtkStatisticalModel::GetNumberOfTableTypes ( )

inlinestatic

Get the number of table types.

This is the number of entries in the TableType enumeration. You may assume that the enumeration is sequential starting at 0.

Definition at line 118 of file vtkStatisticalModel.h.

◆ GetNumberOfTables() [1/2]

int vtkStatisticalModel::GetNumberOfTables ( )

Get the number of tables across all types.

◆ GetNumberOfTables() [2/2]

int vtkStatisticalModel::GetNumberOfTables ( int type )

Get the number of tables of the given type.

The type should be drawn from the TableType enumeration.

◆ GetTable()

vtkTable * vtkStatisticalModel::GetTable	(	int	type,
		int	index )

Get the specified table.

This may return null if index is out of range (see GetNumberOfTables()).

◆ GetTableName()

std::string vtkStatisticalModel::GetTableName	(	int	type,
		int	index )

Get the name of the specified table (if any is set).

◆ FindTableByName() [1/2]

vtkTable * vtkStatisticalModel::FindTableByName	(	int	type,
		const std::string &	tableName )

Find a table by its type and tableName.

If index is passed, the index of the first matching table will be set upon return.

◆ FindTableByName() [2/2]

vtkTable * vtkStatisticalModel::FindTableByName	(	int	type,
		const std::string &	tableName,
		int &	index )

Find a table by its type and tableName.

If index is passed, the index of the first matching table will be set upon return.

◆ SetNumberOfTables()

bool vtkStatisticalModel::SetNumberOfTables	(	int	type,
		int	number )

Set the number of model tables of the given type.

This method returns true if this instance of vtkStatisticalModel was modified.

◆ SetTable()

bool vtkStatisticalModel::SetTable	(	int	type,
		int	index,
		vtkTable *	table,
		const std::string &	tableName )

Set a specified table at the given type and index.

This method returns true if this instance of vtkStatisticalModel was modified.

◆ SetTableName()

bool vtkStatisticalModel::SetTableName	(	int	type,
		int	index,
		const std::string &	name )

Set the name of the specified table (if the table exists).

If no such table exists or the table's name matches name, this method will return false. If the table name was changed, it returns true.

◆ SetAlgorithmParameters() [1/2]

virtual void vtkStatisticalModel::SetAlgorithmParameters ( const char * )

virtual

Set/get a serialization of the statistical algorithm used to create the model tables in this instance.

This can be used to recreate a subclass of vtkStatisticsAlgorithm for further analysis (such as assessment or testing).

This method returns true if this instance of vtkStatisticalModel was modified.

◆ GetAlgorithmParameters()

virtual char * vtkStatisticalModel::GetAlgorithmParameters ( )

virtual

Set/get a serialization of the statistical algorithm used to create the model tables in this instance.

This can be used to recreate a subclass of vtkStatisticsAlgorithm for further analysis (such as assessment or testing).

This method returns true if this instance of vtkStatisticalModel was modified.

◆ SetAlgorithmParameters() [2/2]

void vtkStatisticalModel::SetAlgorithmParameters ( const std::string & algorithmParameters )

inline

Set/get a serialization of the statistical algorithm used to create the model tables in this instance.

This can be used to recreate a subclass of vtkStatisticsAlgorithm for further analysis (such as assessment or testing).

This method returns true if this instance of vtkStatisticalModel was modified.

Definition at line 189 of file vtkStatisticalModel.h.

Member Data Documentation

◆ ModelTables

TableMap vtkStatisticalModel::ModelTables

protected

Definition at line 208 of file vtkStatisticalModel.h.

◆ AlgorithmParameters

char* vtkStatisticalModel::AlgorithmParameters { nullptr }

protected

Definition at line 210 of file vtkStatisticalModel.h.

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

Common/DataModel/vtkStatisticalModel.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

◆ TableMap

Member Enumeration Documentation

◆ TableType

Constructor & Destructor Documentation

◆ vtkStatisticalModel()

◆ ~vtkStatisticalModel()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetMTime()

◆ Initialize()

◆ IsEmpty()

◆ GetActualMemorySize()

◆ GetDataObjectType()

◆ ShallowCopy()

◆ DeepCopy()

◆ GetTableTypeName()

◆ GetTableTypeValue()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetNumberOfTableTypes()

◆ GetNumberOfTables() [1/2]

◆ GetNumberOfTables() [2/2]

◆ GetTable()

◆ GetTableName()

◆ FindTableByName() [1/2]

◆ FindTableByName() [2/2]

◆ SetNumberOfTables()

◆ SetTable()

◆ SetTableName()

◆ SetAlgorithmParameters() [1/2]

◆ GetAlgorithmParameters()

◆ SetAlgorithmParameters() [2/2]

Member Data Documentation

◆ ModelTables

◆ AlgorithmParameters