DetectorKeys (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.plugin.trackmate.detection.DetectorKeys

```
public class DetectorKeys
extends Object
```
A class to store key names for parameters of the current SpotDetector s.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_DO_MEDIAN_FILTERING` A default value for the `KEY_DO_MEDIAN_FILTERING` parameter.
`static boolean`	`DEFAULT_DO_SUBPIXEL_LOCALIZATION` A default value for the `KEY_DO_SUBPIXEL_LOCALIZATION` parameter.
`static int`	`DEFAULT_DOWNSAMPLE_FACTOR` A default value for the `KEY_DOWNSAMPLE_FACTOR` parameter.
`static double`	`DEFAULT_RADIUS` A default value for the `KEY_RADIUS` parameter.
`static int`	`DEFAULT_TARGET_CHANNEL` A default value for the `KEY_TARGET_CHANNEL` parameter.
`static double`	`DEFAULT_THRESHOLD` A default value for the `KEY_THRESHOLD` parameter.
`static String`	`KEY_DO_MEDIAN_FILTERING` The key identifying the parameter setting whether we pre-filter the target image with a median filter or not.
`static String`	`KEY_DO_SUBPIXEL_LOCALIZATION` The key identifying the parameter setting whether we use sub-pixel localization for spot position.
`static String`	`KEY_DOWNSAMPLE_FACTOR` The key identifying the parameter that sets the downsampling factor applied to the source image prior to segmentation.
`static String`	`KEY_RADIUS` The key identifying the parameter that sets the target radius for the detector.
`static String`	`KEY_TARGET_CHANNEL` The key identifying the parameter setting the target channel for detection in a possible multi-channel image.
`static String`	`KEY_THRESHOLD` The key identifying the parameter that sets the threshold for the LoG detector.
`static String`	`XML_ATTRIBUTE_DETECTOR_NAME` The attribute name for the `SpotDetectorFactory` key when marshalling to or unmarhsalling from XML.

Constructor Summary

Constructors
Constructor and Description

DetectorKeys()

Constructors
Constructor and Description
`DetectorKeys()`

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

- Field Detail
  - XML_ATTRIBUTE_DETECTOR_NAME
```
public static final String XML_ATTRIBUTE_DETECTOR_NAME
```
    The attribute name for the SpotDetectorFactory key when marshalling to or unmarhsalling from XML.
    
    See Also:
    
    Constant Field Values
  - KEY_TARGET_CHANNEL
```
public static final String KEY_TARGET_CHANNEL
```
    The key identifying the parameter setting the target channel for detection in a possible multi-channel image. Channels are here 1-numbered, meaning that "1" is the first available channel (and all images have at least this channel). Expected valkues are Integers greater than 1.
    Currently used by:
    - LogDetector
    - DogDetector
    See Also:
    
    Constant Field Values
  - DEFAULT_TARGET_CHANNEL
```
public static final int DEFAULT_TARGET_CHANNEL
```
    A default value for the KEY_TARGET_CHANNEL parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_RADIUS
```
public static final String KEY_RADIUS
```
    The key identifying the parameter that sets the target radius for the detector. Expected values are Doubles.
    Currently used by:
    See Also:
    
    Constant Field Values
  - DEFAULT_RADIUS
```
public static final double DEFAULT_RADIUS
```
    A default value for the KEY_RADIUS parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_THRESHOLD
```
public static final String KEY_THRESHOLD
```
    The key identifying the parameter that sets the threshold for the LoG detector. Spot found with a filtered value lowered than this threshold will not be retained. Expected values are Doubles.
    Currently used by:
    - LogDetector
    - DogDetector
    See Also:
    
    Constant Field Values
  - DEFAULT_THRESHOLD
```
public static final double DEFAULT_THRESHOLD
```
    A default value for the KEY_THRESHOLD parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_DOWNSAMPLE_FACTOR
```
public static final String KEY_DOWNSAMPLE_FACTOR
```
    The key identifying the parameter that sets the downsampling factor applied to the source image prior to segmentation. Expected values are Integers greater than 1.
    Currently note used.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DOWNSAMPLE_FACTOR
```
public static final int DEFAULT_DOWNSAMPLE_FACTOR
```
    A default value for the KEY_DOWNSAMPLE_FACTOR parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_DO_MEDIAN_FILTERING
```
public static final String KEY_DO_MEDIAN_FILTERING
```
    The key identifying the parameter setting whether we pre-filter the target image with a median filter or not. Expected values are Booleans.
    Currently used by:
    - LogDetector
    - DogDetector
    See Also:
    
    Constant Field Values
  - DEFAULT_DO_MEDIAN_FILTERING
```
public static final boolean DEFAULT_DO_MEDIAN_FILTERING
```
    A default value for the KEY_DO_MEDIAN_FILTERING parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_DO_SUBPIXEL_LOCALIZATION
```
public static final String KEY_DO_SUBPIXEL_LOCALIZATION
```
    The key identifying the parameter setting whether we use sub-pixel localization for spot position. Accepted values are Booleans.
    Currently used by:
    - LogDetector
    - DogDetector
    See Also:
    
    Constant Field Values
  - DEFAULT_DO_SUBPIXEL_LOCALIZATION
```
public static final boolean DEFAULT_DO_SUBPIXEL_LOCALIZATION
```
    A default value for the KEY_DO_SUBPIXEL_LOCALIZATION parameter.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DetectorKeys
```
public DetectorKeys()
```

Class DetectorKeys

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XML_ATTRIBUTE_DETECTOR_NAME

KEY_TARGET_CHANNEL

DEFAULT_TARGET_CHANNEL

KEY_RADIUS

DEFAULT_RADIUS

KEY_THRESHOLD

DEFAULT_THRESHOLD

KEY_DOWNSAMPLE_FACTOR

DEFAULT_DOWNSAMPLE_FACTOR

KEY_DO_MEDIAN_FILTERING

DEFAULT_DO_MEDIAN_FILTERING

KEY_DO_SUBPIXEL_LOCALIZATION

DEFAULT_DO_SUBPIXEL_LOCALIZATION

Constructor Detail

DetectorKeys