|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkKMeansStatistics * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
void | Aggregate (vtkDataObjectCollection *, vtkMultiBlockDataSet *) override |
| Given a collection of models, calculate aggregate model NB: not implemented.
|
|
bool | SetParameter (const char *parameter, int index, vtkVariant value) override |
| A convenience method for setting properties by name.
|
|
|
virtual void | SetDistanceFunctor (vtkKMeansDistanceFunctor *) |
| Set the DistanceFunctor.
|
|
virtual vtkKMeansDistanceFunctor * | GetDistanceFunctor () |
| Set the DistanceFunctor.
|
|
|
virtual void | SetDefaultNumberOfClusters (int) |
| Set/get the DefaultNumberOfClusters, used when no initial cluster coordinates are specified.
|
|
virtual int | GetDefaultNumberOfClusters () |
| Set/get the DefaultNumberOfClusters, used when no initial cluster coordinates are specified.
|
|
|
virtual void | SetKValuesArrayName (const char *) |
| Set/get the KValuesArrayName.
|
|
virtual char * | GetKValuesArrayName () |
| Set/get the KValuesArrayName.
|
|
|
virtual void | SetMaxNumIterations (int) |
| Set/get the MaxNumIterations used to terminate iterations on cluster center coordinates when the relative tolerance can not be met.
|
|
virtual int | GetMaxNumIterations () |
| Set/get the MaxNumIterations used to terminate iterations on cluster center coordinates when the relative tolerance can not be met.
|
|
|
virtual void | SetTolerance (double) |
| Set/get the relative Tolerance used to terminate iterations on cluster center coordinates.
|
|
virtual double | GetTolerance () |
| Set/get the relative Tolerance used to terminate iterations on cluster center coordinates.
|
|
|
virtual void | SetGhostsToSkip (unsigned char) |
| If there is a ghost array in the input, then ghosts matching GhostsToSkip mask will be skipped.
|
|
virtual unsigned char | GetGhostsToSkip () |
| If there is a ghost array in the input, then ghosts matching GhostsToSkip mask will be skipped.
|
|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkStatisticsAlgorithm * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | SetLearnOptionParameterConnection (vtkAlgorithmOutput *params) |
| A convenience method for setting learn input parameters (if one is expected or allowed).
|
|
virtual void | SetLearnOptionParameters (vtkDataObject *params) |
| A convenience method for setting learn input parameters (if one is expected or allowed).
|
|
virtual void | SetInputModelConnection (vtkAlgorithmOutput *model) |
| A convenience method for setting the input model connection (if one is expected or allowed).
|
|
virtual void | SetInputModel (vtkDataObject *model) |
| A convenience method for setting the input model (if one is expected or allowed).
|
|
virtual void | SetColumnStatus (const char *namCol, int status) |
| Add or remove a column from the current analysis request.
|
|
virtual void | ResetAllColumnStates () |
| Set the status of each and every column in the current request to OFF (0).
|
|
virtual int | RequestSelectedColumns () |
| Use the current column status values to produce a new request for statistics to be produced when RequestData() is called.
|
|
virtual void | ResetRequests () |
| Empty the list of current requests.
|
|
virtual vtkIdType | GetNumberOfRequests () |
| Return the number of requests.
|
|
virtual vtkIdType | GetNumberOfColumnsForRequest (vtkIdType request) |
| Return the number of columns for a given request.
|
|
virtual const char * | GetColumnForRequest (vtkIdType r, vtkIdType c) |
| Provide the name of the c-th column for the r-th request.
|
|
virtual int | GetColumnForRequest (vtkIdType r, vtkIdType c, vtkStdString &columnName) |
|
void | AddColumn (const char *namCol) |
| Convenience method to create a request with a single column name namCol in a single call; this is the preferred method to select columns, ensuring selection consistency (a single column per request).
|
|
void | AddColumnPair (const char *namColX, const char *namColY) |
| Convenience method to create a request with a single column name pair (namColX , namColY ) in a single call; this is the preferred method to select columns pairs, ensuring selection consistency (a pair of columns per request).
|
|
virtual bool | SetParameter (const char *parameter, int index, vtkVariant value) |
| A convenience method (in particular for access from other applications) to set parameter values of Learn mode.
|
|
virtual void | Aggregate (vtkDataObjectCollection *, vtkMultiBlockDataSet *)=0 |
| Given a collection of models, calculate aggregate model.
|
|
virtual void | SetLearnOption (bool) |
| Set/Get the Learn operation.
|
|
virtual bool | GetLearnOption () |
| Set/Get the Learn operation.
|
|
virtual void | SetDeriveOption (bool) |
| Set/Get the Derive operation.
|
|
virtual bool | GetDeriveOption () |
| Set/Get the Derive operation.
|
|
virtual void | SetAssessOption (bool) |
| Set/Get the Assess operation.
|
|
virtual bool | GetAssessOption () |
| Set/Get the Assess operation.
|
|
virtual void | SetTestOption (bool) |
| Set/Get the Test operation.
|
|
virtual bool | GetTestOption () |
| Set/Get the Test operation.
|
|
virtual void | SetNumberOfPrimaryTables (vtkIdType) |
| Set/Get the number of tables in the primary model.
|
|
virtual vtkIdType | GetNumberOfPrimaryTables () |
| Set/Get the number of tables in the primary model.
|
|
virtual void | SetAssessNames (vtkStringArray *) |
| Set/get assessment names.
|
|
virtual vtkStringArray * | GetAssessNames () |
| Set/get assessment names.
|
|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkTableAlgorithm * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
vtkTypeBool | ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override |
| see vtkAlgorithm for details
|
|
vtkTable * | GetOutput () |
| Get the output data object for a port on this algorithm.
|
|
vtkTable * | GetOutput (int index) |
|
void | SetInputData (vtkDataObject *obj) |
| Assign a data object as input.
|
|
void | SetInputData (int index, vtkDataObject *obj) |
|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkAlgorithm * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
vtkTypeBool | HasExecutive () |
| Check whether this algorithm has an assigned executive.
|
|
vtkExecutive * | GetExecutive () |
| Get this algorithm's executive.
|
|
virtual void | SetExecutive (vtkExecutive *executive) |
| Set this algorithm's executive.
|
|
virtual vtkTypeBool | ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) |
| Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
|
|
vtkTypeBool | ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo) |
| Version of ProcessRequest() that is wrapped.
|
|
virtual int | ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime) |
| A special version of ProcessRequest meant specifically for the pipeline modified time request.
|
|
virtual int | ModifyRequest (vtkInformation *request, int when) |
| This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
|
|
vtkInformation * | GetInputPortInformation (int port) |
| Get the information object associated with an input port.
|
|
vtkInformation * | GetOutputPortInformation (int port) |
| Get the information object associated with an output port.
|
|
int | GetNumberOfInputPorts () |
| Get the number of input ports used by the algorithm.
|
|
int | GetNumberOfOutputPorts () |
| Get the number of output ports provided by the algorithm.
|
|
void | SetAbortExecuteAndUpdateTime () |
| Set AbortExecute Flag and update LastAbortTime.
|
|
void | UpdateProgress (double amount) |
| Update the progress of the process object.
|
|
bool | CheckAbort () |
| Checks to see if this filter should abort.
|
|
virtual void | SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName) |
| String based versions of SetInputArrayToProcess().
|
|
vtkInformation * | GetInputArrayInformation (int idx) |
| Get the info object for the specified input array to this algorithm.
|
|
void | RemoveAllInputs () |
| Remove all the input data.
|
|
vtkDataObject * | GetOutputDataObject (int port) |
| Get the data object that will contain the algorithm output for the given port.
|
|
vtkDataObject * | GetInputDataObject (int port, int connection) |
| Get the data object that will contain the algorithm input for the given port and given connection.
|
|
virtual void | RemoveInputConnection (int port, vtkAlgorithmOutput *input) |
| Remove a connection from the given input port index.
|
|
virtual void | RemoveInputConnection (int port, int idx) |
| Remove a connection given by index idx.
|
|
virtual void | RemoveAllInputConnections (int port) |
| Removes all input connections.
|
|
virtual void | SetInputDataObject (int port, vtkDataObject *data) |
| Sets the data-object as an input on the given port index.
|
|
virtual void | SetInputDataObject (vtkDataObject *data) |
|
virtual void | AddInputDataObject (int port, vtkDataObject *data) |
| Add the data-object as an input to this given port.
|
|
virtual void | AddInputDataObject (vtkDataObject *data) |
|
vtkAlgorithmOutput * | GetOutputPort (int index) |
| Get a proxy object corresponding to the given output port of this algorithm.
|
|
vtkAlgorithmOutput * | GetOutputPort () |
|
int | GetNumberOfInputConnections (int port) |
| Get the number of inputs currently connected to a port.
|
|
int | GetTotalNumberOfInputConnections () |
| Get the total number of inputs for this algorithm.
|
|
vtkAlgorithmOutput * | GetInputConnection (int port, int index) |
| Get the algorithm output port connected to an input port.
|
|
vtkAlgorithm * | GetInputAlgorithm (int port, int index, int &algPort) |
| Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
|
|
vtkAlgorithm * | GetInputAlgorithm (int port, int index) |
| Returns the algorithm connected to a port-index pair.
|
|
vtkAlgorithm * | GetInputAlgorithm () |
| Equivalent to GetInputAlgorithm(0, 0).
|
|
vtkExecutive * | GetInputExecutive (int port, int index) |
| Returns the executive associated with a particular input connection.
|
|
vtkExecutive * | GetInputExecutive () |
| Equivalent to GetInputExecutive(0, 0)
|
|
vtkInformation * | GetInputInformation (int port, int index) |
| Return the information object that is associated with a particular input connection.
|
|
vtkInformation * | GetInputInformation () |
| Equivalent to GetInputInformation(0, 0)
|
|
vtkInformation * | GetOutputInformation (int port) |
| Return the information object that is associated with a particular output port.
|
|
virtual vtkTypeBool | Update (int port, vtkInformationVector *requests) |
| This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
|
|
virtual vtkTypeBool | Update (vtkInformation *requests) |
| Convenience method to update an algorithm after passing requests to its first output port.
|
|
virtual int | UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr) |
| Convenience method to update an algorithm after passing requests to its first output port.
|
|
virtual VTK_UNBLOCKTHREADS int | UpdateExtent (const int extents[6]) |
| Convenience method to update an algorithm after passing requests to its first output port.
|
|
virtual VTK_UNBLOCKTHREADS int | UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr) |
| Convenience method to update an algorithm after passing requests to its first output port.
|
|
virtual VTK_UNBLOCKTHREADS void | UpdateInformation () |
| Bring the algorithm's information up-to-date.
|
|
virtual void | UpdateDataObject () |
| Create output object(s).
|
|
virtual void | PropagateUpdateExtent () |
| Propagate meta-data upstream.
|
|
virtual VTK_UNBLOCKTHREADS void | UpdateWholeExtent () |
| Bring this algorithm's outputs up-to-date.
|
|
void | ConvertTotalInputToPortConnection (int ind, int &port, int &conn) |
| Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
|
|
void | RemoveNoPriorTemporalAccessInformationKey () |
| Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm .
|
|
virtual vtkInformation * | GetInformation () |
| Set/Get the information object associated with this algorithm.
|
|
virtual void | SetInformation (vtkInformation *) |
| Set/Get the information object associated with this algorithm.
|
|
bool | UsesGarbageCollector () const override |
| Participate in garbage collection.
|
|
virtual void | SetAbortExecute (vtkTypeBool) |
| Set/Get the AbortExecute flag for the process object.
|
|
virtual vtkTypeBool | GetAbortExecute () |
| Set/Get the AbortExecute flag for the process object.
|
|
virtual void | AbortExecuteOn () |
| Set/Get the AbortExecute flag for the process object.
|
|
virtual void | AbortExecuteOff () |
| Set/Get the AbortExecute flag for the process object.
|
|
virtual double | GetProgress () |
| Get the execution progress of a process object.
|
|
void | SetContainerAlgorithm (vtkAlgorithm *containerAlg) |
| Set/get a Container algorithm for this algorithm.
|
|
vtkAlgorithm * | GetContainerAlgorithm () |
| Set/get a Container algorithm for this algorithm.
|
|
virtual void | SetAbortOutput (bool) |
| Set/Get an internal variable used to communicate between the algorithm and executive.
|
|
virtual bool | GetAbortOutput () |
| Set/Get an internal variable used to communicate between the algorithm and executive.
|
|
void | SetProgressShiftScale (double shift, double scale) |
| Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
|
|
virtual double | GetProgressShift () |
| Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
|
|
virtual double | GetProgressScale () |
| Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
|
|
void | SetProgressText (const char *ptext) |
| Set the current text message associated with the progress state.
|
|
virtual char * | GetProgressText () |
| Set the current text message associated with the progress state.
|
|
virtual unsigned long | GetErrorCode () |
| The error code contains a possible error that occurred while reading or writing the file.
|
|
virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name) |
| Set the input data arrays that this algorithm will process.
|
|
virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) |
| Set the input data arrays that this algorithm will process.
|
|
virtual void | SetInputArrayToProcess (int idx, vtkInformation *info) |
| Set the input data arrays that this algorithm will process.
|
|
virtual void | SetInputConnection (int port, vtkAlgorithmOutput *input) |
| Set the connection for the given input port index.
|
|
virtual void | SetInputConnection (vtkAlgorithmOutput *input) |
| Set the connection for the given input port index.
|
|
virtual void | AddInputConnection (int port, vtkAlgorithmOutput *input) |
| Add a connection to the given input port index.
|
|
virtual void | AddInputConnection (vtkAlgorithmOutput *input) |
| Add a connection to the given input port index.
|
|
virtual VTK_UNBLOCKTHREADS void | Update (int port) |
| Bring this algorithm's outputs up-to-date.
|
|
virtual VTK_UNBLOCKTHREADS void | Update () |
| Bring this algorithm's outputs up-to-date.
|
|
virtual void | SetReleaseDataFlag (vtkTypeBool) |
| Turn release data flag on or off for all output ports.
|
|
virtual vtkTypeBool | GetReleaseDataFlag () |
| Turn release data flag on or off for all output ports.
|
|
void | ReleaseDataFlagOn () |
| Turn release data flag on or off for all output ports.
|
|
void | ReleaseDataFlagOff () |
| Turn release data flag on or off for all output ports.
|
|
int | UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output) |
| This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
|
|
int | UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType) |
| This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
|
|
int * | GetUpdateExtent () |
| These functions return the update extent for output ports that use 3D extents.
|
|
int * | GetUpdateExtent (int port) |
| These functions return the update extent for output ports that use 3D extents.
|
|
void | GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1) |
| These functions return the update extent for output ports that use 3D extents.
|
|
void | GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1) |
| These functions return the update extent for output ports that use 3D extents.
|
|
void | GetUpdateExtent (int extent[6]) |
| These functions return the update extent for output ports that use 3D extents.
|
|
void | GetUpdateExtent (int port, int extent[6]) |
| These functions return the update extent for output ports that use 3D extents.
|
|
int | GetUpdatePiece () |
| These functions return the update extent for output ports that use piece extents.
|
|
int | GetUpdatePiece (int port) |
| These functions return the update extent for output ports that use piece extents.
|
|
int | GetUpdateNumberOfPieces () |
| These functions return the update extent for output ports that use piece extents.
|
|
int | GetUpdateNumberOfPieces (int port) |
| These functions return the update extent for output ports that use piece extents.
|
|
int | GetUpdateGhostLevel () |
| These functions return the update extent for output ports that use piece extents.
|
|
int | GetUpdateGhostLevel (int port) |
| These functions return the update extent for output ports that use piece extents.
|
|
void | SetProgressObserver (vtkProgressObserver *) |
| If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
|
|
virtual vtkProgressObserver * | GetProgressObserver () |
| If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
|
|
void | SetNoPriorTemporalAccessInformationKey (int key) |
| Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() .
|
|
void | SetNoPriorTemporalAccessInformationKey () |
| Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() .
|
|
| 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.
|
|
virtual vtkMTimeType | GetMTime () |
| Return this object's modified time.
|
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
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.
|
|
const char * | GetClassName () const |
| Return the class name as a string.
|
|
virtual std::string | GetObjectDescription () const |
| The object description printed in messages and PrintSelf output.
|
|
virtual vtkTypeBool | IsA (const char *name) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
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 vtkObjectBase * | NewInstanceInternal () const |
|
| vtkKMeansStatistics () |
|
| ~vtkKMeansStatistics () override |
|
int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override |
| This is called by the superclass.
|
|
void | Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *) override |
| Execute the calculations required by the Learn option.
|
|
void | Derive (vtkMultiBlockDataSet *) override |
| Execute the calculations required by the Derive option.
|
|
void | Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override |
| Execute the calculations required by the Assess option.
|
|
void | Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override |
| Execute the calculations required by the Test option.
|
|
void | SelectAssessFunctor (vtkTable *inData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc) override |
| Provide the appropriate assessment functor.
|
|
virtual void | UpdateClusterCenters (vtkTable *newClusterElements, vtkTable *curClusterElements, vtkIdTypeArray *numMembershipChanges, vtkIdTypeArray *numDataElementsInCluster, vtkDoubleArray *error, vtkIdTypeArray *startRunID, vtkIdTypeArray *endRunID, vtkIntArray *computeRun) |
| Subroutine to update new cluster centers from the old centers.
|
|
virtual vtkIdType | GetTotalNumberOfObservations (vtkIdType numObservations) |
| Subroutine to get the total number of observations.
|
|
int | InitializeDataAndClusterCenters (vtkTable *inParameters, vtkTable *inData, vtkTable *dataElements, vtkIdTypeArray *numberOfClusters, vtkTable *curClusterElements, vtkTable *newClusterElements, vtkIdTypeArray *startRunID, vtkIdTypeArray *endRunID) |
| Subroutine to initialize the cluster centers using those provided by the user in input port LEARN_PARAMETERS.
|
|
virtual void | CreateInitialClusterCenters (vtkIdType numToAllocate, vtkIdTypeArray *numberOfClusters, vtkTable *inData, vtkTable *curClusterElements, vtkTable *newClusterElements) |
| Subroutine to initialize cluster centerss if not provided by the user.
|
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkStatisticsAlgorithm () |
|
| ~vtkStatisticsAlgorithm () override |
|
int | FillInputPortInformation (int port, vtkInformation *info) override |
| Fill the input port information objects for this algorithm.
|
|
int | FillOutputPortInformation (int port, vtkInformation *info) override |
| Fill the output port information objects for this algorithm.
|
|
int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override |
| This is called by the superclass.
|
|
virtual void | Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *)=0 |
| Execute the calculations required by the Learn option, given some input Data.
|
|
virtual void | Derive (vtkMultiBlockDataSet *)=0 |
| Execute the calculations required by the Derive option.
|
|
virtual void | Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)=0 |
| Execute the calculations required by the Assess option.
|
|
void | Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *, int) |
| A convenience implementation for generic assessment with variable number of variables.
|
|
virtual void | Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)=0 |
| Execute the calculations required by the Test option.
|
|
virtual void | SelectAssessFunctor (vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)=0 |
| A pure virtual method to select the appropriate assessment functor.
|
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkTableAlgorithm () |
|
| ~vtkTableAlgorithm () override |
|
virtual int | RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
|
virtual int | RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
| This is called by the superclass.
|
|
virtual int | RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
| This is called by the superclass.
|
|
virtual int | RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
|
int | FillOutputPortInformation (int port, vtkInformation *info) override |
| Fill the output port information objects for this algorithm.
|
|
int | FillInputPortInformation (int port, vtkInformation *info) override |
| Fill the input port information objects for this algorithm.
|
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkAlgorithm () |
|
| ~vtkAlgorithm () override |
|
bool | CheckUpstreamAbort () |
| Checks to see if an upstream filter has been aborted.
|
|
virtual int | FillInputPortInformation (int port, vtkInformation *info) |
| Fill the input port information objects for this algorithm.
|
|
virtual int | FillOutputPortInformation (int port, vtkInformation *info) |
| Fill the output port information objects for this algorithm.
|
|
virtual void | SetNumberOfInputPorts (int n) |
| Set the number of input ports used by the algorithm.
|
|
virtual void | SetNumberOfOutputPorts (int n) |
| Set the number of output ports provided by the algorithm.
|
|
int | InputPortIndexInRange (int index, const char *action) |
|
int | OutputPortIndexInRange (int index, const char *action) |
|
int | GetInputArrayAssociation (int idx, vtkInformationVector **inputVector) |
| Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
|
|
vtkInformation * | GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector) |
| This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
|
|
virtual vtkExecutive * | CreateDefaultExecutive () |
| Create a default executive.
|
|
void | ReportReferences (vtkGarbageCollector *) override |
|
virtual void | SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input) |
| Replace the Nth connection on the given input port.
|
|
virtual void | SetNumberOfInputConnections (int port, int n) |
| Set the number of input connections on the given input port.
|
|
void | SetInputDataInternal (int port, vtkDataObject *input) |
| These methods are used by subclasses to implement methods to set data objects directly as input.
|
|
void | AddInputDataInternal (int port, vtkDataObject *input) |
|
int | GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector) |
| Filters that have multiple connections on one port can use this signature.
|
|
int | GetInputArrayAssociation (int idx, vtkDataObject *input) |
| Filters that have multiple connections on one port can use this signature.
|
|
vtkDataArray * | GetInputArrayToProcess (int idx, vtkInformationVector **inputVector) |
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
|
|
vtkDataArray * | GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association) |
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
|
|
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector) |
| Filters that have multiple connections on one port can use this signature.
|
|
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association) |
| Filters that have multiple connections on one port can use this signature.
|
|
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input) |
| Filters that have multiple connections on one port can use this signature.
|
|
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input, int &association) |
| Filters that have multiple connections on one port can use this signature.
|
|
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector) |
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
|
|
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association) |
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
|
|
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector) |
| Filters that have multiple connections on one port can use this signature.
|
|
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association) |
| Filters that have multiple connections on one port can use this signature.
|
|
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input) |
| Filters that have multiple connections on one port can use this signature.
|
|
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association) |
| Filters that have multiple connections on one port can use this signature.
|
|
virtual void | SetErrorCode (unsigned long) |
| The error code contains a possible error that occurred while reading or writing the file.
|
|
| 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.
|
|
| vtkObjectBase () |
|
virtual | ~vtkObjectBase () |
|
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
|
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
|
virtual void | ReportReferences (vtkGarbageCollector *) |
|
virtual void | ObjectFinalize () |
|
| vtkObjectBase (const vtkObjectBase &) |
|
void | operator= (const vtkObjectBase &) |
|
A class for KMeans clustering.
This class takes as input an optional vtkTable on port LEARN_PARAMETERS specifying initial set(s) of cluster values of the following form:
K | Col1 | ... | ColN
-----------+-----------------+---------+---------------
M |clustCoord(1, 1) | ... | clustCoord(1, N)
M |clustCoord(2, 1) | ... | clustCoord(2, N)
. | . | . | .
. | . | . | .
. | . | . | .
M |clustCoord(M, 1) | ... | clustCoord(M, N)
L |clustCoord(1, 1) | ... | clustCoord(1, N)
L |clustCoord(2, 1) | ... | clustCoord(2, N)
. | . | . | .
. | . | . | .
. | . | . | .
L |clustCoord(L, 1) | ... | clustCoord(L, N)
Because the desired value of K is often not known in advance and the results of the algorithm are dependent on the initial cluster centers, we provide a mechanism for the user to test multiple runs or sets of cluster centers within a single call to the Learn phase. The first column of the table identifies the number of clusters K in the particular run (the entries in this column should be of type vtkIdType), while the remaining columns are a subset of the columns contained in the table on port INPUT_DATA. We require that all user specified clusters be of the same dimension N and consequently, that the LEARN_PARAMETERS table have N+1 columns. Due to this restriction, only one request can be processed for each call to the Learn phase and subsequent requests are silently ignored. Note that, if the first column of the LEARN_PARAMETERS table is not of type vtkIdType, then the table will be ignored and a single run will be performed using the first DefaultNumberOfClusters input data observations as initial cluster centers.
When the user does not supply an initial set of clusters, then the first DefaultNumberOfClusters input data observations are used as initial cluster centers and a single run is performed.
This class provides the following functionalities, depending on the operation in which it is executed:
- Learn: calculates new cluster centers for each run. The output metadata on port OUTPUT_MODEL is a multiblock dataset containing at a minimum one vtkTable with columns specifying the following for each run: the run ID, number of clusters, number of iterations required for convergence, total error associated with the cluster (sum of squared Euclidean distance from each observation to its nearest cluster center), the cardinality of the cluster, and the new cluster coordinates.
- Derive: An additional vtkTable is stored in the multiblock dataset output on port OUTPUT_MODEL. This table contains columns that store for each run: the runID, number of clusters, total error for all clusters in the run, local rank, and global rank. The local rank is computed by comparing squared Euclidean errors of all runs with the same number of clusters. The global rank is computed analagously across all runs.
- Assess: This requires a multiblock dataset (as computed from Learn and Derive) on input port INPUT_MODEL and tabular data on input port INPUT_DATA that contains column names matching those of the tables on input port INPUT_MODEL. The assess mode reports the closest cluster center and associated squared Euclidean distance of each observation in port INPUT_DATA's table to the cluster centers for each run in the multiblock dataset provided on port INPUT_MODEL.
The code can handle a wide variety of data types as it operates on vtkAbstractArrays and is not limited to vtkDataArrays. A default distance functor that computes the sum of the squares of the Euclidean distance between two objects is provided (vtkKMeansDistanceFunctor). The default distance functor can be overridden to use alternative distance metrics.
- Thanks:
- Thanks to Janine Bennett, David Thompson, and Philippe Pebay of Sandia National Laboratories for implementing this class. Updated by Philippe Pebay, Kitware SAS 2012
- Online Examples:
- Tests:
- vtkKMeansStatistics (Tests)
Definition at line 116 of file vtkKMeansStatistics.h.