oa::FnImage

FnImage namespace in the OA Vision public surface.

NsC++ public headers

Public Functions

oa::Matrix oa::FnImage::adaptiveThresholdGaussian(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelSize = 11, oa::F32 inC = 0.0F, oa::F32 inMaxValue = 1.0F, oa::F32 inSigma = 0.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

oa::Matrix oa::FnImage::adaptiveThresholdMean(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelSize = 11, oa::F32 inC = 0.0F, oa::F32 inMaxValue = 1.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

oa::Matrix oa::FnImage::alphaBlend(oa::Engine & inEngine, const oa::Matrix & inA, const oa::Matrix & inB, oa::F32 inAlpha)

oa::Matrix oa::FnImage::averageBlur(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

oa::Matrix oa::FnImage::bilateralFilter(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelSize = 5, oa::F32 inSigmaColor = 0.1F, oa::F32 inSigmaSpace = 1.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

oa::Matrix oa::FnImage::brightnessContrast(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inBrightness = 0.0F, oa::F32 inContrast = 1.0F)

bool oa::FnImage::canDecode(ImageCodec inCodec)

bool oa::FnImage::canEncode(ImageCodec inCodec)

oa::Matrix oa::FnImage::centerCrop(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inWidth, oa::U32 inHeight)

oa::Matrix oa::FnImage::channelReorder(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inChannel0, oa::U32 inChannel1 = 1, oa::U32 inChannel2 = 2, oa::U32 inChannel3 = 3)

oa::Matrix oa::FnImage::clamp(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inLow, oa::F32 inHigh)

oa::Matrix oa::FnImage::colorTwist(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inTransform)

oa::Matrix oa::FnImage::composite(oa::Engine & inEngine, const oa::Matrix & inA, const oa::Matrix & inB, const oa::Matrix & inMask)

Image oa::FnImage::convertColor(const Image & inImage, ImageFormat inDstFormat)

oa::Matrix oa::FnImage::convolve2d(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inKernel, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

oa::Matrix oa::FnImage::crop(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inX, oa::U32 inY, oa::U32 inWidth, oa::U32 inHeight)

oa::Result<Image> oa::FnImage::decodeFile(const oa::Path & inPath, ImageFormat inFormat = ImageFormat::Rgb)

oa::Result<Image> oa::FnImage::decodeMemory(oa::Span<const oa::U8> inData, ImageFormat inFormat = ImageFormat::Rgb)

oa::Matrix oa::FnImage::dilate(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

oa::Result<oa::Vector<oa::U8>> oa::FnImage::encode(const Image & inImage, ImageCodec inCodec, oa::U32 inQuality = 90U)

oa::Matrix oa::FnImage::erase(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inX, oa::U32 inY, oa::U32 inWidth, oa::U32 inHeight, oa::F32 inValue = 0.0F)

oa::Matrix oa::FnImage::erode(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

oa::Matrix oa::FnImage::flip(oa::Engine & inEngine, const oa::Matrix & inImage, bool inHorizontal = false, bool inVertical = false)

oa::Matrix oa::FnImage::gammaContrast(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inGamma, oa::F32 inGain = 1.0F)

oa::Matrix oa::FnImage::gaussianBlur(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inSigma, oa::U32 inKernelSize = 0)

oa::Matrix oa::FnImage::gaussianNoise(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inMean = 0.0F, oa::F32 inStddev = 0.01F, oa::U64 inSeed = 0)

oa::Matrix oa::FnImage::grayscale(oa::Engine & inEngine, const oa::Matrix & inImage)

oa::Matrix oa::FnImage::inRange(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inLow, oa::F32 inHigh, oa::F32 inTrueValue = 1.0F)

oa::Matrix oa::FnImage::invert(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inMaxValue = 1.0F)

oa::Matrix oa::FnImage::laplacian(oa::Engine & inEngine, const oa::Matrix & inImage, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

oa::Matrix oa::FnImage::medianBlur(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelSize = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

oa::Matrix oa::FnImage::morphologyBlackHat(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

oa::Matrix oa::FnImage::morphologyClose(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

oa::Matrix oa::FnImage::morphologyGradient(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

oa::Matrix oa::FnImage::morphologyOpen(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

oa::Matrix oa::FnImage::morphologyTopHat(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

oa::Matrix oa::FnImage::normalize(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::NormalizationParams & inParams)

oa::Matrix oa::FnImage::pad(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inLeft, oa::U32 inRight, oa::U32 inTop, oa::U32 inBottom, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)

oa::Matrix oa::FnImage::posterize(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inLevels, oa::F32 inLow = 0.0F, oa::F32 inHigh = 1.0F)

oa::Matrix oa::FnImage::remap(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inMap, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)

oa::Matrix oa::FnImage::resize(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inTargetWidth, oa::U32 inTargetHeight, oa::InterpolationMode inMode = oa::InterpolationMode::Bilinear)

Image oa::FnImage::resizeNormalize(const Image & inImage, oa::U32 inWidth, oa::U32 inHeight, const NormalizationParams & inParams)

oa::Matrix oa::FnImage::rotate(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inDegrees)

oa::Matrix oa::FnImage::saltPepperNoise(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inProbability = 0.01F, oa::F32 inSaltValue = 1.0F, oa::F32 inPepperValue = 0.0F, oa::U64 inSeed = 0)

oa::Status oa::FnImage::saveFile(const oa::Path & inPath, const Image & inImage, oa::U32 inQuality = 90U)

oa::Status oa::FnImage::saveRgbaFile(oa::Span<const oa::U8> inRgba, oa::U32 inWidth, oa::U32 inHeight, oa::StringView inPath, oa::U32 inQuality = 90U)

oa::Status oa::FnImage::saveTextureFile(Engine & inEngine, const oa::Texture & inTexture, oa::StringView inPath)

oa::Matrix oa::FnImage::scharr(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inDx = 1, oa::U32 inDy = 0, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

Matrix oa::FnImage::segmentationOverlay(Engine & inRt, const Matrix & inImage, const Matrix & inMask, const Matrix & inPalette, oa::F32 inAlpha = 0.5F)

oa::Matrix oa::FnImage::separableConvolve2d(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inKernelX, const oa::Matrix & inKernelY, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

oa::Matrix oa::FnImage::sharpen(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inAmount = 1.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

oa::Matrix oa::FnImage::sobel(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inDx = 1, oa::U32 inDy = 0, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

oa::Matrix oa::FnImage::solarize(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inThreshold = 0.5F, oa::F32 inMaxValue = 1.0F)

oa::Matrix oa::FnImage::thresholdBinary(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inThreshold, oa::F32 inMaxValue = 1.0F)

oa::Matrix oa::FnImage::thresholdBinaryInv(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inThreshold, oa::F32 inMaxValue = 1.0F)

oa::Matrix oa::FnImage::thresholdToZero(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inThreshold)

oa::Matrix oa::FnImage::thresholdToZeroInv(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inThreshold)

oa::Matrix oa::FnImage::thresholdTruncate(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inThreshold)

oa::Matrix oa::FnImage::unsharpMask(oa::Engine & inEngine, const oa::Matrix & inImage, oa::F32 inSigma = 1.0F, oa::F32 inAmount = 1.0F, oa::U32 inKernelSize = 0)

oa::Matrix oa::FnImage::warpAffine(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inTransform, oa::U32 inWidth, oa::U32 inHeight, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)

oa::Matrix oa::FnImage::warpPerspective(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inTransform, oa::U32 inWidth, oa::U32 inHeight, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)

Function Documentation

oa::Matrix oa::FnImage::adaptiveThresholdGaussian(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelSize = 11,
	oa::F32 inC = 0.0F,
	oa::F32 inMaxValue = 1.0F,
	oa::F32 inSigma = 0.0F,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)
oa::Matrix oa::FnImage::adaptiveThresholdGaussian(
	const oa::Matrix & inImage,
	oa::U32 inKernelSize = 11,
	oa::F32 inC = 0.0F,
	oa::F32 inMaxValue = 1.0F,
	oa::F32 inSigma = 0.0F,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)

adaptiveThresholdGaussian: Local Gaussian adaptive binary threshold.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelSize

oa::U32

Default: 11

inC

oa::F32

Default: 0.0F

inMaxValue

oa::F32

Default: 1.0F

inSigma

oa::F32

Default: 0.0F

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::adaptiveThresholdMean(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelSize = 11,
	oa::F32 inC = 0.0F,
	oa::F32 inMaxValue = 1.0F,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)
oa::Matrix oa::FnImage::adaptiveThresholdMean(
	const oa::Matrix & inImage,
	oa::U32 inKernelSize = 11,
	oa::F32 inC = 0.0F,
	oa::F32 inMaxValue = 1.0F,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)

adaptiveThresholdMean: Local mean adaptive binary threshold.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelSize

oa::U32

Default: 11

inC

oa::F32

Default: 0.0F

inMaxValue

oa::F32

Default: 1.0F

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::alphaBlend(
	oa::Engine & inEngine,
	const oa::Matrix & inA,
	const oa::Matrix & inB,
	oa::F32 inAlpha
)
oa::Matrix oa::FnImage::alphaBlend(
	const oa::Matrix & inA,
	const oa::Matrix & inB,
	oa::F32 inAlpha
)

alphaBlend: Scalar alpha blend of equal-shaped images.

Parameters

inEngine

oa::Engine &

—

inA

const oa::Matrix &

—

inB

const oa::Matrix &

—

inAlpha

oa::F32

—

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::averageBlur(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)
oa::Matrix oa::FnImage::averageBlur(
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)

averageBlur: Normalized box blur lowered through the generic 2D filter.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelWidth

oa::U32

Default: 3

inKernelHeight

oa::U32

Default: 3

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::bilateralFilter(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelSize = 5,
	oa::F32 inSigmaColor = 0.1F,
	oa::F32 inSigmaSpace = 1.0F,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)
oa::Matrix oa::FnImage::bilateralFilter(
	const oa::Matrix & inImage,
	oa::U32 inKernelSize = 5,
	oa::F32 inSigmaColor = 0.1F,
	oa::F32 inSigmaSpace = 1.0F,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)

bilateralFilter: Edge-preserving bilateral neighborhood filter.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelSize

oa::U32

Default: 5

inSigmaColor

oa::F32

Default: 0.1F

inSigmaSpace

oa::F32

Default: 1.0F

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::brightnessContrast(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inBrightness = 0.0F,
	oa::F32 inContrast = 1.0F
)
oa::Matrix oa::FnImage::brightnessContrast(
	const oa::Matrix & inImage,
	oa::F32 inBrightness = 0.0F,
	oa::F32 inContrast = 1.0F
)
Image oa::FnImage::brightnessContrast(
	const Image & inImage,
	oa::F32 inBrightness = 0.0F,
	oa::F32 inContrast = 1.0F
)

brightnessContrast: Affine brightness and contrast adjustment.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inBrightness

oa::F32

Default: 0.0F

inContrast

oa::F32

Default: 1.0F

Returns

oa::Matrix

The declared return value.

bool oa::FnImage::canDecode(
	ImageCodec inCodec
)

No public source comment is attached to this declaration.

Parameters

inCodec

ImageCodec

—

Returns

bool

The declared return value.

bool oa::FnImage::canEncode(
	ImageCodec inCodec
)

No public source comment is attached to this declaration.

Parameters

inCodec

ImageCodec

—

Returns

bool

The declared return value.

oa::Matrix oa::FnImage::centerCrop(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inWidth,
	oa::U32 inHeight
)
oa::Matrix oa::FnImage::centerCrop(
	const oa::Matrix & inImage,
	oa::U32 inWidth,
	oa::U32 inHeight
)

centerCrop: Centered crop lowered through Crop.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inWidth

oa::U32

—

inHeight

oa::U32

—

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::channelReorder(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inChannel0,
	oa::U32 inChannel1 = 1,
	oa::U32 inChannel2 = 2,
	oa::U32 inChannel3 = 3
)
oa::Matrix oa::FnImage::channelReorder(
	const oa::Matrix & inImage,
	oa::U32 inChannel0,
	oa::U32 inChannel1 = 1,
	oa::U32 inChannel2 = 2,
	oa::U32 inChannel3 = 3
)

channelReorder: Reorder one to four NCHW channels.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inChannel0

oa::U32

—

inChannel1

oa::U32

Default: 1

inChannel2

oa::U32

Default: 2

inChannel3

oa::U32

Default: 3

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::clamp(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inLow,
	oa::F32 inHigh
)
oa::Matrix oa::FnImage::clamp(
	const oa::Matrix & inImage,
	oa::F32 inLow,
	oa::F32 inHigh
)

clamp: Clamp image values to a scalar interval.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inLow

oa::F32

—

inHigh

oa::F32

—

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::colorTwist(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	const oa::Matrix & inTransform
)
oa::Matrix oa::FnImage::colorTwist(
	const oa::Matrix & inImage,
	const oa::Matrix & inTransform
)

colorTwist: Apply a shared 3x4 RGB color transform matrix.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inTransform

const oa::Matrix &

—

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::composite(
	oa::Engine & inEngine,
	const oa::Matrix & inA,
	const oa::Matrix & inB,
	const oa::Matrix & inMask
)
oa::Matrix oa::FnImage::composite(
	const oa::Matrix & inA,
	const oa::Matrix & inB,
	const oa::Matrix & inMask
)

composite: Per-pixel masked composite with one or C mask channels.

Parameters

inEngine

oa::Engine &

—

inA

const oa::Matrix &

—

inB

const oa::Matrix &

—

inMask

const oa::Matrix &

—

Returns

oa::Matrix

The declared return value.

Image oa::FnImage::convertColor(
	const Image & inImage,
	ImageFormat inDstFormat
)

No public source comment is attached to this declaration.

Parameters

inImage

const Image &

—

inDstFormat

ImageFormat

—

Returns

Image

The declared return value.

oa::Matrix oa::FnImage::convolve2d(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	const oa::Matrix & inKernel,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::convolve2d(
	const oa::Matrix & inImage,
	const oa::Matrix & inKernel,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)

convolve2d: Same-shape NCHW 2D cross-correlation with an odd shared kernel and explicit border semantics.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernel

const oa::Matrix &

—

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::crop(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inX,
	oa::U32 inY,
	oa::U32 inWidth,
	oa::U32 inHeight
)
oa::Matrix oa::FnImage::crop(
	const oa::Matrix & inImage,
	oa::U32 inX,
	oa::U32 inY,
	oa::U32 inWidth,
	oa::U32 inHeight
)

crop: Crop NCHW image: out = A[y:y+h, x:x+w].

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inX

oa::U32

—

inY

oa::U32

—

inWidth

oa::U32

—

inHeight

oa::U32

—

Returns

oa::Matrix

The declared return value.

oa::Result<Image> oa::FnImage::decodeFile(
	const oa::Path & inPath,
	ImageFormat inFormat = ImageFormat::Rgb
)

Stateless still-image codec boundaries. Decode uploads one normalized Float32 NCHW image through the active engine. Encode and saveFile are explicit synchronous host boundaries which complete and read back their semantic image input.

Parameters

inPath

const oa::Path &

—

inFormat

ImageFormat

Default: ImageFormat::Rgb

Returns

oa::Result<Image>

The declared return value.

oa::Result<Image> oa::FnImage::decodeMemory(
	oa::Span<const oa::U8> inData,
	ImageFormat inFormat = ImageFormat::Rgb
)

No public source comment is attached to this declaration.

Parameters

inData

oa::Span<const oa::U8>

—

inFormat

ImageFormat

Default: ImageFormat::Rgb

Returns

oa::Result<Image>

The declared return value.

oa::Matrix oa::FnImage::dilate(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::dilate(
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)

dilate: Rectangular NCHW dilation using the shared border contract.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelWidth

oa::U32

Default: 3

inKernelHeight

oa::U32

Default: 3

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Result<oa::Vector<oa::U8>> oa::FnImage::encode(
	const Image & inImage,
	ImageCodec inCodec,
	oa::U32 inQuality = 90U
)

No public source comment is attached to this declaration.

Parameters

inImage

const Image &

—

inCodec

ImageCodec

—

inQuality

oa::U32

Default: 90U

Returns

oa::Result<oa::Vector<oa::U8>>

The declared return value.

oa::Matrix oa::FnImage::erase(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inX,
	oa::U32 inY,
	oa::U32 inWidth,
	oa::U32 inHeight,
	oa::F32 inValue = 0.0F
)
oa::Matrix oa::FnImage::erase(
	const oa::Matrix & inImage,
	oa::U32 inX,
	oa::U32 inY,
	oa::U32 inWidth,
	oa::U32 inHeight,
	oa::F32 inValue = 0.0F
)

erase: Fill a rectangular region with a scalar value.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inX

oa::U32

—

inY

oa::U32

—

inWidth

oa::U32

—

inHeight

oa::U32

—

inValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::erode(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::erode(
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)

erode: Rectangular NCHW erosion using the shared border contract.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelWidth

oa::U32

Default: 3

inKernelHeight

oa::U32

Default: 3

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::flip(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	bool inHorizontal = false,
	bool inVertical = false
)
oa::Matrix oa::FnImage::flip(
	const oa::Matrix & inImage,
	bool inHorizontal = false,
	bool inVertical = false
)

flip: Flip NCHW image horizontally or vertically.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inHorizontal

bool

Default: false

inVertical

bool

Default: false

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::gammaContrast(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inGamma,
	oa::F32 inGain = 1.0F
)
oa::Matrix oa::FnImage::gammaContrast(
	const oa::Matrix & inImage,
	oa::F32 inGamma,
	oa::F32 inGain = 1.0F
)

gammaContrast: Gamma and gain adjustment.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inGamma

oa::F32

—

inGain

oa::F32

Default: 1.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::gaussianBlur(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inSigma,
	oa::U32 inKernelSize = 0
)
oa::Matrix oa::FnImage::gaussianBlur(
	const oa::Matrix & inImage,
	oa::F32 inSigma,
	oa::U32 inKernelSize = 0
)

gaussianBlur: Gaussian blur filter with configurable kernel size and sigma.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inSigma

oa::F32

—

inKernelSize

oa::U32

Default: 0

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::gaussianNoise(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inMean = 0.0F,
	oa::F32 inStddev = 0.01F,
	oa::U64 inSeed = 0
)
oa::Matrix oa::FnImage::gaussianNoise(
	const oa::Matrix & inImage,
	oa::F32 inMean = 0.0F,
	oa::F32 inStddev = 0.01F,
	oa::U64 inSeed = 0
)

gaussianNoise: Add deterministic GPU-native Philox Gaussian noise.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inMean

oa::F32

Default: 0.0F

inStddev

oa::F32

Default: 0.01F

inSeed

oa::U64

Default: 0

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::grayscale(
	oa::Engine & inEngine,
	const oa::Matrix & inImage
)
oa::Matrix oa::FnImage::grayscale(
	const oa::Matrix & inImage
)
Image oa::FnImage::grayscale(
	const Image & inImage
)

grayscale: Rec.709 RGB to single-channel grayscale conversion.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::inRange(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inLow,
	oa::F32 inHigh,
	oa::F32 inTrueValue = 1.0F
)
oa::Matrix oa::FnImage::inRange(
	const oa::Matrix & inImage,
	oa::F32 inLow,
	oa::F32 inHigh,
	oa::F32 inTrueValue = 1.0F
)

inRange: Inclusive scalar range mask.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inLow

oa::F32

—

inHigh

oa::F32

—

inTrueValue

oa::F32

Default: 1.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::invert(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inMaxValue = 1.0F
)
oa::Matrix oa::FnImage::invert(
	const oa::Matrix & inImage,
	oa::F32 inMaxValue = 1.0F
)

invert: Invert values around a configurable maximum.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inMaxValue

oa::F32

Default: 1.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::laplacian(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)
oa::Matrix oa::FnImage::laplacian(
	const oa::Matrix & inImage,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)

laplacian: Signed four-neighbour discrete Laplacian lowered through the generic 2D filter.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::medianBlur(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelSize = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)
oa::Matrix oa::FnImage::medianBlur(
	const oa::Matrix & inImage,
	oa::U32 inKernelSize = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)

medianBlur: Odd-window median filter with explicit border semantics.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelSize

oa::U32

Default: 3

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::morphologyBlackHat(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::morphologyBlackHat(
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)

morphologyBlackHat: Morphological closing minus input.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelWidth

oa::U32

Default: 3

inKernelHeight

oa::U32

Default: 3

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::morphologyClose(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::morphologyClose(
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)

morphologyClose: Dilation followed by erosion through the reusable morphology primitive.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelWidth

oa::U32

Default: 3

inKernelHeight

oa::U32

Default: 3

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::morphologyGradient(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::morphologyGradient(
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)

morphologyGradient: Difference between dilation and erosion.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelWidth

oa::U32

Default: 3

inKernelHeight

oa::U32

Default: 3

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::morphologyOpen(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::morphologyOpen(
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)

morphologyOpen: Erosion followed by dilation through the reusable morphology primitive.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelWidth

oa::U32

Default: 3

inKernelHeight

oa::U32

Default: 3

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::morphologyTopHat(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::morphologyTopHat(
	const oa::Matrix & inImage,
	oa::U32 inKernelWidth = 3,
	oa::U32 inKernelHeight = 3,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)

morphologyTopHat: Input minus morphological opening.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelWidth

oa::U32

Default: 3

inKernelHeight

oa::U32

Default: 3

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::normalize(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	const oa::NormalizationParams & inParams
)
oa::Matrix oa::FnImage::normalize(
	const oa::Matrix & inImage,
	const oa::NormalizationParams & inParams
)
Image oa::FnImage::normalize(
	const Image & inImage,
	const NormalizationParams & inParams
)

normalize: Apply per-channel normalization to an NCHW image tensor.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inParams

const oa::NormalizationParams &

—

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::pad(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inLeft,
	oa::U32 inRight,
	oa::U32 inTop,
	oa::U32 inBottom,
	oa::BorderMode inBorder = oa::BorderMode::Constant,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::pad(
	const oa::Matrix & inImage,
	oa::U32 inLeft,
	oa::U32 inRight,
	oa::U32 inTop,
	oa::U32 inBottom,
	oa::BorderMode inBorder = oa::BorderMode::Constant,
	oa::F32 inBorderValue = 0.0F
)

pad: Asymmetric NCHW padding with the shared border contract.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inLeft

oa::U32

—

inRight

oa::U32

—

inTop

oa::U32

—

inBottom

oa::U32

—

inBorder

oa::BorderMode

Default: oa::BorderMode::Constant

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::posterize(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inLevels,
	oa::F32 inLow = 0.0F,
	oa::F32 inHigh = 1.0F
)
oa::Matrix oa::FnImage::posterize(
	const oa::Matrix & inImage,
	oa::U32 inLevels,
	oa::F32 inLow = 0.0F,
	oa::F32 inHigh = 1.0F
)

posterize: Quantize an intensity interval to a fixed number of levels.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inLevels

oa::U32

—

inLow

oa::F32

Default: 0.0F

inHigh

oa::F32

Default: 1.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::remap(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	const oa::Matrix & inMap,
	oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear,
	oa::BorderMode inBorder = oa::BorderMode::Constant,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::remap(
	const oa::Matrix & inImage,
	const oa::Matrix & inMap,
	oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear,
	oa::BorderMode inBorder = oa::BorderMode::Constant,
	oa::F32 inBorderValue = 0.0F
)

remap: Absolute-coordinate NCHW remapping with nearest or bilinear sampling.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inMap

const oa::Matrix &

—

inInterpolation

oa::InterpolationMode

Default: oa::InterpolationMode::Bilinear

inBorder

oa::BorderMode

Default: oa::BorderMode::Constant

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::resize(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inTargetWidth,
	oa::U32 inTargetHeight,
	oa::InterpolationMode inMode = oa::InterpolationMode::Bilinear
)
oa::Matrix oa::FnImage::resize(
	const oa::Matrix & inImage,
	oa::U32 inTargetWidth,
	oa::U32 inTargetHeight,
	oa::InterpolationMode inMode = oa::InterpolationMode::Bilinear
)
Image oa::FnImage::resize(
	const Image & inImage,
	oa::U32 inWidth,
	oa::U32 inHeight
)

resize: Resize an NCHW image using nearest or bilinear interpolation.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inTargetWidth

oa::U32

—

inTargetHeight

oa::U32

—

inMode

oa::InterpolationMode

Default: oa::InterpolationMode::Bilinear

Returns

oa::Matrix

The declared return value.

Image oa::FnImage::resizeNormalize(
	const Image & inImage,
	oa::U32 inWidth,
	oa::U32 inHeight,
	const NormalizationParams & inParams
)

No public source comment is attached to this declaration.

Parameters

inImage

const Image &

—

inWidth

oa::U32

—

inHeight

oa::U32

—

inParams

const NormalizationParams &

—

Returns

Image

The declared return value.

oa::Matrix oa::FnImage::rotate(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inDegrees
)
oa::Matrix oa::FnImage::rotate(
	const oa::Matrix & inImage,
	oa::U32 inDegrees
)

rotate: Rotate NCHW image by 90/180/270 degrees.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inDegrees

oa::U32

—

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::saltPepperNoise(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inProbability = 0.01F,
	oa::F32 inSaltValue = 1.0F,
	oa::F32 inPepperValue = 0.0F,
	oa::U64 inSeed = 0
)
oa::Matrix oa::FnImage::saltPepperNoise(
	const oa::Matrix & inImage,
	oa::F32 inProbability = 0.01F,
	oa::F32 inSaltValue = 1.0F,
	oa::F32 inPepperValue = 0.0F,
	oa::U64 inSeed = 0
)

saltPepperNoise: Apply deterministic GPU-native salt-and-pepper noise.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inProbability

oa::F32

Default: 0.01F

inSaltValue

oa::F32

Default: 1.0F

inPepperValue

oa::F32

Default: 0.0F

inSeed

oa::U64

Default: 0

Returns

oa::Matrix

The declared return value.

oa::Status oa::FnImage::saveFile(
	const oa::Path & inPath,
	const Image & inImage,
	oa::U32 inQuality = 90U
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

inImage

const Image &

—

inQuality

oa::U32

Default: 90U

Returns

oa::Status

The declared return value.

oa::Status oa::FnImage::saveRgbaFile(
	oa::Span<const oa::U8> inRgba,
	oa::U32 inWidth,
	oa::U32 inHeight,
	oa::StringView inPath,
	oa::U32 inQuality = 90U
)

Synchronous host sink for one exact packed RGBA8 image. This is the encoder boundary used by image-backed render sessions after their own explicit readback/completion protocol has produced host bytes.

Parameters

inRgba

oa::Span<const oa::U8>

—

inWidth

oa::U32

—

inHeight

oa::U32

—

inPath

oa::StringView

—

inQuality

oa::U32

Default: 90U

Returns

oa::Status

The declared return value.

oa::Status oa::FnImage::saveTextureFile(
	Engine & inEngine,
	const oa::Texture & inTexture,
	oa::StringView inPath
)

Synchronous file sink for a device-local packed RGBA8 texture. pending work in the engine's matching private recorder completes before readback. The output codec is inferred from .png, .jpg/.jpeg, .bmp, or .tga.

Parameters

inEngine

Engine &

—

inTexture

const oa::Texture &

—

inPath

oa::StringView

—

Returns

oa::Status

The declared return value.

oa::Matrix oa::FnImage::scharr(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inDx = 1,
	oa::U32 inDy = 0,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)
oa::Matrix oa::FnImage::scharr(
	const oa::Matrix & inImage,
	oa::U32 inDx = 1,
	oa::U32 inDy = 0,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)

scharr: Signed 3x3 Scharr x or y derivative lowered through the generic 2D filter.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inDx

oa::U32

Default: 1

inDy

oa::U32

Default: 0

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

Returns

oa::Matrix

The declared return value.

Matrix oa::FnImage::segmentationOverlay(
	Engine & inRt,
	const Matrix & inImage,
	const Matrix & inMask,
	const Matrix & inPalette,
	oa::F32 inAlpha = 0.5F
)
Matrix oa::FnImage::segmentationOverlay(
	const Matrix & inImage,
	const Matrix & inMask,
	const Matrix & inPalette,
	oa::F32 inAlpha = 0.5F
)

Blend an Int32 semantic label map over an FP32 NCHW RGB/RGBA image. mask is [N,H,W] or [N,1,H,W], palette is FP32 [K,3], and invalid labels leave the source pixel unchanged.

Parameters

inRt

Engine &

—

inImage

const Matrix &

—

inMask

const Matrix &

—

inPalette

const Matrix &

—

inAlpha

oa::F32

Default: 0.5F

Returns

Matrix

The declared return value.

oa::Matrix oa::FnImage::separableConvolve2d(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	const oa::Matrix & inKernelX,
	const oa::Matrix & inKernelY,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::separableConvolve2d(
	const oa::Matrix & inImage,
	const oa::Matrix & inKernelX,
	const oa::Matrix & inKernelY,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101,
	oa::F32 inBorderValue = 0.0F
)

separableConvolve2d: Same-shape NCHW separable cross-correlation with odd horizontal and vertical kernels.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inKernelX

const oa::Matrix &

—

inKernelY

const oa::Matrix &

—

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::sharpen(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inAmount = 1.0F,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)
oa::Matrix oa::FnImage::sharpen(
	const oa::Matrix & inImage,
	oa::F32 inAmount = 1.0F,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)

sharpen: Parameterized 3x3 sharpening lowered through Convolve2d.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inAmount

oa::F32

Default: 1.0F

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::sobel(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::U32 inDx = 1,
	oa::U32 inDy = 0,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)
oa::Matrix oa::FnImage::sobel(
	const oa::Matrix & inImage,
	oa::U32 inDx = 1,
	oa::U32 inDy = 0,
	oa::BorderMode inBorder = oa::BorderMode::Reflect101
)

sobel: Signed 3x3 Sobel x or y derivative lowered through the generic 2D filter.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inDx

oa::U32

Default: 1

inDy

oa::U32

Default: 0

inBorder

oa::BorderMode

Default: oa::BorderMode::Reflect101

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::solarize(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inThreshold = 0.5F,
	oa::F32 inMaxValue = 1.0F
)
oa::Matrix oa::FnImage::solarize(
	const oa::Matrix & inImage,
	oa::F32 inThreshold = 0.5F,
	oa::F32 inMaxValue = 1.0F
)

solarize: Invert values above a threshold.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inThreshold

oa::F32

Default: 0.5F

inMaxValue

oa::F32

Default: 1.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::thresholdBinary(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inThreshold,
	oa::F32 inMaxValue = 1.0F
)
oa::Matrix oa::FnImage::thresholdBinary(
	const oa::Matrix & inImage,
	oa::F32 inThreshold,
	oa::F32 inMaxValue = 1.0F
)

thresholdBinary: Global binary threshold.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inThreshold

oa::F32

—

inMaxValue

oa::F32

Default: 1.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::thresholdBinaryInv(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inThreshold,
	oa::F32 inMaxValue = 1.0F
)
oa::Matrix oa::FnImage::thresholdBinaryInv(
	const oa::Matrix & inImage,
	oa::F32 inThreshold,
	oa::F32 inMaxValue = 1.0F
)

thresholdBinaryInv: Global inverse binary threshold.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inThreshold

oa::F32

—

inMaxValue

oa::F32

Default: 1.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::thresholdToZero(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inThreshold
)
oa::Matrix oa::FnImage::thresholdToZero(
	const oa::Matrix & inImage,
	oa::F32 inThreshold
)

thresholdToZero: Set values at or below a threshold to zero.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inThreshold

oa::F32

—

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::thresholdToZeroInv(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inThreshold
)
oa::Matrix oa::FnImage::thresholdToZeroInv(
	const oa::Matrix & inImage,
	oa::F32 inThreshold
)

thresholdToZeroInv: Set values above a threshold to zero.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inThreshold

oa::F32

—

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::thresholdTruncate(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inThreshold
)
oa::Matrix oa::FnImage::thresholdTruncate(
	const oa::Matrix & inImage,
	oa::F32 inThreshold
)

thresholdTruncate: Truncate values above a threshold.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inThreshold

oa::F32

—

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::unsharpMask(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	oa::F32 inSigma = 1.0F,
	oa::F32 inAmount = 1.0F,
	oa::U32 inKernelSize = 0
)
oa::Matrix oa::FnImage::unsharpMask(
	const oa::Matrix & inImage,
	oa::F32 inSigma = 1.0F,
	oa::F32 inAmount = 1.0F,
	oa::U32 inKernelSize = 0
)

unsharpMask: Gaussian unsharp masking composed from graph-native primitives.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inSigma

oa::F32

Default: 1.0F

inAmount

oa::F32

Default: 1.0F

inKernelSize

oa::U32

Default: 0

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::warpAffine(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	const oa::Matrix & inTransform,
	oa::U32 inWidth,
	oa::U32 inHeight,
	oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear,
	oa::BorderMode inBorder = oa::BorderMode::Constant,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::warpAffine(
	const oa::Matrix & inImage,
	const oa::Matrix & inTransform,
	oa::U32 inWidth,
	oa::U32 inHeight,
	oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear,
	oa::BorderMode inBorder = oa::BorderMode::Constant,
	oa::F32 inBorderValue = 0.0F
)

warpAffine: Inverse 2x3 affine warp with explicit interpolation and border semantics.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inTransform

const oa::Matrix &

—

inWidth

oa::U32

—

inHeight

oa::U32

—

inInterpolation

oa::InterpolationMode

Default: oa::InterpolationMode::Bilinear

inBorder

oa::BorderMode

Default: oa::BorderMode::Constant

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.

oa::Matrix oa::FnImage::warpPerspective(
	oa::Engine & inEngine,
	const oa::Matrix & inImage,
	const oa::Matrix & inTransform,
	oa::U32 inWidth,
	oa::U32 inHeight,
	oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear,
	oa::BorderMode inBorder = oa::BorderMode::Constant,
	oa::F32 inBorderValue = 0.0F
)
oa::Matrix oa::FnImage::warpPerspective(
	const oa::Matrix & inImage,
	const oa::Matrix & inTransform,
	oa::U32 inWidth,
	oa::U32 inHeight,
	oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear,
	oa::BorderMode inBorder = oa::BorderMode::Constant,
	oa::F32 inBorderValue = 0.0F
)

warpPerspective: Inverse 3x3 perspective warp with explicit interpolation and border semantics.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Matrix &

—

inTransform

const oa::Matrix &

—

inWidth

oa::U32

—

inHeight

oa::U32

—

inInterpolation

oa::InterpolationMode

Default: oa::InterpolationMode::Bilinear

inBorder

oa::BorderMode

Default: oa::BorderMode::Constant

inBorderValue

oa::F32

Default: 0.0F

Returns

oa::Matrix

The declared return value.