boofcv 1.0.0

class: ConfigFiducialBinary

[371:7] extends: FiducialConfig

ConfigFiducialBinary wraps boofcv.factory.fiducial.ConfigFiducialBinary.

Methods

• ConfigFiducialBinary (TargetWidth = null)

  Creates a binary fiducial config.

  • @p TargetWidth is target width in world units.

class: FactoryFiducial

[22:14] static extends: object

Static wrappers for boofcv.factory.fiducial.FactoryFiducial.

Methods

• qrcode (object Config, string ImageClassName)

  Creates a QR code detector.

  • @p Config is a ConfigQrCode wrapper.
  • @p ImageClassName is an input gray image class name or short image name.
  • @r A QrCodeDetector wrapper.

• microqr (object Config, string ImageClassName)

  Creates a Micro QR code detector.

  • @p Config is a ConfigMicroQrCode wrapper.
  • @p ImageClassName is an input gray image class name or short image name.
  • @r A MicroQrCodeDetector wrapper.

• aztec (object Config, string ImageClassName)

  Creates an Aztec code detector.

  • @p Config is a ConfigAztecCode wrapper.
  • @p ImageClassName is an input gray image class name or short image name.
  • @r An AztecCodeDetector wrapper.

• squareBinary (object Config, object Threshold, string ImageClassName)

  Creates a square binary fiducial detector.

  • @p Config is a ConfigFiducialBinary wrapper.
  • @p Threshold is a ConfigThreshold wrapper.
  • @p ImageClassName is an input gray image class name or short image name.
  • @r A FiducialDetector wrapper.

• squareImage (object Config, object Threshold, string ImageClassName)

  Creates a square image fiducial detector.

  • @p Config is a ConfigFiducialImage wrapper.
  • @p Threshold is a ConfigThreshold wrapper.
  • @p ImageClassName is an input gray image class name or short image name.
  • @r A FiducialDetector wrapper.

• squareHamming (object Marker, object Detector, string ImageClassName)

  Creates a square hamming fiducial detector.

  • @p Marker is a ConfigHammingMarker wrapper.
  • @p Detector is a ConfigFiducialHammingDetector wrapper.
  • @p ImageClassName is an input gray image class name or short image name.
  • @r A FiducialDetector wrapper.

• randomDots (object Config, string ImageClassName)

  Creates a random dots fiducial detector.

  • @p Config is a ConfigUchiyaMarker wrapper.
  • @p ImageClassName is an input gray image class name or short image name.
  • @r A FiducialDetector wrapper.

class: QrCodeDetector

[121:7] extends: object

QrCodeDetector wraps boofcv.abst.fiducial.QrCodePreciseDetector.

Members

• obj

Methods

• QrCodeDetector (object Obj)

  Wraps a QR code detector.

  • @p Obj is an existing detector Java object or wrapper.

• process (object Image)

  Processes an image.

  • @p Image is the input image.

• getDetections ()

  Gets detections.

  • @r A Java list of QrCode objects.

• getFailures ()

  Gets failed detections.

  • @r A Java list of QrCode objects.

• getBinary ()

  Gets the binary image.

  • @r A GrayU8 Java object.

• getImageType ()

  Gets the input image class.

  • @r A Java Class object.

class: QrCodeFailure

[512:14] static extends: object

QrCodeFailure exposes QrCode.Failure values.

Methods

• valueOf (string Name)

  Gets a failure value.

  • @p Name is NONE, FORMAT, VERSION, ALIGNMENT, READING_BITS, ERROR_CORRECTION, UNKNOWN_MODE, READING_PADDING, MESSAGE_OVERFLOW, DECODING_MESSAGE, KANJI_UNAVAILABLE, or STRING_ENCODING_UNAVAILABLE.
  • @r The enum Java object.

• values ()

  Gets all failure values.

  • @r A Java array of enum values.

class: ECoCheckUtils

[1135:7] extends: object

ECoCheckUtils wraps boofcv.alg.fiducial.calib.ecocheck.ECoCheckUtils.

Members

• obj

Methods

• ECoCheckUtils (Obj = null)

  Creates or wraps ECoCheck utilities.

  • @p Obj is an existing ECoCheckUtils Java object or null.

• get (string Name)

  Gets a public ECoCheck utility field.

  • @p Name is dataBitWidthFraction, dataBorderFraction, markers, bitSampleGridSize, codec, or bitOrder.
  • @r The field value.

• set (string Name, Value)

  Sets a public ECoCheck utility field.

  • @p Name is dataBitWidthFraction, dataBorderFraction, or bitSampleGridSize.
  • @p Value is the new field value.

• setInt (string Name, int Value)

  Sets a public integer ECoCheck utility field.

  • @p Name is bitSampleGridSize.
  • @p Value is the new integer value.

• setDouble (string Name, double Value)

  Sets a public floating-point ECoCheck utility field.

  • @p Name is dataBitWidthFraction or dataBorderFraction.
  • @p Value is the new floating-point value.

• setParametersFromConfig (object Config)

  Applies parameters from an ECoCheck marker config.

  • @p Config is a ConfigECoCheckMarkers wrapper.

