Serialized Form (feature 0.18 API)

Package boofcv.abst.feature.describe
- Class boofcv.abst.feature.describe.ConfigBrief extends java.lang.Object implements Serializable
  - Serialized Fields
    - radius
```
int radius
```
      Region's radius. Typical value is 16.
    - numPoints
```
int numPoints
```
      Number of points sampled. Typical value is 512.
    - blurSigma
```
double blurSigma
```
      Amount of blur applied to the image before sampling. Typical value is -1
    - blurRadius
```
int blurRadius
```
      Amount of blur applied to the image before sampling. Typical value is 4
    - fixed
```
boolean fixed
```
      If true then a fixed sized descriptor is used. If false then orientation and scale information is used, if available. By default this is true.
- Class boofcv.abst.feature.describe.ConfigSiftDescribe extends java.lang.Object implements Serializable
  - Serialized Fields
    - gridWidth
```
int gridWidth
```
      Number of grid elements along a side. Typically 4
    - numSamples
```
int numSamples
```
      Number of samples along a grid. Typically 8
    - numHistBins
```
int numHistBins
```
      Number of bins in the orientation histogram. Typically 8
    - weightSigma
```
double weightSigma
```
      Adjusts descriptor element's weighting from center. Typically 0.5
    - sigmaToRadius
```
double sigmaToRadius
```
      Conversation from scale space to pixels. Typically 3
- Class boofcv.abst.feature.describe.ConfigSiftScaleSpace extends java.lang.Object implements Serializable
  - Serialized Fields
    - blurSigma
```
float blurSigma
```
      Amount of blur applied to each scale inside an octaves. Try 1.6
    - numScales
```
int numScales
```
      Number of scales per octaves. Try 5. Must be >= 3
    - numOctaves
```
int numOctaves
```
      Number of octaves to detect. Try 4
    - doubleInputImage
```
boolean doubleInputImage
```
      Should the input image be doubled? Try false.
- Class boofcv.abst.feature.describe.ConfigSurfDescribe extends java.lang.Object implements Serializable
  - Serialized Fields
    - widthLargeGrid
```
int widthLargeGrid
```
      Number of sub-regions wide the large grid is. Typically 4
    - widthSubRegion
```
int widthSubRegion
```
      Number of sample points wide a sub-region is. Typically 5
    - widthSample
```
int widthSample
```
      The width of a sample point. Typically 3
    - useHaar
```
boolean useHaar
```
      If true the Haar wavelet will be used. If false means image gradient.
- Class boofcv.abst.feature.describe.ConfigSurfDescribe.Speed extends ConfigSurfDescribe implements Serializable
  - Serialized Fields
    - weightSigma
```
double weightSigma
```
      Weighting factor's sigma. Try 3.8
- Class boofcv.abst.feature.describe.ConfigSurfDescribe.Stability extends ConfigSurfDescribe implements Serializable
  - Serialized Fields
    - overLap
```
int overLap
```
      Number of sample points sub-regions overlap, Typically 2.
    - sigmaLargeGrid
```
double sigmaLargeGrid
```
      Sigma used to weight points in the sub-region grid. Typically 2.5
    - sigmaSubRegion
```
double sigmaSubRegion
```
      Sigma used to weight points in the large grid. Typically 2.5
Package boofcv.abst.feature.detect.extract
- Class boofcv.abst.feature.detect.extract.ConfigExtract extends java.lang.Object implements Serializable
  - Serialized Fields
    - radius
```
int radius
```
      Search radius of the non-maximum region. Most common value is 1 for a 3x3 region. Default is 1.
    - threshold
```
float threshold
```
      Minimum feature intensity it will consider when detecting a maximum. For local minimums it will use a value of -threshold. Defaults to 0.
    - ignoreBorder
```
int ignoreBorder
```
      Size of border around the image in which pixels are not considered. Default is 0.
    - useStrictRule
```
boolean useStrictRule
```
      Is a strict test used to test for local maximums. If strict the local maximum must be greater than all its neighbors, otherwise it just needs to be greater than or equal to its neighbors. Default is true.
    - detectMinimums
```
boolean detectMinimums
```
      If false then local maximums will be found
    - detectMaximums
```
boolean detectMaximums
```
      If true then local maximums will be found
Package boofcv.abst.feature.detect.interest
- Class boofcv.abst.feature.detect.interest.ConfigFast extends java.lang.Object implements Serializable
  - Serialized Fields
    - pixelTol
