BunyipsLib/org.murraybridgebunyips.bunyipslib.vision.processors/ColourThreshold

ColourThreshold

abstract class ColourThreshold : Processor<T>

Colour thresholding processor for a colour space, used to find colour contours in an image.

Author

Lucas Bubner, 2024

Since

1.0.0-pre

Inheritors

Constructors

ColourThreshold

constructor(colourSpace: ColourThreshold.ColourSpace)

Defines a new colour thresholding processor for a specific colour space, which your lower and upper scalars will be based on.

Types

ColourSpace

enum ColourSpace

The colour spaces that can be used for thresholding.

Properties

BIGGEST_CONTOUR_BORDER_THICKNESS

open var BIGGEST_CONTOUR_BORDER_THICKNESS: Int

The thickness of the border to draw around the biggest contour.

colourSpace

val colourSpace: ColourThreshold.ColourSpace

The colour space to use for thresholding.

CONTOUR_BORDER_THICKNESS

open var CONTOUR_BORDER_THICKNESS: Int

The thickness of the border to draw around all contours.

DEFAULT_MAX_AREA

protected open var DEFAULT_MAX_AREA: Double

DEFAULT_MIN_AREA

protected open var DEFAULT_MIN_AREA: Double

Inherited properties

cameraDimensions

@get:Nullable

protected open val cameraDimensions: Size

data

protected val data: List<T>

List of all vision data detected since the last stateful update

isFlipped

open var isFlipped: Boolean

isRunning

open val isRunning: Boolean

Functions

getBoxColour

abstract fun getBoxColour(): Int

getContourAreaMaxPercent

abstract fun getContourAreaMaxPercent(): Double

getContourAreaMinPercent

abstract fun getContourAreaMinPercent(): Double

getLower

open fun getLower(): Scalar

Gets the lower scalar to use for thresholding.

getUpper

open fun getUpper(): Scalar

Gets the upper scalar to use for thresholding.

onFrameDraw

protected fun onFrameDraw(canvas: Canvas)

Called by the vision system to draw on the frame.

onProcessFrame

protected fun onProcessFrame(frame: Mat, captureTimeNanos: Long)

Called by the vision system to process a frame

resetLower

open fun resetLower()

Resets the lower override, so that the lower scalar is used instead of the override.

resetUpper

open fun resetUpper()

Resets the upper override, so that the upper scalar is used instead of the override.

setLower

protected abstract fun setLower(): Scalar

open fun setLower(lower: Scalar)

Forces this upper scalar to be used instead of the scalar supplied by the subclass.

setUpper

protected abstract fun setUpper(): Scalar

open fun setUpper(upper: Scalar)

Forces this lower scalar to be used instead of the scalar supplied by the subclass.

showMaskedInput

abstract fun showMaskedInput(): Boolean

update

protected fun update()

Called to update new data from the vision system, which involves interpreting, collecting, or otherwise processing new vision data per frame.

Inherited functions

clearData

open fun clearData()

Manually clear the data list.

delegate

open fun delegate(@NonNull delegateTo: Processor)

Delegate this processor to another processor.

getData

open fun getData(): ArrayList<T>

Get the list of vision data.

getFrameBitmap

abstract fun getFrameBitmap(p: Continuation<out Consumer<Bitmap>>)

open fun getFrameBitmap(continuation: Continuation<out Consumer<Bitmap>>)

init

abstract fun init(p: Int, p1: Int, p2: CameraCalibration)

open fun init(width: Int, height: Int, calibration: CameraCalibration)

isAttached

open fun isAttached(): Boolean

Determine whether the processor is attached to a Vision instance.

onAttach

protected open fun onAttach()

Override this method to run any additional code that will be executed when this processor is attached (via init()) by a Vision instance.

onDrawFrame

abstract fun onDrawFrame(p: Canvas, p1: Int, p2: Int, p3: Float, p4: Float, p5: Any)

fun onDrawFrame(canvas: Canvas, onscreenWidth: Int, onscreenHeight: Int, scaleBmpPxToCanvasPx: Float, scaleCanvasDensity: Float, userContext: Any)

Use onFrameDraw instead, which passes a canvas.

onRunning

protected open fun onRunning()

Override this method to run any additional code that will be executed when this processor starts streaming (via start()) on a Vision instance.

processFrame

abstract fun processFrame(p: Mat, p1: Long): Any

fun processFrame(f: Mat, captureTimeNanos: Long): Any

toString

@NonNull

abstract fun toString(): String

Unique identifier for the processor.