• addMarker (int Rows, int Cols)

  Adds a marker grid.

  • @p Rows is grid rows.
  • @p Cols is grid columns.

• fixate ()

  Finalizes marker metadata after configuration.

• checkFixate ()

  Checks that the utility has been finalized.

• countEncodedSquaresInMarker (int MarkerIndex)

  Counts encoded squares in a marker.

  • @p MarkerIndex is marker index.
  • @r The encoded square count.

• getDataBitWidthFraction ()

  Gets data bit width fraction.

  • @r The fraction.

• setDataBitWidthFraction (double Fraction)

  Sets data bit width fraction.

  • @p Fraction is the fraction.

• getDataBorderFraction ()

  Gets data border fraction.

  • @r The fraction.

• setDataBorderFraction (double Fraction)

  Sets data border fraction.

  • @p Fraction is the fraction.

• getBitSampleCount ()

  Gets bit sample count.

  • @r The bit sample count.

• maxCorners (int Rows, int Cols)

  Computes the maximum corner count.

  • @p Rows is grid rows.
  • @p Cols is grid columns.
  • @r The max corner count.

class: ConfigHammingMarker

[433:7] extends: FiducialConfig

ConfigHammingMarker wraps boofcv.factory.fiducial.ConfigHammingMarker.

Methods

• ConfigHammingMarker (Obj = null)

  Creates or wraps a hamming marker config.

  • @p Obj is an existing config or null.

• addMarker (int Encoding)

  Adds a marker encoding.

  • @p Encoding is the marker bit encoding.

• bitsPerGrid ()

  Gets bits per grid.

  • @r Bits per grid.

• loadPredefined (string Name)

  Loads a predefined dictionary.

  • @p Name is aruco_original, aruco_mip_16h3, aruco_mip_25h7, aruco_mip_36h12, aruco_ocv_4x4_1000, aruco_ocv_5x5_1000, aruco_ocv_6x6_1000, aruco_ocv_7x7_1000, apriltag_16h5, apriltag_25h7, apriltag_25h9, apriltag_36h10, or apriltag_36h11.
  • @r A ConfigHammingMarker wrapper.

• loadDictionary (string DictionaryName)

  Loads a dictionary.

  • @p DictionaryName is any HammingDictionary value.
  • @r A ConfigHammingMarker wrapper.

class: ConfigFiducialHammingDetector

[399:7] extends: FiducialConfig

ConfigFiducialHammingDetector wraps boofcv.factory.fiducial.ConfigFiducialHammingDetector.

Methods

• ConfigFiducialHammingDetector (Obj = null)

  Creates or wraps a hamming detector config.

  • @p Obj is an existing config or null.

class: ConfigHammingGrid

[1043:7] extends: FiducialConfig

ConfigHammingGrid wraps boofcv.factory.fiducial.ConfigHammingGrid.

Methods

• ConfigHammingGrid (MarkerConfig = null)

  Creates or wraps a hamming grid config.

  • @p MarkerConfig is an optional ConfigHammingMarker wrapper; null creates BoofCV defaults.

• setTo (object Config)

  Copies another config into this object.

  • @p Config is a ConfigHammingGrid wrapper or Java object.
  • @r This wrapper.

• getMarkerWidth ()

  Gets marker width in config units.

  • @r The marker width.

• getMarkerHeight ()

  Gets marker height in config units.

  • @r The marker height.

• create (string DictionaryName, int Rows, int Cols, double SquareSize, double SpaceToSquare)

  Creates a config.

  • @p DictionaryName is any HammingDictionary value.
  • @p Rows is grid rows.
  • @p Cols is grid columns.
  • @p SquareSize is square size.
  • @p SpaceToSquare is spacing-to-square ratio.
  • @r A ConfigHammingGrid wrapper.

class: RandomDotMarkerGeneratorImage

[1434:7] extends: object

RandomDotMarkerGeneratorImage wraps boofcv.alg.fiducial.dots.RandomDotMarkerGeneratorImage.

Members

• obj

Methods

• RandomDotMarkerGeneratorImage ()

  Creates a random-dot marker image generator.

• configure (int Width, int Height, int Radius)

  Configures output image.

  • @p Width is image width.
  • @p Height is image height.
  • @p Radius is dot radius in pixels.

• getImage ()

  Gets the generated GrayU8 image.

  • @r A GrayU8 Java object.

• getImageF32 ()

  Gets the generated GrayF32 image.

  • @r A GrayF32 Java object.

• getRadius ()

  Gets dot radius.

  • @r The dot radius.

• setRadius (double Radius)

  Sets dot radius.

  • @p Radius is dot radius.

class: ConfigQrCode

[1583:7] extends: object

ConfigQrCode wraps boofcv.factory.fiducial.ConfigQrCode.

Members

• obj

Methods

• ConfigQrCode (Obj = null)

  Creates or wraps a QR code config.

  • @p Obj is an existing config Java object or null to create a default config.

• fast ()

  Creates a fast QR config.

  • @r A ConfigQrCode wrapper.