```
int pixelTol
```
      How different pixels need to be to be considered part of a corner. Image dependent. Try 20 to start.
    - minContinuous
```
int minContinuous
```
      Minimum number of pixels around the circle that are required to be a corner. Can be 9 to 12
- Class boofcv.abst.feature.detect.interest.ConfigFastHessian extends java.lang.Object implements Serializable
  - Serialized Fields
    - detectThreshold
```
float detectThreshold
```
      Minimum feature intensity. Image dependent. Start tuning at 1.
    - extractRadius
```
int extractRadius
```
      Radius used for non-max-suppression. Typically 1 or 2.
    - maxFeaturesPerScale
```
int maxFeaturesPerScale
```
      Number of features it will find or if <= 0 it will return all features it finds.
    - initialSampleSize
```
int initialSampleSize
```
      How often pixels are sampled in the first octave. Typically 1 or 2.
    - initialSize
```
int initialSize
```
      Typically 9.
    - numberScalesPerOctave
```
int numberScalesPerOctave
```
      Typically 4.
    - numberOfOctaves
```
int numberOfOctaves
```
      Typically 4.
- Class boofcv.abst.feature.detect.interest.ConfigGeneralDetector extends ConfigExtract implements Serializable
  - Serialized Fields
    - maxFeatures
```
int maxFeatures
```
      Specifies the maximum number of features it will detect. If a value is specified then the 'maxFeature' most intense features are returned. Set to a value <= 0 to return all selected features. Default is -1.
- Class boofcv.abst.feature.detect.interest.ConfigSiftDetector extends java.lang.Object implements Serializable
  - Serialized Fields
    - extractRadius
```
int extractRadius
```
      Size of the feature used to detect the corners. Try 2
    - detectThreshold
```
float detectThreshold
```
      Minimum corner intensity required. Set to -Float.MAX_VALUE to detect every possible feature. Try 1. Feature intensity is computed using a Difference-of-Gaussian operation, which can have negative values.
    - maxFeaturesPerScale
```
int maxFeaturesPerScale
```
      Max detected features per scale. Disable with < 0. Tune, image dependent.
    - edgeThreshold
```
double edgeThreshold
```
      Threshold for edge filtering. Disable with a value <= 0. Try 5
Package boofcv.abst.feature.orientation
- Class boofcv.abst.feature.orientation.ConfigAverageIntegral extends java.lang.Object implements Serializable
  - Serialized Fields
    - radius
```
int radius
```
      Radius of the region being considered in terms of samples. Typically 6.
    - samplePeriod
```
double samplePeriod
```
      How often the image is sampled. This number is scaled. Typically 1.
    - sampleWidth
```
int sampleWidth
```
      How wide of a kernel should be used to sample. Try 6
    - weightSigma
```
double weightSigma
```
      Sigma for weighting. zero for unweighted. less than zero for automatic. Try -1.
- Class boofcv.abst.feature.orientation.ConfigSiftOrientation extends java.lang.Object implements Serializable
  - Serialized Fields
    - histogramSize
```
int histogramSize
```
      Number of elements in the histogram. Standard is 36
    - sigmaToRadius
```
double sigmaToRadius
```
      Convert a sigma to region radius. Try 2.5
    - sigmaEnlarge
```
double sigmaEnlarge
```
      How much the scale is enlarged by. Standard is 1.5
- Class boofcv.abst.feature.orientation.ConfigSlidingIntegral extends java.lang.Object implements Serializable
  - Serialized Fields
    - samplePeriod
```
double samplePeriod
```
      How often the image is sampled. This number is scaled. Typically 0.65.
    - windowSize
```
double windowSize
```
      Angular window that is slide across. Try PI/3
    - radius
```
int radius
```
      Radius of the region being considered in terms of samples. Typically 8.
    - weightSigma
```
double weightSigma
```
      Sigma for weighting distribution. 0 for unweighted. less than zero for automatic. Try -1
    - sampleWidth
```
int sampleWidth
```
      Size of kernel doing the sampling. Typically 6.
Package boofcv.alg.feature.detect.line.gridline
- Class boofcv.alg.feature.detect.line.gridline.Edgel extends georegression.struct.point.Point2D_F32 implements Serializable
  - Serialized Fields
    - theta
```
float theta
```
Package boofcv.alg.flow
- Class boofcv.alg.flow.ConfigBroxWarping extends java.lang.Object implements Serializable
  - Serialized Fields
    - alpha
```
float alpha
```
      Brightness difference weighting factor. Larger values which prefer a smooth flow.
    - gamma
