Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: InputToBinary

[340:7] extends: object

InputToBinary wraps boofcv.abst.filter.binary.InputToBinary.

Members

  • obj

Methods

  • InputToBinary (object Obj)

    Wraps a BoofCV InputToBinary object.

    • @p Obj is an existing InputToBinary Java object or wrapper.
  • process (object Input, object Binary)

    Processes a gray image into a binary GrayU8 image.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p Binary is the output GrayU8 wrapper or compatible Java object.
  • getInputType ()

    Gets the input image type.

    • @r An ImageType Java object.

class: ConfigLength

[6:7] extends: object

ConfigLength wraps boofcv.struct.ConfigLength.

Members

  • obj

Methods

  • ConfigLength (Length = 1, object Obj = null)

    Creates a fixed ConfigLength or wraps an existing Java object.

    • @p Length is the fixed length value.
    • @p Obj is an existing ConfigLength Java object or wrapper, or null to create a new fixed length.
  • fixed (Length)

    Creates a fixed ConfigLength.

    • @p Length is the fixed length value.
    • @r A ConfigLength wrapper.
  • relative (Fraction, Minimum)

    Creates a relative ConfigLength.

    • @p Fraction is the relative fraction.
    • @p Minimum is the minimum length.
    • @r A ConfigLength wrapper.
  • compute (TotalLength)

    Computes this length against a total length.

    • @p TotalLength is the total available length.
    • @r The computed length.
  • isFixed ()

    Gets whether this length is fixed.

    • @r True when fixed.

class: ConfigThresholdBlockMinMax

[454:7] extends: ConfigThreshold

ConfigThresholdBlockMinMax wraps boofcv.factory.filter.binary.ConfigThresholdBlockMinMax.

Methods

  • ConfigThresholdBlockMinMax (int Radius = 20, MinimumSpread = 0.0, bool ThresholdFromLocalBlocks = true)

    Creates a block min/max config.

    • @p Radius is the block radius.
    • @p MinimumSpread is the minimum local spread.
    • @p ThresholdFromLocalBlocks selects local-block thresholding.
  • getMinimumSpread ()

    Gets the minimum spread.

    • @r The minimum spread.
  • setMinimumSpread (MinimumSpread)

    Sets the minimum spread.

    • @p MinimumSpread is the minimum spread.

class: ThresholdType

[59:14] static extends: object

Static wrappers for the boofcv.factory.filter.binary.ThresholdType enum.

Methods

  • valueOf (string Name)

    Returns a BoofCV ThresholdType enum by name.

    • @p Name is one of FIXED, GLOBAL_ENTROPY, GLOBAL_OTSU, GLOBAL_LI, GLOBAL_HUANG, LOCAL_GAUSSIAN, LOCAL_MEAN, LOCAL_OTSU, BLOCK_MIN_MAX, BLOCK_MEAN, BLOCK_OTSU, LOCAL_NIBLACK, LOCAL_SAVOLA, LOCAL_WOLF, or LOCAL_NICK.
    • @r An AussomJavaObject wrapping boofcv.factory.filter.binary.ThresholdType.

class: ConfigThresholdLocalOtsu

[428:7] extends: ConfigThreshold

ConfigThresholdLocalOtsu wraps boofcv.factory.filter.binary.ConfigThresholdLocalOtsu.

Methods

  • ConfigThresholdLocalOtsu (int Radius = 20, Tuning = 0.0)

    Creates a local Otsu config.

    • @p Radius is the local region radius.
    • @p Tuning is the Otsu tuning value.
  • getTuning ()

    Gets the tuning value.

    • @r The tuning value.
  • setTuning (Tuning)

    Sets the tuning value.

    • @p Tuning is the tuning value.

class: ConfigThreshold

[370:7] extends: object

ConfigThreshold wraps boofcv.factory.filter.binary.ConfigThreshold.

Members

  • obj

Methods

  • ConfigThreshold (object Obj = null)

    Creates a ConfigThreshold or wraps an existing Java object.

    • @p Obj is an existing ConfigThreshold Java object or wrapper, or null to create a default config.
  • fixed (Threshold)

    Creates a fixed threshold config.

    • @p Threshold is the fixed threshold.
    • @r A ConfigThreshold wrapper.
  • global (string TypeName)

    Creates a global threshold config.

    • @p TypeName is one of GLOBAL_ENTROPY, GLOBAL_OTSU, GLOBAL_LI, or GLOBAL_HUANG.
    • @r A ConfigThreshold wrapper.
  • get (string Name)

    Gets a config field.

    • @p Name is one of type, fixedThreshold, scale, down, width, niblackK, nickK, minPixelValue, maxPixelValue, or thresholdFromLocalBlocks.
    • @r The field value.
  • set (string Name, Value)

    Sets a config field.

    • @p Name is one of type, fixedThreshold, scale, down, width, niblackK, nickK, minPixelValue, maxPixelValue, or thresholdFromLocalBlocks.
    • @p Value is the new field value.
  • checkValidity ()

    Validates this config.

class: GThresholdImageOps

[73:14] static extends: object

Static wrappers for boofcv.alg.filter.binary.GThresholdImageOps.