• get (string Name)

  Gets a public config field.

  • @p Name is threshold, polygon, versionMinimum, versionMaximum, forceEncoding, defaultEncoding, considerTransposed, or ignorePaddingBytes.
  • @r The field value.

• set (string Name, Value)

  Sets a public config field.

  • @p Name is threshold, polygon, versionMinimum, versionMaximum, forceEncoding, defaultEncoding, considerTransposed, or ignorePaddingBytes.
  • @p Value is the new field value.

• checkValidity ()

  Validates this config.

class: ConfigFiducialImage

[382:7] extends: FiducialConfig

ConfigFiducialImage wraps boofcv.factory.fiducial.ConfigFiducialImage.

Methods

• ConfigFiducialImage (Obj = null)

  Creates or wraps an image fiducial config.

  • @p Obj is an existing config or null.

class: ConfigHammingChessboard

[1007:7] extends: FiducialConfig

ConfigHammingChessboard wraps boofcv.factory.fiducial.ConfigHammingChessboard.

Methods

• ConfigHammingChessboard (MarkerConfig = null)

  Creates or wraps a hamming chessboard config.

  • @p MarkerConfig is an optional ConfigHammingMarker wrapper; null creates BoofCV defaults.

• setTo (object Config)

  Copies another config into this object.

  • @p Config is a ConfigHammingChessboard wrapper or Java object.
  • @r This wrapper.

• getMarkerWidth ()

  Gets marker width in config units.

  • @r The marker width.

• getMarkerHeight ()

  Gets marker height in config units.

  • @r The marker height.

• create (string DictionaryName, int Rows, int Cols, double SquareSize)

  Creates a config.

  • @p DictionaryName is any HammingDictionary value.
  • @p Rows is board rows.
  • @p Cols is board columns.
  • @p SquareSize is square size.
  • @r A ConfigHammingChessboard wrapper.

class: AztecCodeFailure

[829:14] static extends: object

AztecCodeFailure exposes AztecCode.Failure values.

Methods

• valueOf (string Name)

  Gets a failure value.

  • @p Name is NONE, IMPROBABLE, ORIENTATION, MODE_ECC, MESSAGE_ECC, or MESSAGE_PARSE.
  • @r The enum Java object.

• values ()

  Gets all failure values.

  • @r A Java array of enum values.

class: ECoCheckGenerator

[1310:7] extends: object

ECoCheckGenerator wraps boofcv.alg.fiducial.calib.ecocheck.ECoCheckGenerator.

Members

• obj

Methods

• ECoCheckGenerator (object Utils)

  Creates an ECoCheck generator.

  • @p Utils is an ECoCheckUtils wrapper.

• render (int MarkerIndex)

  Renders one marker using the configured render engine.

  • @p MarkerIndex is marker index.

• saveCornerLocations (object Shape)

  Saves corner locations for a marker grid shape.

  • @p Shape is a boofcv.struct.GridShape Java object.

• setSquareWidth (double Width)

  Sets square width.

  • @p Width is square width in document units.

• getSquareWidth ()

  Gets square width.

  • @r The square width.

• setRender (object Render)

  Sets the render engine.

  • @p Render is a FiducialImageEngine or FiducialRenderEngine Java object.

• get (string Name)

  Gets a public generator field.

  • @p Name is squareWidth or corners.
  • @r The field value.

class: FiducialConfig

[324:7] extends: object

Base helper for fiducial configuration wrappers.

Members

• obj

Methods

• FiducialConfig (string ClassName, Obj = null)

  Creates or wraps a fiducial config.

  • @p ClassName is the full Java class.
  • @p Obj is an existing config or null.

• get (string Name)

  Gets a public config field.

  • @p Name is a field on the BoofCV config.
  • @r The field value.

• set (string Name, Value)

  Sets a public config field.

  • @p Name is a field on the BoofCV config.
  • @p Value is the new value or wrapper.

• setInt (string Name, int Value)

  Sets a public integer config field.

  • @p Name is an int field on the BoofCV config.
  • @p Value is the new integer value.

• setDouble (string Name, double Value)

  Sets a public floating-point config field.

  • @p Name is a double field on the BoofCV config.
  • @p Value is the new floating-point value.

• setBool (string Name, bool Value)

  Sets a public boolean config field.

  • @p Name is a boolean field on the BoofCV config.
  • @p Value is the new boolean value.

• checkValidity ()

  Validates this config.

class: HammingGridGenerator

[1269:7] extends: object

HammingGridGenerator wraps boofcv.alg.fiducial.calib.hamminggrids.HammingGridGenerator.

Members

• obj

Methods

• HammingGridGenerator (object Config)

  Creates a hamming grid generator.

  • @p Config is a ConfigHammingGrid wrapper.

• render ()

  Renders the grid using the configured render engine.

• saveCornerLocations ()

  Saves generated corner locations.

• setSquareWidth (double Width)

  Sets square width.

  • @p Width is square width in document units.

• getSquareWidth ()

  Gets square width.

  • @r The square width.

• setRender (object Render)

  Sets the render engine.

  • @p Render is a FiducialImageEngine or FiducialRenderEngine Java object.