```
float gamma
```
      Gradient difference weighting factor. Larger values which prefer a smooth flow.
    - SOR_RELAXATION
```
float SOR_RELAXATION
```
      SOR relaxation parameter. 0 < w < 2. Recommended default is 1.9
    - numOuter
```
int numOuter
```
      Number of iterations in the outer loop
    - numInner
```
int numInner
```
      Number of iterations in the inner loop
    - maxIterationsSor
```
int maxIterationsSor
```
      Maximum allowed iterations for SOR
    - convergeToleranceSor
```
float convergeToleranceSor
```
      Convergence tolerance for SOR loop. Specified in per pixel error.
    - pyrScale
```
double pyrScale
```
      Change in scale between each layer. Try 0.75
    - pyrSigma
```
double pyrSigma
```
      Amount of gaussian blur applied to each layer in the pyramid. If sigma <= 0 then no blur is applied.
    - pyrMaxLayers
```
int pyrMaxLayers
```
      Maximum number of layers in the pyramid
    - interpolation
```
boofcv.alg.interpolate.TypeInterpolate interpolation
```
      Type of interpolation used. Bilinear recommended
Package boofcv.alg.tracker.combined
- Class boofcv.alg.tracker.combined.CombinedTrack extends georegression.struct.point.Point2D_F64 implements Serializable
  - Serialized Fields
    - track
```
PyramidKltFeature track
```
    - desc
```
TupleDesc<T extends TupleDesc> desc
```
    - featureId
```
long featureId
```
    - cookie
```
java.lang.Object cookie
```
Package boofcv.factory.feature.detect.line
- Class boofcv.factory.feature.detect.line.ConfigHoughFoot extends java.lang.Object implements Serializable
  - Serialized Fields
    - localMaxRadius
```
int localMaxRadius
```
      Lines in transform space must be a local max in a region with this radius. Try 5;
    - minCounts
```
int minCounts
```
      Minimum number of counts/votes inside the transformed image. Try 5.
    - minDistanceFromOrigin
```
int minDistanceFromOrigin
```
      Lines which are this close to the origin of the transformed image are ignored. Try 5.
    - thresholdEdge
```
float thresholdEdge
```
      Threshold for classifying pixels as edge or not. Try 30.
    - maxLines
```
int maxLines
```
      Maximum number of lines to return. If <= 0 it will return them all.
- Class boofcv.factory.feature.detect.line.ConfigHoughFootSubimage extends java.lang.Object implements Serializable
  - Serialized Fields
    - localMaxRadius
```
int localMaxRadius
```
      Lines in transform space must be a local max in a region with this radius. Try 5;
    - minCounts
```
int minCounts
```
      Minimum number of counts/votes inside the transformed image. Try 5.
    - minDistanceFromOrigin
```
int minDistanceFromOrigin
```
      Lines which are this close to the origin of the transformed image are ignored. Try 5.
    - thresholdEdge
```
float thresholdEdge
```
      Threshold for classifying pixels as edge or not. Try 30.
    - maxLines
```
int maxLines
```
      Maximum number of lines to return. If <= 0 it will return them all.
    - totalHorizontalDivisions
```
int totalHorizontalDivisions
```
      Number of sub-images in horizontal direction Try 2
    - totalVerticalDivisions
```
int totalVerticalDivisions
```
      Number of sub images in vertical direction. Try 2
- Class boofcv.factory.feature.detect.line.ConfigHoughPolar extends java.lang.Object implements Serializable
  - Serialized Fields
    - localMaxRadius
```
int localMaxRadius
```
      Radius for local maximum suppression. Try 2.
    - minCounts
```
int minCounts
```
      Minimum number of counts for detected line. Critical tuning parameter and image dependent.
    - resolutionRange
```
double resolutionRange
```
      Resolution of line range in pixels. Try 2
    - resolutionAngle
```
double resolutionAngle
```
      Resolution of line angle in radius. Try PI/180
    - thresholdEdge
```
float thresholdEdge
```
      Edge detection threshold. Try 50.
    - maxLines
```
int maxLines
```
      Maximum number of lines to return. If <= 0 it will return all
Package boofcv.factory.flow
- Class boofcv.factory.flow.ConfigHornSchunck extends java.lang.Object implements Serializable
  - Serialized Fields
    - alpha
```
float alpha
```
      Larger values place more importance on flow smoothness consistency over brightness consistency. Try 20
    - numIterations
