AbstractPointDescriptor (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.pointdescriptor.AbstractPointDescriptor<P,F>

Direct Known Subclasses:: LocalCoordinateSystemPointDescriptor, ModelPointDescriptor, SimplePointDescriptor

public abstract class AbstractPointDescriptor<P extends Point,F extends AbstractPointDescriptor<P,F>>
extends Object

Field Summary

Fields
Modifier and Type Field and Description

protected static AtomicLong index

Fields
Modifier and Type	Field and Description
`protected static AtomicLong`	`index`

Constructor Summary

Constructors
Constructor and Description
`AbstractPointDescriptor(P basisPoint, ArrayList<P> orderedNearestNeighboringPoints, SimilarityMeasure similarityMeasure, Matcher matcher)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`descriptorDistance(F pointDescriptor)` Matches two `AbstractPointDescriptor`s of the same kind yielding a similarity value, the lower the better (0 means identical)
`abstract Object`	`fitMatches(ArrayList<PointMatch> matches)` Computes a fit between this these `PointMatch`es, this method is called by the `Matcher`
`P`	`getBasisPoint()` The basis point for this descriptor
`ArrayList<PointMatch>`	`getBestPointMatchSet()` The combination of descriptorpoints that yielded the best similarity in the last comparison
`Point`	`getDescriptorPoint(int index)` Returns a certain nearest neighbor (relative to the basis point) of this `AbstractPointDescriptor`
`long`	`getId()` Return the unique id of this descriptor
`ArrayList<P>`	`getOrderedNearestNeighboringPoints()` The points forming the `AbstractPointDescriptor` relative to the basis point
`SimilarityMeasure`	`getSimilarityMeasure()`
`int`	`numDimensions()` Dimensionality of the `Point`s of this `AbstractPointDescriptor`
`int`	`numNeighbors()` The number of neighbors used for this descriptor
`protected void`	`resetWorldCoordinates()` Resets the world coordinates of the descriptorPoints
`abstract boolean`	`resetWorldCoordinatesAfterMatching()` Tells if the descriptormatching should reset the world coordinates after the matching
`void`	`setSimilarityMeasure(SimilarityMeasure similarityMeasure)` Sets the `SimilarityMeasure` object that is used to compute how similar two descriptors are
`String`	`toString()` Overwrites the toString method
`abstract boolean`	`useWorldCoordinatesForDescriptorBuildUp()` Tells if the build up of the descriptor should use the world coordinates or rather the local coordinates

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - index
```
protected static final AtomicLong index
```
- Constructor Detail
  - AbstractPointDescriptor
```
public AbstractPointDescriptor(P basisPoint,
                               ArrayList<P> orderedNearestNeighboringPoints,
                               SimilarityMeasure similarityMeasure,
                               Matcher matcher)
                        throws NoSuitablePointsException
```
    Throws:
    
    NoSuitablePointsException
- Method Detail
  - descriptorDistance
```
public double descriptorDistance(F pointDescriptor)
```
    Matches two AbstractPointDescriptors of the same kind yielding a similarity value, the lower the better (0 means identical)
    
    Parameters:
    
    pointDescriptor - - the AbstractPointDescriptor to match
    
    Returns:
    
    similarity
  - getBestPointMatchSet
```
public ArrayList<PointMatch> getBestPointMatchSet()
```
    The combination of descriptorpoints that yielded the best similarity in the last comparison
    
    Returns:
    
    - List of PointMatches containing the original datasets
  - resetWorldCoordinates
```
protected void resetWorldCoordinates()
```
    Resets the world coordinates of the descriptorPoints
  - fitMatches
```
public abstract Object fitMatches(ArrayList<PointMatch> matches)
```
    Computes a fit between this these PointMatches, this method is called by the Matcher
    
    Parameters:
    
    matches - - The Points to match
  - resetWorldCoordinatesAfterMatching
```
public abstract boolean resetWorldCoordinatesAfterMatching()
```
    Tells if the descriptormatching should reset the world coordinates after the matching
    
    Returns:
  - useWorldCoordinatesForDescriptorBuildUp
```
public abstract boolean useWorldCoordinatesForDescriptorBuildUp()
```
    Tells if the build up of the descriptor should use the world coordinates or rather the local coordinates
    
    Returns:
    
    - true (world), false(local)
  - getSimilarityMeasure
```
public SimilarityMeasure getSimilarityMeasure()
```
    Returns:
    
    The SimilarityMeasure object that is used to compute how similar two descriptors are
  - setSimilarityMeasure
```
public void setSimilarityMeasure(SimilarityMeasure similarityMeasure)
```
    Sets the SimilarityMeasure object that is used to compute how similar two descriptors are
    
    Parameters:
    
    similarityMeasure -
  - getId
```
public long getId()
```
    Return the unique id of this descriptor
    
    Returns:
    
    long id
  - getBasisPoint
```
public P getBasisPoint()
```
    The basis point for this descriptor
    
    Returns:
    
    the Point instance
  - getDescriptorPoint
```
public Point getDescriptorPoint(int index)
```
    Returns a certain nearest neighbor (relative to the basis point) of this AbstractPointDescriptor
    
    Parameters:
    
    index - - the index (0 means first nearest neighbor)
    
    Returns:
    
    the Point instance
  - getOrderedNearestNeighboringPoints
```
public ArrayList<P> getOrderedNearestNeighboringPoints()
```
    The points forming the AbstractPointDescriptor relative to the basis point
  - numNeighbors
```
public int numNeighbors()
```
    The number of neighbors used for this descriptor
    
    Returns:
    
    - int number
  - numDimensions
```
public int numDimensions()
```
    Dimensionality of the Points of this AbstractPointDescriptor
    
    Returns:
    
    - int dimensions
  - toString
```
public String toString()
```
    Overwrites the toString method
    
    Overrides:
    
    toString in class Object

Class AbstractPointDescriptor<P extends Point,F extends AbstractPointDescriptor<P,F>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

index

Constructor Detail

AbstractPointDescriptor

Method Detail

descriptorDistance

getBestPointMatchSet

resetWorldCoordinates

fitMatches

resetWorldCoordinatesAfterMatching

useWorldCoordinatesForDescriptorBuildUp

getSimilarityMeasure

setSimilarityMeasure

getId

getBasisPoint

getDescriptorPoint

getOrderedNearestNeighboringPoints

numNeighbors

numDimensions

toString