• get (string Name)

  Gets a public generator field.

  • @p Name is squareWidth or corners.
  • @r The field value.

class: MicroQrCodeGenerator

[1409:7] extends: object

MicroQrCodeGenerator wraps boofcv.alg.fiducial.microqr.MicroQrCodeGenerator.

Members

• obj

Methods

• MicroQrCodeGenerator ()

  Creates a Micro QR generator.

• render (object Code)

  Renders a Micro QR code.

  • @p Code is a MicroQrCode Java object.
  • @r This generator.

• renderImage (int PixelsPerModule, int BorderModule, object Code)

  Renders a Micro QR code to a GrayU8 image.

  • @p PixelsPerModule is pixels per module.
  • @p BorderModule is border module count.
  • @p Code is a MicroQrCode Java object.
  • @r A GrayU8 Java object.

class: QrCodeMode

[489:14] static extends: object

QrCodeMode exposes QrCode.Mode values.

Methods

• valueOf (string Name)

  Gets a mode.

  • @p Name is NUMERIC, ALPHANUMERIC, BYTE, KANJI, ECI, STRUCTURE_APPENDED, FNC1_FIRST, FNC1_SECOND, UNKNOWN, or MIXED.
  • @r The enum Java object.

• lookup (int Value)

  Looks up a mode by encoded integer value.

  • @p Value is the QR mode encoding.
  • @r The enum Java object.

• values ()

  Gets all modes.

  • @r A Java array of enum values.

class: FiducialSquareHammingGenerator

[1556:7] extends: object

FiducialSquareHammingGenerator wraps boofcv.alg.fiducial.square.FiducialSquareHammingGenerator.

Members

• obj

Methods

• FiducialSquareHammingGenerator (object Config)

  Creates a square hamming generator.

  • @p Config is a ConfigHammingMarker wrapper.

• generate (int MarkerIndex)

  Generates a marker.

  • @p MarkerIndex is marker index.

• generateNoInit (int MarkerIndex)

  Generates a marker without initializing the render engine.

  • @p MarkerIndex is marker index.

• getConfig ()

  Gets the config.

  • @r A ConfigHammingMarker Java object.

class: FiducialDetector

[232:7] extends: object

FiducialDetector wraps boofcv.abst.fiducial.FiducialDetector.

Members

• obj

Methods

• FiducialDetector (object Obj)

  Wraps a BoofCV FiducialDetector.

  • @p Obj is an existing detector Java object or wrapper.

• detect (object Image)

  Detects fiducials.

  • @p Image is the input image.

• totalFound ()

  Gets the number found.

  • @r The found count.

• getId (int Index)

  Gets a fiducial id.

  • @p Index is the detection index.
  • @r The id.

• getMessage (int Index)

  Gets a fiducial message.

  • @p Index is the detection index.
  • @r The message.

• getWidth (int Index)

  Gets fiducial width.

  • @p Index is the detection index.
  • @r The width.

• is3D ()

  Gets whether this detector estimates 3D pose.

  • @r True if 3D.

• hasID ()

  Gets whether this detector reports ids.

  • @r True if ids are reported.

• hasMessage ()

  Gets whether this detector reports messages.

  • @r True if messages are reported.

• getInputType ()

  Gets the input image type.

  • @r The BoofCV ImageType.

class: MicroQrCodeDetector

[158:7] extends: object

MicroQrCodeDetector wraps boofcv.abst.fiducial.MicroQrCodePreciseDetector.

Members

• obj

Methods

• MicroQrCodeDetector (object Obj)

  Wraps a Micro QR code detector.

  • @p Obj is an existing detector Java object or wrapper.

• process (object Image)

  Processes an image.

  • @p Image is the input image.

• getDetections ()

  Gets detections.

  • @r A Java list of MicroQrCode objects.

• getFailures ()

  Gets failed detections.

  • @r A Java list of MicroQrCode objects.

• getBinary ()

  Gets the binary image.

  • @r A GrayU8 Java object.

• getImageType ()

  Gets the input image class.

  • @r A Java Class object.

class: FiducialImageEngine

[938:7] extends: object

FiducialImageEngine wraps boofcv.alg.drawing.FiducialImageEngine.

Members

• obj

Methods

• FiducialImageEngine (Obj = null)

  Creates or wraps a fiducial image render engine.

  • @p Obj is an existing engine Java object or null.

• configure (int Width, int Height)

  Configures the image size.

  • @p Width is image width.
  • @p Height is image height.

• configureBorder (int Width, int Height, int Border)

  Configures the image size and border.

  • @p Width is image width.
  • @p Height is image height.
  • @p Border is border size in pixels.

• init ()

  Initializes the renderer.

• setGray (double Gray)

  Sets grayscale draw value.

  • @p Gray is the draw value.

• getBorderPixels ()

  Gets border pixels.

  • @r The border size in pixels.

• getGray ()

  Gets the rendered GrayU8 image.

  • @r A GrayU8 Java object.

• getGrayF32 ()

  Gets the rendered GrayF32 image.

  • @r A GrayF32 Java object.

