Internal Pyramid API

The Internal Pyramid API. More...

Namespaces
namespace	coreflow
	The internal representation of a vx_array.

Functions
	coreflow::Pyramid::Pyramid (vx_context context, vx_reference scope)
	Construct a new Pyramid object.
	coreflow::Pyramid::~Pyramid ()
	Destroy the Pyramid object.
static vx_pyramid	coreflow::Pyramid::createPyramid (vx_context context, vx_size levels, vx_float32 scale, vx_uint32 width, vx_uint32 height, vx_df_image format, vx_bool is_virtual=vx_false_e)
	Create a Pyramid object.
vx_size	coreflow::Pyramid::numLvls () const
	Get the number of levels in the pyramid.
vx_float32	coreflow::Pyramid::scaleFactor () const
	Get the scale factor of the pyramid.
vx_uint32	coreflow::Pyramid::wid () const
	Get the width of the pyramid at level 0.
vx_uint32	coreflow::Pyramid::hght () const
	Get the height of the pyramid at level 0.
vx_enum	coreflow::Pyramid::fmt () const
	Get the format of the pyramid images.
vx_image	coreflow::Pyramid::getAtLevel (vx_size index)
	Get the image at a specific level in the pyramid.
vx_status	coreflow::Pyramid::initPyramid (vx_size levels, vx_float32 scale, vx_uint32 width, vx_uint32 height, vx_df_image format)
	Initializes the internals of a pyramid structure.
void	coreflow::Pyramid::destruct () override final
	Destroys a pyrmid object.

Detailed Description

The Internal Pyramid API.

Function Documentation

createPyramid()

static vx_pyramid coreflow::Pyramid::createPyramid ( vx_context context, vx_size levels, vx_float32 scale, vx_uint32 width, vx_uint32 height, vx_df_image format, vx_bool is_virtual = vx_false_e )

static

#include <vx_pyramid.h>

Create a Pyramid object.

Parameters

context	The context associated with this obj
levels	The number of levels in the pyramid
scale	The scale factor between levels
width	The width of the pyramid at level 0
height	The height of the pyramid at level 0
format	The format of the images in the pyramid
is_virtual	Whether the pyramid is virtual

Returns

vx_pyramid The created pyramid object

destruct()

void coreflow::Pyramid::destruct ( )

finaloverridevirtual

#include <vx_pyramid.h>

Destroys a pyrmid object.

Reimplemented from coreflow::Reference.

fmt()

vx_enum coreflow::Pyramid::fmt

(

)

const

#include <vx_pyramid.h>

Get the format of the pyramid images.

Returns

vx_enum The image format

getAtLevel()

vx_image coreflow::Pyramid::getAtLevel

(

vx_size

index

)

#include <vx_pyramid.h>

Get the image at a specific level in the pyramid.

Parameters

index

The level index

Returns

vx_image The image at the specified level

hght()

vx_uint32 coreflow::Pyramid::hght

(

)

const

#include <vx_pyramid.h>

Get the height of the pyramid at level 0.

Returns

vx_uint32 The height

initPyramid()

vx_status coreflow::Pyramid::initPyramid	(	vx_size	levels,
		vx_float32	scale,
		vx_uint32	width,
		vx_uint32	height,
		vx_df_image	format )

#include <vx_pyramid.h>

Initializes the internals of a pyramid structure.

numLvls()

vx_size coreflow::Pyramid::numLvls

(

)

const

#include <vx_pyramid.h>

Get the number of levels in the pyramid.

Returns

vx_size The number of levels

Pyramid()

coreflow::Pyramid::Pyramid	(	vx_context	context,
		vx_reference	scope )

#include <vx_pyramid.h>

Construct a new Pyramid object.

Parameters

context	The context associated with this obj
scope	The parent ref of this obj

scaleFactor()

vx_float32 coreflow::Pyramid::scaleFactor

(

)

const

#include <vx_pyramid.h>

Get the scale factor of the pyramid.

Returns

vx_float32 The scale factor

wid()

vx_uint32 coreflow::Pyramid::wid

(

)

const

#include <vx_pyramid.h>

Get the width of the pyramid at level 0.

Returns

vx_uint32 The width

~Pyramid()

coreflow::Pyramid::~Pyramid

(

)

#include <vx_pyramid.h>

Destroy the Pyramid object.