```
int numIterations
```
      Number of iterations. Try 1000
- Class boofcv.factory.flow.ConfigHornSchunckPyramid extends java.lang.Object implements Serializable
  - Serialized Fields
    - alpha
```
float alpha
```
      Weights importance of image brightness error and velocity smoothness. Larger values which prefer a smooth flow.
    - SOR_RELAXATION
```
float SOR_RELAXATION
```
      SOR relaxation parameter.
    - numWarps
```
int numWarps
```
      Number of warps which it will apply.
    - maxInnerIterations
```
int maxInnerIterations
```
      Maximum number of iterations in the inner loop.
    - convergeTolerance
```
float convergeTolerance
```
      Convergence tolerance for inner loop. Specified in per pixel error.
    - pyrScale
```
double pyrScale
```
      Change in scale between each layer. Try 0.7
    - pyrSigma
```
double pyrSigma
```
      Amount of blur applied to each layer in the pyramid. If sigma <= 0 then no blur is applied.
    - pyrMaxLayers
```
int pyrMaxLayers
```
      Maximum number of layers in the pyramid
    - interpolation
```
boofcv.alg.interpolate.TypeInterpolate interpolation
```
      Type of interpolation used. Bilinear recommended
Package boofcv.struct.feature
- Class boofcv.struct.feature.Match extends georegression.struct.point.Point2D_I32 implements Serializable
  - Serialized Fields
    - score
```
double score
```
      Score indicating the match quality. Higher the score the better. The range will depending on the algorithm used. For some algorithms the score will even be negative.
- Class boofcv.struct.feature.ScalePoint extends georegression.struct.point.Point2D_F64 implements Serializable
  - Serialized Fields
    - scale
```
double scale
```
    - white
```
boolean white
```

Serialized Form

Package boofcv.abst.feature.describe

Class boofcv.abst.feature.describe.ConfigBrief extends java.lang.Object implements Serializable

Serialized Fields

radius

numPoints

blurSigma

blurRadius

fixed

Class boofcv.abst.feature.describe.ConfigSiftDescribe extends java.lang.Object implements Serializable

Serialized Fields

gridWidth

numSamples

numHistBins

weightSigma

sigmaToRadius

Class boofcv.abst.feature.describe.ConfigSiftScaleSpace extends java.lang.Object implements Serializable

Serialized Fields

blurSigma

numScales

numOctaves

doubleInputImage

Class boofcv.abst.feature.describe.ConfigSurfDescribe extends java.lang.Object implements Serializable

Serialized Fields

widthLargeGrid

widthSubRegion

widthSample

useHaar

Class boofcv.abst.feature.describe.ConfigSurfDescribe.Speed extends ConfigSurfDescribe implements Serializable

Serialized Fields

weightSigma

Class boofcv.abst.feature.describe.ConfigSurfDescribe.Stability extends ConfigSurfDescribe implements Serializable

Serialized Fields

overLap

sigmaLargeGrid

sigmaSubRegion

Package boofcv.abst.feature.detect.extract

Class boofcv.abst.feature.detect.extract.ConfigExtract extends java.lang.Object implements Serializable

Serialized Fields

radius

threshold

ignoreBorder

useStrictRule

detectMinimums

detectMaximums

Package boofcv.abst.feature.detect.interest

Class boofcv.abst.feature.detect.interest.ConfigFast extends java.lang.Object implements Serializable

Serialized Fields

pixelTol

minContinuous

Class boofcv.abst.feature.detect.interest.ConfigFastHessian extends java.lang.Object implements Serializable

Serialized Fields

detectThreshold

extractRadius

maxFeaturesPerScale

initialSampleSize

initialSize

numberScalesPerOctave

numberOfOctaves

Class boofcv.abst.feature.detect.interest.ConfigGeneralDetector extends ConfigExtract implements Serializable

Serialized Fields

maxFeatures

Class boofcv.abst.feature.detect.interest.ConfigSiftDetector extends java.lang.Object implements Serializable

Serialized Fields

extractRadius

detectThreshold

maxFeaturesPerScale

edgeThreshold

Package boofcv.abst.feature.orientation

Class boofcv.abst.feature.orientation.ConfigAverageIntegral extends java.lang.Object implements Serializable

Serialized Fields

radius

samplePeriod

sampleWidth

weightSigma

Class boofcv.abst.feature.orientation.ConfigSiftOrientation extends java.lang.Object implements Serializable

Serialized Fields

histogramSize

sigmaToRadius

sigmaEnlarge