• getWhite ()

  Gets white pixel value.

  • @r The white value.

• setWhite (int White)

  Sets white pixel value.

  • @p White is the white value.

• getBlack ()

  Gets black pixel value.

  • @r The black value.

• setBlack (int Black)

  Sets black pixel value.

  • @p Black is the black value.

class: AztecCode

[846:7] extends: object

AztecCode wraps boofcv.alg.fiducial.aztec.AztecCode.

Members

• obj

Methods

• AztecCode (Obj = null)

  Creates or wraps Aztec code data.

  • @p Obj is an existing AztecCode Java object or null.

• get (string Name)

  Gets a public Aztec field.

  • @p Name is dataLayers, messageWordCount, rawbits, corrected, message, structure, failure, transposed, totalBitErrors, locator, bounds, or Hinv.
  • @r The field value.

• set (string Name, Value)

  Sets a public Aztec field.

  • @p Name is dataLayers, messageWordCount, rawbits, corrected, message, structure, failure, transposed, totalBitErrors, bounds, or Hinv.
  • @p Value is the new field value or wrapper.

• setInt (string Name, int Value)

  Sets a public integer Aztec field.

  • @p Name is dataLayers, messageWordCount, or totalBitErrors.
  • @p Value is the new integer value.

• setBool (string Name, bool Value)

  Sets a public boolean Aztec field.

  • @p Name is transposed.
  • @p Value is the new boolean value.

• getMarkerWidthSquares ()

  Gets marker width in squares.

  • @r The marker width.

• getLocatorRingCount ()

  Gets locator ring count.

  • @r The ring count.

• getLocatorWidthSquares ()

  Gets locator width in squares.

  • @r The locator width.

• getCapacityBits ()

  Gets capacity in bits.

  • @r The bit capacity.

• getCapacityWords ()

  Gets capacity in words.

  • @r The word capacity.

• getWordBitCount ()

  Gets word bit count for this code.

  • @r The word bit count.

• getCorrectionLevel ()

  Gets correction level for this code.

  • @r The correction level.

• reset ()

  Resets this Aztec code data.

• setTo (object Code)

  Copies another Aztec code into this object.

  • @p Code is an AztecCode wrapper or Java object.
  • @r This wrapper.

• copy ()

  Copies this Aztec code.

  • @r An AztecCode wrapper.

• getWordBitCountForLayers (int DataLayers)

  Gets word bit count for a data-layer count.

  • @p DataLayers is the number of data layers.
  • @r The word bit count.

class: HammingDictionary

[307:14] static extends: object

HammingDictionary wraps boofcv.factory.fiducial.HammingDictionary.

Methods

• valueOf (string Name)

  Looks up a hamming dictionary.

  • @p Name is CUSTOM, ARUCO_ORIGINAL, ARUCO_MIP_16h3, ARUCO_MIP_25h7, ARUCO_MIP_36h12, ARUCO_OCV_4x4_1000, ARUCO_OCV_5x5_1000, ARUCO_OCV_6x6_1000, ARUCO_OCV_7x7_1000, APRILTAG_16h5, APRILTAG_25h7, APRILTAG_25h9, APRILTAG_36h10, or APRILTAG_36h11.
  • @r The enum Java object.

• allPredefined ()

  Gets all predefined dictionaries.

  • @r A Java array of dictionary enum values.

class: QrCodeMaskPattern

[529:14] static extends: object

QrCodeMaskPattern exposes QR mask patterns.

Methods

• lookupMask (string Name)

  Looks up a mask pattern.

  • @p Name is M000, M001, M010, M011, M100, M101, M110, or M111.
  • @r The mask-pattern Java object.

• lookupMaskInt (int Value)

  Looks up a mask pattern by encoded integer value.

  • @p Value is 0 through 7.
  • @r The mask-pattern Java object.

• values ()

  Gets all mask patterns.

  • @r A Java list of mask-pattern values.

class: QrCodeGeneratorImage

[1353:7] extends: object

QrCodeGeneratorImage wraps boofcv.alg.fiducial.qrcode.QrCodeGeneratorImage.

Members

• obj

Methods

• QrCodeGeneratorImage (int PixelsPerModule)

  Creates a QR image generator.

  • @p PixelsPerModule is the number of pixels per QR module.

• render (object Code)

  Renders a QR code.

  • @p Code is a BoofCV QrCode object.
  • @r This generator.

• getBorderModule ()

  Gets border module count.

  • @r The border module count.

• setBorderModule (int BorderModule)

  Sets border module count.

  • @p BorderModule is the border module count.

• getGray ()

  Gets the rendered GrayU8 image.

  • @r A GrayU8 Java object.

• getGrayF32 ()

  Gets the rendered GrayF32 image.

  • @r A GrayF32 Java object.

class: QrCode

[552:7] extends: object

QrCode wraps boofcv.alg.fiducial.qrcode.QrCode.

Members

• obj

Methods

• QrCode (Obj = null)

  Creates or wraps QR code data.

  • @p Obj is an existing QrCode Java object or null.

