roccv Namespace Reference

roccv Namespace Reference#

8 min read time

Applies to Linux

rocCV: roccv Namespace Reference

Namespaces
	detail

	ExceptionMessage

Classes
class	BilateralFilter
	Class for managing the Bilateral filter operator. More...

class	BndBox
	Class for managing the BndBox Operator. More...

class	BorderWrapper
	Wrapper class for ImageWrapper. This extends the descriptors by defining behaviors for when tensor coordinates go out of scope. More...

class	CenterCrop
	Class for managing the Center Crop operator. More...

class	Composite
	Class for managing the Composite operator. More...

class	CopyMakeBorder
	Class for managing the CopyMakeBorder operator. More...

class	CustomCrop
	Class for managing the Custom Crop operator. More...

class	CvtColor
	Class for managing the Color Conversion operator. More...

class	DataType
	Supported data types for use with the Tensor utilities. More...

class	Exception

class	Flip
	Class for managing the Flip operator. More...

class	GammaContrast
	Class for managing the Gamma Contrast operator. More...

class	GenericTensorWrapper

class	Histogram
	Class for managing the Histogram operator. More...

class	ImageFormat
	Acts as a container for data corresponding to how image data is laid out in memory. More...

class	ImageWrapper
	ImageWrapper is a non-owning wrapper for roccv::Tensors with a NHWC/NCHW/HWC layout. It provides methods for accessing the underlying data within HIP kernels. More...

class	InterpolationWrapper
	A kernel-friendly wrapper which provides interpolation logic based on the given coordinates. This tensor wrapper is typically only used for input tensors and does not provide write access to its underlying data. More...

class	IOperator
	Interface class for all roccv operators. More...

class	NonMaximumSuppression
	Class for managing the NMS operator. More...

class	Normalize
	Class for managing the Normalize operator. More...

class	Remap
	Class for managing the remap operator. More...

class	Resize
	Class for managing the Resize operator. More...

class	Rotate
	Class for managing the Rotate operator. More...

struct	Size2D
	Describes the 2D dimensions of an image. More...

class	Tensor

struct	TensorBuffer
	A tensor buffer. Stores the raw data associated with a tensor. Data should be allocated by the user and set to the basePtr of the buffer. More...

struct	TensorBufferStrided
	A tensor buffer with strided data. More...

class	TensorData
	Holds the underlying tensor data alongside metadata (shape, layout, datatype). Non-strided tensor data is not supported for use right now, use TensorDataStrided to use strided tensor data instead. More...

class	TensorDataStrided
	Holds the underlying tensor data alongside tensor metadata. This particular tensor data type is used to store strided data, and contains additional methods for handling strided data. More...

class	TensorLayout
	TensorLayout class. More...

struct	TensorLayoutDesc
	Descriptors used to specify features of a specific tensor layout type. More...

struct	TensorRequirements

class	TensorShape
	TensorShape class. More...

class	TensorStorage
	Stores the underlying data of a tensor and is responsible for allocation/freeing of tensor memory. Agnostic to the tensor's metadata (shape, datatype, etc.) More...

class	Threshold
	Class for managing the Threshold operator. More...

class	WarpAffine

class	WarpPerspective
	Class for managing the Warp Perspective operator. More...

Typedefs
typedef float	AffineTransform[6]
	Class for managing the Warp Affine Operator. More...

Enumerations
enum class	eStatusType { SUCCESS , INVALID_HANDLE , INVALID_POINTER , INVALID_VALUE , OUT_OF_BOUNDS , OUT_OF_MEMORY , INVALID_OPERATION , INTERNAL_ERROR , INVALID_COMBINATION , NOT_IMPLEMENTED , NOT_INITIALIZED }
	Describes various status types for roccv Exceptions. More...

enum class	eSwizzle { XYZW , ZYXW }
	Defines the swizzling for channel ordering. More...

enum class	eTestStatusType { TEST_SUCCESS , TEST_FAILURE , UNEXPECTED_VALUE }
	Describes various status types for roccv test Exceptions. It may be worth moving this into the standalone test folder in the future, as it has no use in the library itself. More...

Functions
constexpr ImageFormat	FMT_BGR8 (eDataType::DATA_TYPE_U8, 3, eSwizzle::ZYXW)

constexpr ImageFormat	FMT_BGRA8 (eDataType::DATA_TYPE_U8, 4, eSwizzle::ZYXW)