Methods

  • computeOtsu (object Input, MinValue, MaxValue)

    Computes an Otsu threshold.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p MinValue is the minimum pixel value.
    • @p MaxValue is the maximum pixel value.
    • @r The threshold value.
  • computeOtsu2 (object Input, int MinValue, int MaxValue)

    Computes an Otsu2 threshold.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p MinValue is the minimum pixel value.
    • @p MaxValue is the maximum pixel value.
    • @r The threshold value.
  • computeEntropy (object Input, MinValue, MaxValue)

    Computes an entropy threshold.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p MinValue is the minimum pixel value.
    • @p MaxValue is the maximum pixel value.
    • @r The threshold value.
  • computeLi (object Input, MinValue, MaxValue)

    Computes a Li threshold.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p MinValue is the minimum pixel value.
    • @p MaxValue is the maximum pixel value.
    • @r The threshold value.
  • computeHuang (object Input, MinValue, MaxValue)

    Computes a Huang threshold.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p MinValue is the minimum pixel value.
    • @p MaxValue is the maximum pixel value.
    • @r The threshold value.
  • threshold (object Input, object Output, Threshold, bool Down)

    Applies a fixed threshold.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p Output is a GrayU8 binary image wrapper or compatible Java object.
    • @p Threshold is the threshold value.
    • @p Down is true to mark pixels less than or equal to the threshold.
    • @r The output image Java object returned by BoofCV.
  • localGaussian (object Input, object Output, object Radius, Scale, bool Down, Storage1 = null, Storage2 = null)

    Applies local Gaussian thresholding.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p Output is a GrayU8 binary image wrapper or compatible Java object.
    • @p Radius is a ConfigLength wrapper or compatible Java object.
    • @p Scale is the threshold scale.
    • @p Down is true to mark dark regions.
    • @p Storage1 is optional working storage.
    • @p Storage2 is optional working storage.
    • @r The output image Java object returned by BoofCV.
  • localMean (object Input, object Output, object Radius, Scale, bool Down, Storage1 = null, Storage2 = null)

    Applies local mean thresholding.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p Output is a GrayU8 binary image wrapper or compatible Java object.
    • @p Radius is a ConfigLength wrapper or compatible Java object.
    • @p Scale is the threshold scale.
    • @p Down is true to mark dark regions.
    • @p Storage1 is optional working storage.
    • @p Storage2 is optional working storage.
    • @r The output image Java object returned by BoofCV.
  • localOtsu (object Input, object Output, bool Down, object Radius, Scale, Tuning, bool UseOtsu2)

    Applies local Otsu thresholding.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p Output is a GrayU8 binary image wrapper or compatible Java object.
    • @p Down is true to mark dark regions.
    • @p Radius is a ConfigLength wrapper or compatible Java object.
    • @p Scale is the threshold scale.
    • @p Tuning is the Otsu tuning value.
    • @p UseOtsu2 selects BoofCV's Otsu2 variant.
    • @r The output image Java object returned by BoofCV.
  • localNiblack (object Input, object Output, object Radius, K, bool Down)

    Applies local Niblack thresholding.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p Output is a GrayU8 binary image wrapper or compatible Java object.
    • @p Radius is a ConfigLength wrapper or compatible Java object.
    • @p K is the Niblack parameter.
    • @p Down is true to mark dark regions.
    • @r The output image Java object returned by BoofCV.
  • localSauvola (object Input, object Output, object Radius, K, bool Down)

    Applies local Sauvola thresholding.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p Output is a GrayU8 binary image wrapper or compatible Java object.
    • @p Radius is a ConfigLength wrapper or compatible Java object.
    • @p K is the Sauvola parameter.
    • @p Down is true to mark dark regions.
    • @r The output image Java object returned by BoofCV.
  • localNick (object Input, object Output, object Radius, K, bool Down)

    Applies local Nick thresholding.

    • @p Input is a gray image wrapper or compatible Java object.
    • @p Output is a GrayU8 binary image wrapper or compatible Java object.
    • @p Radius is a ConfigLength wrapper or compatible Java object.
    • @p K is the Nick parameter.
    • @p Down is true to mark dark regions.
    • @r The output image Java object returned by BoofCV.

class: FactoryThresholdBinary

[268:14] static extends: object

Static wrappers for boofcv.factory.filter.binary.FactoryThresholdBinary.

Methods

  • globalFixed (Threshold, bool Down, string ImageClassName)

    Creates a fixed global threshold filter.

    • @p Threshold is the fixed threshold.
    • @p Down is true to mark pixels below the threshold.
    • @p ImageClassName is a full gray image class name or supported short image name.
    • @r An InputToBinary wrapper.
  • globalOtsu (MinValue, MaxValue, Scale, bool Down, string ImageClassName)

    Creates a global Otsu threshold filter.

    • @p MinValue is the minimum pixel value.
    • @p MaxValue is the maximum pixel value.
    • @p Scale is the threshold scale.
    • @p Down is true to mark pixels below the threshold.
    • @p ImageClassName is a full gray image class name or supported short image name.
    • @r An InputToBinary wrapper.
  • localMean (object Radius, Scale, bool Down, string ImageClassName)

    Creates a local mean threshold filter.

    • @p Radius is a ConfigLength wrapper or compatible Java object.
    • @p Scale is the threshold scale.
    • @p Down is true to mark dark regions.
    • @p ImageClassName is a full gray image class name or supported short image name.
    • @r An InputToBinary wrapper.
  • localGaussian (object Radius, Scale, bool Down, string ImageClassName)

    Creates a local Gaussian threshold filter.

    • @p Radius is a ConfigLength wrapper or compatible Java object.
    • @p Scale is the threshold scale.
    • @p Down is true to mark dark regions.
    • @p ImageClassName is a full gray image class name or supported short image name.
    • @r An InputToBinary wrapper.
  • threshold (object Config, string ImageClassName)

    Creates a threshold filter from a ConfigThreshold object.

    • @p Config is a ConfigThreshold wrapper or compatible Java object.
    • @p ImageClassName is a full gray image class name or supported short image name.
    • @r An InputToBinary wrapper.