• get (string Name)

  Gets a public QR field.

  • @p Name is ppRight, ppCorner, ppDown, threshRight, threshCorner, threshDown, threshDownRight, version, error, mask, alignment, mode, byteEncoding, rawbits, corrected, message, failureCause, bounds, Hinv, totalBitErrors, or bitsTransposed.
  • @r The field value.

• set (string Name, Value)

  Sets a public QR field.

  • @p Name is ppRight, ppCorner, ppDown, threshRight, threshCorner, threshDown, threshDownRight, version, error, mask, alignment, mode, byteEncoding, rawbits, corrected, message, failureCause, bounds, Hinv, totalBitErrors, or bitsTransposed.
  • @p Value is the new field value or wrapper.

• setInt (string Name, int Value)

  Sets a public integer QR field.

  • @p Name is version or totalBitErrors.
  • @p Value is the new integer value.

• setDouble (string Name, double Value)

  Sets a public floating-point QR field.

  • @p Name is threshRight, threshCorner, threshDown, or threshDownRight.
  • @p Value is the new floating-point value.

• setBool (string Name, bool Value)

  Sets a public boolean QR field.

  • @p Name is bitsTransposed.
  • @p Value is the new boolean value.

• getNumberOfModules ()

  Gets the number of modules for this version.

  • @r The module count.

• getNumberOfDataBytes ()

  Gets the number of data bytes for this version and error level.

  • @r The data byte count.

• reset ()

  Resets this QR code data.

• setTo (object Code)

  Copies another QR code into this object.

  • @p Code is a QrCode wrapper or Java object.
  • @r This wrapper.

• copy ()

  Copies this QR code.

  • @r A QrCode wrapper.

• totalModules (int Version)

  Computes the total module count for a QR version.

  • @p Version is 1 through 40.
  • @r The module count.

class: AztecGenerator

[1472:7] extends: object

AztecGenerator wraps boofcv.alg.fiducial.aztec.AztecGenerator.

Members

• obj

Methods

• AztecGenerator ()

  Creates an Aztec generator.

• render (object Code)

  Renders an Aztec code.

  • @p Code is an AztecCode Java object.
  • @r This generator.

• setMarkerWidth (double Width)

  Sets marker width.

  • @p Width is the marker width.
  • @r This generator.

• getMarkerWidth ()

  Gets marker width.

  • @r The marker width.

• getRender ()

  Gets the render engine.

  • @r A FiducialRenderEngine Java object.

• renderImage (int PixelsPerModule, int BorderModule, object Code)

  Renders an Aztec code to a GrayU8 image.

  • @p PixelsPerModule is pixels per module.
  • @p BorderModule is border module count.
  • @p Code is an AztecCode Java object.
  • @r A GrayU8 Java object.

class: QrCodeErrorLevel

[466:14] static extends: object

QrCodeErrorLevel exposes QrCode.ErrorLevel values.

Methods

• valueOf (string Name)

  Gets an error level.

  • @p Name is L, M, Q, or H.
  • @r The enum Java object.

• lookup (int Value)

  Looks up an error level by encoded integer value.

  • @p Value is the QR error-level encoding.
  • @r The enum Java object.

• values ()

  Gets all error levels.

  • @r A Java array of enum values.

class: FiducialTracker

[292:7] extends: FiducialDetector

FiducialTracker wraps boofcv.abst.fiducial.FiducialTracker.

Methods

• FiducialTracker (object Obj)

  Wraps a BoofCV FiducialTracker.

  • @p Obj is an existing tracker Java object or wrapper.

• reset ()

  Resets tracker state.

class: ConfigECoCheckDetector

[1080:7] extends: FiducialConfig

ConfigECoCheckDetector wraps boofcv.abst.fiducial.calib.ConfigECoCheckDetector.

Methods

• ConfigECoCheckDetector (Obj = null)

  Creates or wraps an ECoCheck detector config.

  • @p Obj is an existing config Java object or null.

• setTo (object Config)

  Copies another config into this object.

  • @p Config is a ConfigECoCheckDetector wrapper or Java object.
  • @r This wrapper.

class: AztecCodeDetector

[195:7] extends: object

AztecCodeDetector wraps boofcv.abst.fiducial.AztecCodePreciseDetector.

Members

• obj

Methods

• AztecCodeDetector (object Obj)

  Wraps an Aztec code detector.

  • @p Obj is an existing detector Java object or wrapper.

• process (object Image)

  Processes an image.

  • @p Image is the input image.

• getDetections ()

  Gets detections.

  • @r A Java list of AztecCode objects.

• getFailures ()

  Gets failed detections.

  • @r A Java list of AztecCode objects.

• getBinary ()

  Gets the binary image.

  • @r A GrayU8 Java object.

• getImageType ()

  Gets the input image class.

  • @r A Java Class object.

class: FiducialSquareGenerator

[1513:7] extends: object

FiducialSquareGenerator wraps boofcv.alg.fiducial.square.FiducialSquareGenerator.

Members

• obj

Methods

• FiducialSquareGenerator (object RenderEngine)

  Creates a square fiducial generator.

  • @p RenderEngine is a FiducialRenderEngine Java object.