constexpr ImageFormat	FMT_F32 (eDataType::DATA_TYPE_F32, 1, eSwizzle::XYZW)

constexpr ImageFormat	FMT_F64 (eDataType::DATA_TYPE_F64, 1, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGB16 (eDataType::DATA_TYPE_U16, 3, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGB32 (eDataType::DATA_TYPE_U32, 3, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGB8 (eDataType::DATA_TYPE_U8, 3, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGBA16 (eDataType::DATA_TYPE_U16, 4, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGBA32 (eDataType::DATA_TYPE_U32, 4, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGBA8 (eDataType::DATA_TYPE_U8, 4, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGBAf32 (eDataType::DATA_TYPE_F32, 4, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGBAf64 (eDataType::DATA_TYPE_F64, 4, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGBAs16 (eDataType::DATA_TYPE_S16, 4)

constexpr ImageFormat	FMT_RGBAs8 (eDataType::DATA_TYPE_S8, 4, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGBf32 (eDataType::DATA_TYPE_F32, 3, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGBf64 (eDataType::DATA_TYPE_F64, 3, eSwizzle::XYZW)

constexpr ImageFormat	FMT_RGBs16 (eDataType::DATA_TYPE_S16, 3)

constexpr ImageFormat	FMT_RGBs8 (eDataType::DATA_TYPE_S8, 3, eSwizzle::XYZW)

constexpr ImageFormat	FMT_S16 (eDataType::DATA_TYPE_S16, 1, eSwizzle::XYZW)

constexpr ImageFormat	FMT_S32 (eDataType::DATA_TYPE_S32, 1, eSwizzle::XYZW)

constexpr ImageFormat	FMT_S8 (eDataType::DATA_TYPE_S8, 1, eSwizzle::XYZW)

constexpr ImageFormat	FMT_U16 (eDataType::DATA_TYPE_U16, 1, eSwizzle::XYZW)

constexpr ImageFormat	FMT_U32 (eDataType::DATA_TYPE_U32, 1, eSwizzle::XYZW)

constexpr ImageFormat	FMT_U8 (eDataType::DATA_TYPE_U8, 1, eSwizzle::XYZW)

Tensor	TensorWrapData (const TensorData &tensor_data)
	Wraps TensorData object into a Tensor object. More...

Detailed Description

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Typedef Documentation

◆ AffineTransform

typedef float roccv::AffineTransform[6]

Class for managing the Warp Affine Operator.

Enumeration Type Documentation

◆ eStatusType

enum roccv::eStatusType

strong

Describes various status types for roccv Exceptions.

Enumerator
SUCCESS
INVALID_HANDLE
INVALID_POINTER	handle parameter is invalid.
INVALID_VALUE	pointer parameter is invalid (e.g., nullptr).
OUT_OF_BOUNDS	value of parameter is invalid.
OUT_OF_MEMORY	numerical value of parameter is out of the allowed range.
INVALID_OPERATION	execution cannot be completed due to lack of memory.
INTERNAL_ERROR	the operation cannot be executed because of incorrect context.
INVALID_COMBINATION	an error occured during the execution. If a point that shouldn't be reached is reached.
NOT_IMPLEMENTED	invalid permutation of parameters.
NOT_INITIALIZED	cannot execute because the current permutation has not been implemented.

◆ eSwizzle

enum roccv::eSwizzle

strong

Defines the swizzling for channel ordering.

Enumerator
XYZW
ZYXW

◆ eTestStatusType

enum roccv::eTestStatusType

strong

Describes various status types for roccv test Exceptions. It may be worth moving this into the standalone test folder in the future, as it has no use in the library itself.

Enumerator
TEST_SUCCESS
TEST_FAILURE
UNEXPECTED_VALUE

Function Documentation

◆ FMT_BGR8()

constexpr ImageFormat roccv::FMT_BGR8	(	eDataType::DATA_TYPE_U8	,
		3	,
		eSwizzle::ZYXW
	)

constexpr

◆ FMT_BGRA8()

constexpr ImageFormat roccv::FMT_BGRA8	(	eDataType::DATA_TYPE_U8	,
		4	,
		eSwizzle::ZYXW
	)

constexpr

◆ FMT_F32()

constexpr ImageFormat roccv::FMT_F32	(	eDataType::DATA_TYPE_F32	,
		1	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_F64()

constexpr ImageFormat roccv::FMT_F64	(	eDataType::DATA_TYPE_F64	,
		1	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGB16()

constexpr ImageFormat roccv::FMT_RGB16	(	eDataType::DATA_TYPE_U16	,
		3	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGB32()

constexpr ImageFormat roccv::FMT_RGB32	(	eDataType::DATA_TYPE_U32	,
		3	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGB8()

constexpr ImageFormat roccv::FMT_RGB8	(	eDataType::DATA_TYPE_U8	,
		3	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGBA16()

constexpr ImageFormat roccv::FMT_RGBA16	(	eDataType::DATA_TYPE_U16	,
		4	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGBA32()

constexpr ImageFormat roccv::FMT_RGBA32	(	eDataType::DATA_TYPE_U32	,
		4	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGBA8()

constexpr ImageFormat roccv::FMT_RGBA8	(	eDataType::DATA_TYPE_U8	,
		4	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGBAf32()

constexpr ImageFormat roccv::FMT_RGBAf32	(	eDataType::DATA_TYPE_F32	,
		4	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGBAf64()

constexpr ImageFormat roccv::FMT_RGBAf64	(	eDataType::DATA_TYPE_F64	,
		4	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGBAs16()

constexpr ImageFormat roccv::FMT_RGBAs16	(	eDataType::DATA_TYPE_S16	,
		4
	)

constexpr

◆ FMT_RGBAs8()

constexpr ImageFormat roccv::FMT_RGBAs8	(	eDataType::DATA_TYPE_S8	,
		4	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGBf32()

constexpr ImageFormat roccv::FMT_RGBf32	(	eDataType::DATA_TYPE_F32	,
		3	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGBf64()

constexpr ImageFormat roccv::FMT_RGBf64	(	eDataType::DATA_TYPE_F64	,
		3	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_RGBs16()

constexpr ImageFormat roccv::FMT_RGBs16	(	eDataType::DATA_TYPE_S16	,
		3
	)

constexpr

◆ FMT_RGBs8()

constexpr ImageFormat roccv::FMT_RGBs8	(	eDataType::DATA_TYPE_S8	,
		3	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_S16()

constexpr ImageFormat roccv::FMT_S16	(	eDataType::DATA_TYPE_S16	,
		1	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_S32()

constexpr ImageFormat roccv::FMT_S32	(	eDataType::DATA_TYPE_S32	,
		1	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_S8()

constexpr ImageFormat roccv::FMT_S8	(	eDataType::DATA_TYPE_S8	,
		1	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_U16()

constexpr ImageFormat roccv::FMT_U16	(	eDataType::DATA_TYPE_U16	,
		1	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_U32()

constexpr ImageFormat roccv::FMT_U32	(	eDataType::DATA_TYPE_U32	,
		1	,
		eSwizzle::XYZW
	)

constexpr

◆ FMT_U8()

constexpr ImageFormat roccv::FMT_U8	(	eDataType::DATA_TYPE_U8	,
		1	,
		eSwizzle::XYZW
	)

constexpr

◆ TensorWrapData()

Tensor roccv::TensorWrapData ( const TensorData & tensor_data )

Wraps TensorData object into a Tensor object.

Parameters

[in] data The tensor data to wrap.

Returns: The resulting Tensor with the provided TensorData.

roccv Namespace Reference

roccv Namespace Reference#

Namespaces

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ AffineTransform

Enumeration Type Documentation

◆ eStatusType

◆ eSwizzle

◆ eTestStatusType

Function Documentation

◆ FMT_BGR8()

◆ FMT_BGRA8()

◆ FMT_F32()

◆ FMT_F64()

◆ FMT_RGB16()

◆ FMT_RGB32()

◆ FMT_RGB8()

◆ FMT_RGBA16()

◆ FMT_RGBA32()

◆ FMT_RGBA8()

◆ FMT_RGBAf32()

◆ FMT_RGBAf64()

◆ FMT_RGBAs16()

◆ FMT_RGBAs8()

◆ FMT_RGBf32()

◆ FMT_RGBf64()

◆ FMT_RGBs16()

◆ FMT_RGBs8()

◆ FMT_S16()

◆ FMT_S32()

◆ FMT_S8()

◆ FMT_U16()

◆ FMT_U32()

◆ FMT_U8()

◆ TensorWrapData()