Manhattandist: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Benjamin
No edit summary
imported>Benjamin
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
===Purpose===
===Purpose===
Calculates Manhattan Distance between Samples (rows) of a Dataset Object (DSO) or a matrix.
Calculates the Manhattan Distance between: (1) Samples (rows) of a Dataset Object (DSO) a matrix. (2) rows of one DSO/matrix and the rows of another DSO/matrix.


===Synopsis===
===Synopsis===
Line 24: Line 24:
====Outputs====
====Outputs====


* '''distances''' = A m-by-m matrix containing the comprehensive calculated Manhattan distances between samples.
* '''distances''' = An m-by-m matrix containing the comprehensive calculated Manhattan distances between samples.


====Options====
====Options====
Line 34: Line 34:


===See Also===
===See Also===
[[analysis]], [[analysis_GUI]], [[cluster]], [[pca]], [[simca]], [[gcluster]]

Latest revision as of 13:19, 16 August 2017

Purpose

Calculates the Manhattan Distance between: (1) Samples (rows) of a Dataset Object (DSO) a matrix. (2) rows of one DSO/matrix and the rows of another DSO/matrix.

Synopsis

distances = manhattandist(x)
distances = manhattandist(x,basis)
distances = manhattandist(x,options)
distances = manhattandist(x,basis,options)

Description

Calculates the Manhattan Distance, sum of the absolute value differences, from each row to every other row in the supplied matrix or, optionally, all rows of (x) to all rows in a second matrix (basis).

Inputs

  • x = A DSO or a matrix.

Optional Inputs

  • basis = A second DSO/matrix to compare the first DSO/matrix against when calculating Manhattan distance.
  • options = Discussed below.

Outputs

  • distances = An m-by-m matrix containing the comprehensive calculated Manhattan distances between samples.

Options

options = A structure array with the following fields:

  • waitbar: [{'auto'}| 'on' | 'off' ], display waitbar. 'Auto' setting will automatically display a waitbar if computation takes longer than 3 seconds.
  • diag: {default: 0} Defines the values to be used when comparing a sample to itself. Technically this distance is zero however in some instances, using an alternate value (e.g.: inf) is useful for flagging these self-calculated distances.

See Also

analysis, analysis_GUI, cluster, pca, simca, gcluster