• generateImage (object Image)

  Generates from a binary image.

  • @p Image is a GrayU8 image.

• generate (int Value, int GridWidth)

  Generates from an integer value.

  • @p Value is encoded value.
  • @p GridWidth is grid width.

• getWhiteBorderDoc ()

  Gets white border fraction.

  • @r White border fraction.

• setWhiteBorderDoc (double Fraction)

  Sets white border fraction.

  • @p Fraction is white border fraction.

• getBlackBorder ()

  Gets black border fraction.

  • @r Black border fraction.

• setBlackBorder (double Fraction)

  Sets black border fraction.

  • @p Fraction is black border fraction.

class: MicroQrCode

[671:7] extends: object

MicroQrCode wraps boofcv.alg.fiducial.microqr.MicroQrCode.

Members

• obj

Methods

• MicroQrCode (Obj = null)

  Creates or wraps Micro QR code data.

  • @p Obj is an existing MicroQrCode Java object or null.

• get (string Name)

  Gets a public Micro QR field.

  • @p Name is version, error, pp, thresholdPP, mode, mask, byteEncoding, rawbits, corrected, message, bounds, Hinv, bitsTransposed, totalBitErrors, or failureCause.
  • @r The field value.

• set (string Name, Value)

  Sets a public Micro QR field.

  • @p Name is version, error, pp, thresholdPP, mode, mask, byteEncoding, rawbits, corrected, message, bounds, Hinv, bitsTransposed, totalBitErrors, or failureCause.
  • @p Value is the new field value or wrapper.

• setInt (string Name, int Value)

  Sets a public integer Micro QR field.

  • @p Name is version or totalBitErrors.
  • @p Value is the new integer value.

• setDouble (string Name, double Value)

  Sets a public floating-point Micro QR field.

  • @p Name is thresholdPP.
  • @p Value is the new floating-point value.

• setBool (string Name, bool Value)

  Sets a public boolean Micro QR field.

  • @p Name is bitsTransposed.
  • @p Value is the new boolean value.

• reset ()

  Resets this Micro QR code data.

• setTo (object Code)

  Copies another Micro QR code into this object.

  • @p Code is a MicroQrCode wrapper or Java object.
  • @r This wrapper.

• copy ()

  Copies this Micro QR code.

  • @r A MicroQrCode wrapper.

• terminatorBits ()

  Gets the number of terminator bits.

  • @r The terminator bit count.

• encodeFormatBits ()

  Encodes format bits from this object's version, error level, and mask.

  • @r The encoded bits.

• decodeFormatBits (int Bits)

  Decodes format bits into this object.

  • @p Bits is encoded format bits.
  • @r True if decoded.

• encodeVersionAndEccLevel ()

  Encodes version and error-correction level.

  • @r The encoded value.

• decodeVersionAndECC (int Bits)

  Decodes version and error-correction level into this object.

  • @p Bits is encoded version/ecc bits.
  • @r True if decoded.

• getNumberOfModules ()

  Gets the number of modules for this version.

  • @r The module count.

• getMaxDataBits ()

  Gets maximum data bits for this version and error level.

  • @r The maximum data bit count.

• getNumberOfDataCodeWords ()

  Gets the number of data code words.

  • @r The data code-word count.

• getNumberOfErrorCodeWords ()

  Gets the number of error code words.

  • @r The error code-word count.

• totalModules (int Version)

  Computes the total module count for a Micro QR version.

  • @p Version is 1 through 4.
  • @r The module count.

• maxDataBits (int Version, object ErrorLevel)

  Computes maximum data bits.

  • @p Version is 1 through 4.
  • @p ErrorLevel is a MicroQrCodeErrorLevel value.
  • @r The maximum data bit count.

• allowedErrorCorrection (int Version)

  Gets allowed error-correction levels.

  • @p Version is 1 through 4.
  • @r A Java array of MicroQrCodeErrorLevel values.

• modeIndicatorBitCount (int Version)

  Gets mode-indicator bit count.

  • @p Version is 1 through 4.
  • @r The bit count.

• allowedModes (int Version)

  Gets allowed modes.

  • @p Version is 1 through 4.
  • @r A Java array of QrCodeMode values.

• valueToMode (int Value)

  Converts an encoded value to a QR mode.

  • @p Value is the encoded mode.
  • @r A QrCodeMode enum Java object.

class: MicroQrCodeErrorLevel

[625:14] static extends: object

MicroQrCodeErrorLevel exposes MicroQrCode.ErrorLevel values.

Methods

• valueOf (string Name)

  Gets an error level.

  • @p Name is DETECT, L, M, or Q.
  • @r The enum Java object.

• lookup (string Name)

  Looks up an error level by name.

  • @p Name is DETECT, L, M, or Q.
  • @r The enum Java object.

• values ()

  Gets all error levels.

  • @r A Java array of enum values.

class: ConfigAztecCode

[1649:7] extends: object

ConfigAztecCode wraps boofcv.factory.fiducial.ConfigAztecCode.

Members

• obj

Methods

• ConfigAztecCode (Obj = null)

  Creates or wraps an Aztec code config.

  • @p Obj is an existing config Java object or null to create a default config.

