HoughTransform (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.algorithm.transformation.HoughTransform<S,T>

Type Parameters:

S - the data type used for storing votes, usually IntType, but possibly LongType or even DoubleType.

T - the data type of the input image.

All Implemented Interfaces:

Algorithm, Benchmark, OutputAlgorithm<S>

Direct Known Subclasses:

HoughLineTransform
```
public abstract class HoughTransform<S extends RealType<S>,T extends Type<T> & Comparable<T>>
extends Object
implements OutputAlgorithm<S>, Benchmark
```
This abstract class provides some basic functionality for use with arbitrary Hough-like transforms.

Author:

lindsey

Field Summary

Fields
Modifier and Type Field and Description

protected long pTime

Fields
Modifier and Type	Field and Description
`protected long`	`pTime`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`HoughTransform(Image<T> inputImage, int[] voteSize, ImageFactory<S> voteFactory)` Constructor for a HoughTransform with a specific ImageFactory.
`protected`	`HoughTransform(Image<T> inputImage, int[] voteSize, S type)` Constructor for a HoughTransform using an ArrayContainerFactory to back the ImageFactory used to generate the voteSpace image.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkInput()`
`String`	`getErrorMessage()`
`Image<T>`	`getImage()`
`ArrayList<int[]>`	`getPeakList()` Returns an ArrayList of int arrays, representing the positions in the vote space that correspond to peaks.
`long`	`getProcessingTime()`
`Image<S>`	`getResult()`
`protected boolean`	`pickPeaks()` Pick vote space peaks with a `PickImagePeaks`.
`protected boolean`	`placeVote(int[] loc)` Place a vote of value 1.
`protected boolean`	`placeVote(int[] loc, S vote)` Place a vote with a specific value.
`protected void`	`setErrorMsg(String msg)`
`boolean`	`setExclusion(double[] newExclusion)`

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

Methods inherited from interface mpicbg.imglib.algorithm.Algorithm
process

- Field Detail
  - pTime
```
protected long pTime
```
- Constructor Detail
  - HoughTransform
```
protected HoughTransform(Image<T> inputImage,
                         int[] voteSize,
                         S type)
```
    Constructor for a HoughTransform using an ArrayContainerFactory to back the ImageFactory used to generate the voteSpace image.
    
    Parameters:
    
    inputImage - the image for the HoughTransform to operate over
    
    voteSize - and integer array indicating the size of the voteSpace. This is passed directly into ImageFactory to create a voteSpace image.
    
    type - the Type to use for generating the voteSpace image.
  - HoughTransform
```
protected HoughTransform(Image<T> inputImage,
                         int[] voteSize,
                         ImageFactory<S> voteFactory)
```
    Constructor for a HoughTransform with a specific ImageFactory. Use this if you have something specific in mind as to how the vote data should be stored.
    
    Parameters:
    
    inputImage - the image for the HoughTransform to operate over
    
    voteSize - and integer array indicating the size of the voteSpace. This is passed directly into ImageFactory to create a voteSpace image.
    
    voteFactory - the ImageFactory used to generate the voteSpace image.
- Method Detail
  - placeVote
```
protected boolean placeVote(int[] loc,
                            S vote)
```
    Place a vote with a specific value.
    
    Parameters:
    
    loc - the integer array indicating the location where the vote is to be placed in voteSpace.
    
    vote - the value of the vote
    
    Returns:
    
    whether the vote was successful. This here particular method should always return true.
  - placeVote
```
protected boolean placeVote(int[] loc)
```
    Place a vote of value 1.
    
    Parameters:
    
    loc - the integer array indicating the location where the vote is to be placed in voteSpace.
    
    Returns:
    
    whether the vote was successful. This here particular method should always return true.
  - getPeakList
```
public ArrayList<int[]> getPeakList()
```
    Returns an ArrayList of int arrays, representing the positions in the vote space that correspond to peaks.
    
    Returns:
    
    an ArrayList of vote space peak locations.
  - setExclusion
```
public boolean setExclusion(double[] newExclusion)
```
  - setErrorMsg
```
protected void setErrorMsg(String msg)
```
  - pickPeaks
```
protected boolean pickPeaks()
```
    Pick vote space peaks with a PickImagePeaks.
    
    Returns:
    
    whether peak picking was successful
  - checkInput
```
public boolean checkInput()
```
    Specified by:
    
    checkInput in interface Algorithm
  - getErrorMessage
```
public String getErrorMessage()
```
    Specified by:
    
    getErrorMessage in interface Algorithm
  - getProcessingTime
```
public long getProcessingTime()
```
    Specified by:
    
    getProcessingTime in interface Benchmark
  - getImage
```
public Image<T> getImage()
```
  - getResult
```
public Image<S> getResult()
```
    Specified by:
    
    getResult in interface OutputAlgorithm<S extends RealType<S>>

Class HoughTransform<S extends RealType<S>,T extends Type<T> & Comparable<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface mpicbg.imglib.algorithm.Algorithm

Field Detail

pTime

Constructor Detail

HoughTransform

HoughTransform

Method Detail

placeVote

placeVote

getPeakList

setExclusion

setErrorMsg

pickPeaks

checkInput

getErrorMessage

getProcessingTime

getImage

getResult