pic::pic::BBox Class Reference

The BBox class manages the creation of bounding boxes for images. More...

#include <filter_radial_basis_function.hpp>

Public Member Functions
	BBox ()
	BBox is a basic constructor. It does nothing. More...
	BBox (int width, int height)
	BBox is a constructor setting the BBox up. More...
	BBox (int width, int height, int frames)
	BBox is a constructor setting the BBox up. More...
	BBox (int x0, int x1, int y0, int y1)
	BBox is a constructor setting the BBox up. More...
	BBox (int x0, int x1, int y0, int y1, int width, int height)
	BBox is a constructor setting the BBox up. More...
	BBox (int x0, int y0, int size, int width, int height)
	BBox. More...
int	Size ()
	Size computes the number of pixels in a bounding box. More...
void	setBox (int x0, int x1, int y0, int y1, int z0, int z1, int width, int height, int frames)
	setBox sets a BBox up. More...
void	setCentered (int x0, int y0, int size, int width, int height)
	SetCentered. More...
void	getFourBlocks (int width, int height, int i)
	getFourBlocks sets the BBox as a quadrant of a given size. More...
std::string	toString ()
	toString returns a string representation of BBox More...

Public Attributes
int	x0
int	y0
int	z0
int	x1
int	y1
int	z1
int	width
int	height
int	frames

Detailed Description

The BBox class manages the creation of bounding boxes for images.

Constructor & Destructor Documentation

BBox() [1/6]

pic::pic::BBox::BBox ( )

inline

BBox is a basic constructor. It does nothing.

BBox() [2/6]

pic::pic::BBox::BBox ( int  width, int  height  )

inline

BBox is a constructor setting the BBox up.

Parameters

width	is the maxium horizontal coordinate in pixels. The minimum is set to 0.
height	is the maxium vertical coordinate in pixels. The minimum is set to 0.

BBox() [3/6]

pic::pic::BBox::BBox ( int  width, int  height, int  frames  )

inline

BBox is a constructor setting the BBox up.

Parameters

width	is the maxium horizontal coordinate in pixels. The minimum is set to 0.
height	is the maxium vertical coordinate in pixels. The minimum is set to 0.
frames	is the maxium temporal coordinate in pixels. The minimum is set to 0.

BBox() [4/6]

pic::pic::BBox::BBox ( int  x0, int  x1, int  y0, int  y1  )

inline

BBox is a constructor setting the BBox up.

Parameters

x0	is the minimum horizontal coordinate in pixels.
x1	is the maximum horizontal coordinate in pixels.
y0	is the minimum vertical coordinate in pixels.
y1	is the maximum vertical coordinate in pixels.

BBox() [5/6]

pic::pic::BBox::BBox ( int  x0, int  x1, int  y0, int  y1, int  width, int  height  )

inline

BBox is a constructor setting the BBox up.

Parameters

x0	is the minimum horizontal coordinate in pixels.
x1	is the maximum horizontal coordinate in pixels.
y0	is the minimum vertical coordinate in pixels.
y1	is the maximum vertical coordinate in pixels.
width	is the horizontal size in pixels.
height	is the vertical size in pixels.

BBox() [6/6]

pic::pic::BBox::BBox ( int  x0, int  y0, int  size, int  width, int  height  )

inline

BBox.

Parameters

x0	is the horizontal coordinate in pixels.
y0	is the vertical coordinate in pixels.
size	is the patch size
width	is the original width of the image.
height	is the original height of the image.

Member Function Documentation

getFourBlocks()

void pic::pic::BBox::getFourBlocks ( int  width, int  height, int  i  )

inline

getFourBlocks sets the BBox as a quadrant of a given size.

Parameters

width	is horizontal size in pixels.
height	is the vertical size in pixels.
i	is the i-th quadrant.

setBox()

void pic::pic::BBox::setBox ( int  x0, int  x1, int  y0, int  y1, int  z0, int  z1, int  width, int  height, int  frames  )

inline

setBox sets a BBox up.

Parameters

x0	is the minimum horizontal coordinate in pixels.
x1	is the maximum horizontal coordinate in pixels.
y0	is the minimum vertical coordinate in pixels.
y1	is the maximum vertical coordinate in pixels.
z0	is the minimum temporal coordinate in pixels.
z1	is the maximum temporal coordinate in pixels.
width	is the original width of the image.
height	is the original height of the image.
frames	is the original length of the image.

setCentered()

void pic::pic::BBox::setCentered ( int  x0, int  y0, int  size, int  width, int  height  )

inline

SetCentered.

Parameters

x0	is the horizontal coordinate in pixels.
y0	is the vertical coordinate in pixels.
size	is the patch size
width	is the original width of the image.
height	is the original height of the image.

Size()

int pic::pic::BBox::Size ( )

inline

Size computes the number of pixels in a bounding box.

Returns

It returns the number of pixels in a bounding box.

toString()

std::string pic::pic::BBox::toString ( )

inline

toString returns a string representation of BBox

Returns

It returns a string with the BBox content.

Member Data Documentation

frames

int pic::pic::BBox::frames

height

int pic::pic::BBox::height

width

int pic::pic::BBox::width

x0

int pic::pic::BBox::x0

x1

int pic::pic::BBox::x1

y0

int pic::pic::BBox::y0

y1

int pic::pic::BBox::y1

z0

int pic::pic::BBox::z0

z1

int pic::pic::BBox::z1

---

The documentation for this class was generated from the following file:

• C:/Users/Francesco/Documents/GitHub/piccante/include/filtering/filter_radial_basis_function.hpp