• fast ()

  Creates a fast Aztec config.

  • @r A ConfigAztecCode wrapper.

• get (string Name)

  Gets a public config field.

  • @p Name is threshold, polygon, considerTransposed, or maxOrientationError.
  • @r The field value.

• set (string Name, Value)

  Sets a public config field.

  • @p Name is threshold, polygon, considerTransposed, or maxOrientationError.
  • @p Value is the new field value.

• checkValidity ()

  Validates this config.

class: AztecCodeStructure

[812:14] static extends: object

AztecCodeStructure exposes AztecCode.Structure values.

Methods

• valueOf (string Name)

  Gets an Aztec structure.

  • @p Name is COMPACT or FULL.
  • @r The enum Java object.

• values ()

  Gets all structures.

  • @r A Java array of enum values.

class: HammingChessboardGenerator

[1228:7] extends: object

HammingChessboardGenerator wraps boofcv.alg.fiducial.calib.hammingchess.HammingChessboardGenerator.

Members

• obj

Methods

• HammingChessboardGenerator (object Config)

  Creates a hamming chessboard generator.

  • @p Config is a ConfigHammingChessboard wrapper.

• render ()

  Renders the board using the configured render engine.

• saveCornerLocations ()

  Saves generated corner locations.

• setSquareWidth (double Width)

  Sets square width.

  • @p Width is square width in document units.

• getSquareWidth ()

  Gets square width.

  • @r The square width.

• setRender (object Render)

  Sets the render engine.

  • @p Render is a FiducialImageEngine or FiducialRenderEngine Java object.

• get (string Name)

  Gets a public generator field.

  • @p Name is squareWidth or corners.
  • @r The field value.

class: MicroQrCodeMaskPattern

[648:14] static extends: object

MicroQrCodeMaskPattern exposes Micro QR mask patterns.

Methods

• lookupMask (string Name)

  Looks up a mask pattern.

  • @p Name is M00, M01, M10, M11, or NONE.
  • @r The mask-pattern Java object.

• lookupMaskInt (int Value)

  Looks up a mask pattern by encoded integer value.

  • @p Value is 0 through 3.
  • @r The mask-pattern Java object.

• values ()

  Gets all mask patterns.

  • @r A Java list of mask-pattern values.

class: QrCodeGenerator

[1391:7] extends: object

QrCodeGenerator wraps boofcv.alg.fiducial.qrcode.QrCodeGenerator.

Members

• obj

Methods

• QrCodeGenerator (MarkerWidth = null)

  Creates a QR code generator.

  • @p MarkerWidth is optional marker width in document units.

• render (object Code)

  Renders a QR code.

  • @p Code is a QrCode Java object.
  • @r This generator.

class: ConfigECoCheckMarkers

[1097:7] extends: FiducialConfig

ConfigECoCheckMarkers wraps boofcv.abst.fiducial.calib.ConfigECoCheckMarkers.

Methods

• ConfigECoCheckMarkers (Obj = null)

  Creates or wraps ECoCheck marker config.

  • @p Obj is an existing config Java object or null.

• setTo (object Config)

  Copies another config into this object.

  • @p Config is a ConfigECoCheckMarkers wrapper or Java object.
  • @r This wrapper.

• compactName ()

  Gets the compact config name.

  • @r The compact name.

• singleShape (int Rows, int Cols, int DataRows, double SquareSize)

  Creates a single-shape config.

  • @p Rows is grid rows.
  • @p Cols is grid columns.
  • @p DataRows is encoded data rows.
  • @p SquareSize is square size.
  • @r A ConfigECoCheckMarkers wrapper.

• parse (string Text, double SquareSize)

  Parses a compact marker description.

  • @p Text is the compact description accepted by BoofCV.
  • @p SquareSize is square size.
  • @r A ConfigECoCheckMarkers wrapper.

class: ConfigMicroQrCode

[1616:7] extends: object

ConfigMicroQrCode wraps boofcv.factory.fiducial.ConfigMicroQrCode.

Members

• obj

Methods

• ConfigMicroQrCode (Obj = null)

  Creates or wraps a Micro QR code config.

  • @p Obj is an existing config Java object or null to create a default config.

• fast ()

  Creates a fast Micro QR config.

  • @r A ConfigMicroQrCode wrapper.

• get (string Name)

  Gets a public config field.

  • @p Name is threshold, polygon, forceEncoding, defaultEncoding, considerTransposed, or ignorePaddingBytes.
  • @r The field value.

• set (string Name, Value)

  Sets a public config field.

  • @p Name is threshold, polygon, forceEncoding, defaultEncoding, considerTransposed, or ignorePaddingBytes.
  • @p Value is the new field value.

• checkValidity ()

  Validates this config.

class: ConfigUchiyaMarker

[416:7] extends: FiducialConfig

ConfigUchiyaMarker wraps boofcv.factory.fiducial.ConfigUchiyaMarker.

Methods

• ConfigUchiyaMarker (Obj = null)

  Creates or wraps a Uchiya marker config.

  • @p Obj is an existing config or null.