Objeck Documentation

All Bundles

Image

OpenCV image

Operations

Bytes
Columns
Convert
DrawCircle
DrawRectangle
DrawText
IsEmpty
Load
Resize
Rows
Show
Size
Type

Bytes

Gets image bytes

method : public : Bytes() ~ Byte[]

Return

Type	Description
Byte	image bytes

Columns

Gets image columns

method : public : Columns() ~ Int

Return

Type	Description
Int	image columns

Convert

Convert an image to a given byte format

method : public : Convert(format:Image->Format) ~ Byte[]

Parameters

Name	Type	Description
format	Image->Format	output format

Return

Type	Description
Byte	converted image bytes

DrawCircle

Draws a bounding circle

method : public : DrawCircle(pt:Point, radius:Int, color:Scalar, thickness:Int, type:LineType) ~ API.OpenCV.Image

Parameters

Name	Type	Description
pt	Point	circle center
radius	Int	circle radius
color	Scalar	bounding circle color
thickness	Int	bounding circle thickness
type	LineType	bounding circle type

Return

Type	Description
Image	updated image

DrawRectangle

Draws a bounding rectangle

method : public : DrawRectangle(rect:Rect, color:Scalar, thickness:Int, type:LineType) ~ API.OpenCV.Image

Parameters

Name	Type	Description
rect	Rect	bounding rectangle
color	Scalar	bounding rectangle color
thickness	Int	bounding rectangle thickness
type	LineType	bounding rectangle type

Return

Type	Description
Image	updated image

DrawText

Draws text on an image

method : public : DrawText(text:String, font:Font, color:Scalar, thickness:Int, type:LineType) ~ API.OpenCV.Image

Parameters

Name	Type	Description
text	String	text to draw
font	Font	text font
color	Scalar	bounding circle color
thickness	Int	bounding circle thickness
type	LineType	bounding circle type

Return

Type	Description
Image	updated image

IsEmpty

Determines if an image is empty

method : public : IsEmpty() ~ Bool

Return

Type	Description
Bool	true if empty, false otherwise

Load

Load image from file

function : Load(image_path:String) ~ API.OpenCV.Image

Parameters

Name	Type	Description
image_path	String	image file path

Return

Type	Description
Image	loaded image

Load

Load image from bytes

function : Load() ~ API.OpenCV.Image

Parameters

Name	Type	Description

Return

Type	Description
Image	loaded image

Resize

Resizes an image

method : public : Resize(sz:Size, fx:Float, fy:Float, interpolation:InterpolationFlags) ~ API.OpenCV.Image

Parameters

Name	Type	Description
sz	Size	image size
fx	Float	x-scale factor
fy	Float	y-scale factor
interpolation	InterpolationFlags	filling missing pixels method

Return

Type	Description
Image	updated image

Resize

Resizes an image

method : public : Resize(fx:Float, fy:Float, interpolation:InterpolationFlags) ~ API.OpenCV.Image

Parameters

Name	Type	Description
fx	Float	x-scale factor
fy	Float	y-scale factor
interpolation	InterpolationFlags	filling missing pixels method

Return

Type	Description
Image	updated image

Resize

Resizes an image

method : public : Resize(f:Float, ) ~ API.OpenCV.Image

Parameters

Name	Type	Description
f	Float	scale factor

Return

Type	Description
Image	updated image

Rows

Gets image rows

method : public : Rows() ~ Int

Return

Type	Description
Int	image rows

Show

Shows an image

method : public : Show(title:String) ~ Nil

Parameters

Name	Type	Description
title	String	dialog title

Show

Shows an image

method : public : Show(title:String, scale:Float) ~ Nil

Parameters

Name	Type	Description
title	String	dialog title
scale	Float	scaling percentage

Show

Shows an image

method : public : Show(title:String, scale:Float, ) ~ Nil

Parameters

Name	Type	Description
title	String	dialog title
scale	Float	scaling percentage

Size

Gets image size

method : public : Size() ~ Int

Return

Type	Description
Int	image size

Type

Gets image type

method : public : Type() ~ Int

Return

Type	Description
Int	image type