ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkDotProductSimilarity Class Reference

vtkDotProductSimilarity - compute dot-product similarity metrics. More...

Inheritance diagram for Kitware.VTK.vtkDotProductSimilarity:
[legend]
Collaboration diagram for Kitware.VTK.vtkDotProductSimilarity:
[legend]

List of all members.

Public Member Functions

 vtkDotProductSimilarity (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkDotProductSimilarity ()
 Undocumented Block.
virtual int GetDiagonal ()
 When computing similarities for a single input matrix, controls whether the results will include the diagonal of the similarity matrix. Default: false.
virtual int GetFirstSecond ()
 When computing similarities for two input matrices, controls whether the results will include comparisons from the first matrix to the second matrix.
virtual int GetLowerDiagonal ()
 When computing similarities for a single input matrix, controls whether the results will include the lower diagonal of the similarity matrix. Default: false.
virtual int GetMaximumCount ()
 Specifies a maximum number of edges to include for each vector.
virtual int GetMinimumCount ()
 Specifies a minimum number of edges to include for each vector.
virtual double GetMinimumThreshold ()
 Specifies a minimum threshold that a similarity must exceed to be included in the output.
virtual int GetSecondFirst ()
 When computing similarities for two input matrices, controls whether the results will include comparisons from the second matrix to the first matrix.
virtual int GetUpperDiagonal ()
 When computing similarities for a single input matrix, controls whether the results will include the upper diagonal of the similarity matrix. Default: true.
virtual int GetVectorDimension ()
 Controls whether to compute similarities for row-vectors or column-vectors. 0 = rows, 1 = columns.
override int IsA (string type)
 Undocumented Block.
new vtkDotProductSimilarity NewInstance ()
 Undocumented Block.
virtual void SetDiagonal (int _arg)
 When computing similarities for a single input matrix, controls whether the results will include the diagonal of the similarity matrix. Default: false.
virtual void SetFirstSecond (int _arg)
 When computing similarities for two input matrices, controls whether the results will include comparisons from the first matrix to the second matrix.
virtual void SetLowerDiagonal (int _arg)
 When computing similarities for a single input matrix, controls whether the results will include the lower diagonal of the similarity matrix. Default: false.
virtual void SetMaximumCount (int _arg)
 Specifies a maximum number of edges to include for each vector.
virtual void SetMinimumCount (int _arg)
 Specifies a minimum number of edges to include for each vector.
virtual void SetMinimumThreshold (double _arg)
 Specifies a minimum threshold that a similarity must exceed to be included in the output.
virtual void SetSecondFirst (int _arg)
 When computing similarities for two input matrices, controls whether the results will include comparisons from the second matrix to the first matrix.
virtual void SetUpperDiagonal (int _arg)
 When computing similarities for a single input matrix, controls whether the results will include the upper diagonal of the similarity matrix. Default: true.
virtual void SetVectorDimension (int _arg)
 Controls whether to compute similarities for row-vectors or column-vectors. 0 = rows, 1 = columns.

Static Public Member Functions

static new vtkDotProductSimilarity New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkDotProductSimilarity SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkDotProductSimilarity"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "23vtkDotProductSimilarity"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkDotProductSimilarity_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkDotProductSimilarity_GetDiagonal_01 (HandleRef pThis)
static internal int vtkDotProductSimilarity_GetFirstSecond_02 (HandleRef pThis)
static internal int vtkDotProductSimilarity_GetLowerDiagonal_03 (HandleRef pThis)
static internal int vtkDotProductSimilarity_GetMaximumCount_04 (HandleRef pThis)
static internal int vtkDotProductSimilarity_GetMinimumCount_05 (HandleRef pThis)
static internal double vtkDotProductSimilarity_GetMinimumThreshold_06 (HandleRef pThis)
static internal int vtkDotProductSimilarity_GetSecondFirst_07 (HandleRef pThis)
static internal int vtkDotProductSimilarity_GetUpperDiagonal_08 (HandleRef pThis)
static internal int vtkDotProductSimilarity_GetVectorDimension_09 (HandleRef pThis)
static internal int vtkDotProductSimilarity_IsA_10 (HandleRef pThis, string type)
static internal int vtkDotProductSimilarity_IsTypeOf_11 (string type)
static internal IntPtr vtkDotProductSimilarity_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkDotProductSimilarity_SafeDownCast_14 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkDotProductSimilarity_SetDiagonal_15 (HandleRef pThis, int _arg)
static internal void vtkDotProductSimilarity_SetFirstSecond_16 (HandleRef pThis, int _arg)
static internal void vtkDotProductSimilarity_SetLowerDiagonal_17 (HandleRef pThis, int _arg)
static internal void vtkDotProductSimilarity_SetMaximumCount_18 (HandleRef pThis, int _arg)
static internal void vtkDotProductSimilarity_SetMinimumCount_19 (HandleRef pThis, int _arg)
static internal void vtkDotProductSimilarity_SetMinimumThreshold_20 (HandleRef pThis, double _arg)
static internal void vtkDotProductSimilarity_SetSecondFirst_21 (HandleRef pThis, int _arg)
static internal void vtkDotProductSimilarity_SetUpperDiagonal_22 (HandleRef pThis, int _arg)
static internal void vtkDotProductSimilarity_SetVectorDimension_23 (HandleRef pThis, int _arg)

Static Private Member Functions

static vtkDotProductSimilarity ()
 Automatically generated type registration mechanics.

Detailed Description

vtkDotProductSimilarity - compute dot-product similarity metrics.

Description Treats matrices as collections of vectors and computes dot-product similarity metrics between vectors.

The results are returned as an edge-table that lists the index of each vector and their computed similarity. The output edge-table is typically used with vtkTableToGraph to create a similarity graph.

This filter can be used with one or two input matrices. If you provide a single matrix as input, every vector in the matrix is compared with every other vector. If you provide two matrices, every vector in the first matrix is compared with every vector in the second matrix.

Note that this filter *only* computes the dot-product between each pair of vectors; if you want to compute the cosine of the angles between vectors, you will need to normalize the inputs yourself.

Inputs: Input port 0: (required) A vtkDenseArray<double> with two dimensions (a matrix). Input port 1: (optional) A vtkDenseArray<double> with two dimensions (a matrix).

Outputs: Output port 0: A vtkTable containing "source", "target", and "similarity" columns.

Caveats Note that the complexity of this filter is quadratic! It also requires dense arrays as input, in the future it should be generalized to accept sparse arrays.

Thanks Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkDotProductSimilarity.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

When computing similarities for a single input matrix, controls whether the results will include the diagonal of the similarity matrix. Default: false.

When computing similarities for two input matrices, controls whether the results will include comparisons from the first matrix to the second matrix.

When computing similarities for a single input matrix, controls whether the results will include the lower diagonal of the similarity matrix. Default: false.

Specifies a maximum number of edges to include for each vector.

Specifies a minimum number of edges to include for each vector.

Specifies a minimum threshold that a similarity must exceed to be included in the output.

When computing similarities for two input matrices, controls whether the results will include comparisons from the second matrix to the first matrix.

When computing similarities for a single input matrix, controls whether the results will include the upper diagonal of the similarity matrix. Default: true.

Controls whether to compute similarities for row-vectors or column-vectors. 0 = rows, 1 = columns.

override int Kitware.VTK.vtkDotProductSimilarity.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

static new int Kitware.VTK.vtkDotProductSimilarity.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkDotProductSimilarity.SetDiagonal ( int  _arg) [virtual]

When computing similarities for a single input matrix, controls whether the results will include the diagonal of the similarity matrix. Default: false.

virtual void Kitware.VTK.vtkDotProductSimilarity.SetFirstSecond ( int  _arg) [virtual]

When computing similarities for two input matrices, controls whether the results will include comparisons from the first matrix to the second matrix.

virtual void Kitware.VTK.vtkDotProductSimilarity.SetLowerDiagonal ( int  _arg) [virtual]

When computing similarities for a single input matrix, controls whether the results will include the lower diagonal of the similarity matrix. Default: false.

virtual void Kitware.VTK.vtkDotProductSimilarity.SetMaximumCount ( int  _arg) [virtual]

Specifies a maximum number of edges to include for each vector.

virtual void Kitware.VTK.vtkDotProductSimilarity.SetMinimumCount ( int  _arg) [virtual]

Specifies a minimum number of edges to include for each vector.

virtual void Kitware.VTK.vtkDotProductSimilarity.SetMinimumThreshold ( double  _arg) [virtual]

Specifies a minimum threshold that a similarity must exceed to be included in the output.

virtual void Kitware.VTK.vtkDotProductSimilarity.SetSecondFirst ( int  _arg) [virtual]

When computing similarities for two input matrices, controls whether the results will include comparisons from the second matrix to the first matrix.

virtual void Kitware.VTK.vtkDotProductSimilarity.SetUpperDiagonal ( int  _arg) [virtual]

When computing similarities for a single input matrix, controls whether the results will include the upper diagonal of the similarity matrix. Default: true.

virtual void Kitware.VTK.vtkDotProductSimilarity.SetVectorDimension ( int  _arg) [virtual]

Controls whether to compute similarities for row-vectors or column-vectors. 0 = rows, 1 = columns.

static internal int Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_GetDiagonal_01 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_GetFirstSecond_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_GetLowerDiagonal_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_GetMaximumCount_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_GetMinimumCount_05 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_GetMinimumThreshold_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_GetSecondFirst_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_GetUpperDiagonal_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_IsTypeOf_11 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_SafeDownCast_14 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_SetDiagonal_15 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_SetFirstSecond_16 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_SetLowerDiagonal_17 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_SetMaximumCount_18 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_SetMinimumCount_19 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_SetMinimumThreshold_20 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_SetSecondFirst_21 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_SetUpperDiagonal_22 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDotProductSimilarity.vtkDotProductSimilarity_SetVectorDimension_23 ( HandleRef  pThis,
int  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkDotProductSimilarity.MRClassNameKey = "23vtkDotProductSimilarity" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

new const string Kitware.VTK.vtkDotProductSimilarity.MRFullTypeName = "Kitware.VTK.vtkDotProductSimilarity"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.


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