pic::pic::TileList Class Reference

The TileList class. More...

#include <filter_radial_basis_function.hpp>

Public Member Functions
	TileList ()
	TileList basic constructor. More...
	TileList (int tileSize, int width, int height)
	TileList creates a list of tiles. More...
	~TileList ()
BBox	getBBox (int index)
	genBBox More...
uint	getNext ()
	getNext returns the index of the next tile to process. More...
uint	size ()
	size More...
void	resetCounter ()
	resetCounter sets the counter to zero. More...
void	create (int tileSize, int width, int height)
	Create creates a list of tiles. More...
bool	read (std::string name, bool flag)
	read loads a TileList from a file. More...
bool	write (std::string name)
	write saves a TileList into a file. More...
void	writeIntoMemory (Image *output)
	writeIntoMemory copies tiles inside an output image. More...

Public Attributes
int	width
int	height
int	h_tile
int	w_tile
int	mod_h
int	mod_w
std::vector< Tile >	tiles
	tiles a list of tiles More...

Protected Attributes
uint	counter
std::mutex	mutex

Detailed Description

The TileList class.

Constructor & Destructor Documentation

TileList() [1/2]

PIC_INLINE pic::TileList::TileList

(

)

TileList basic constructor.

TileList() [2/2]

PIC_INLINE pic::TileList::TileList	(	int	tileSize,
		int	width,
		int	height
	)

TileList creates a list of tiles.

Parameters

tileSize	is the width and height of a tile in pixels.
width	is the horizontal size of the original image in pixels.
height	is the vertical size of the original image in pixels.

~TileList()

PIC_INLINE pic::TileList::~TileList

(

)

Member Function Documentation

create()

PIC_INLINE void pic::TileList::create	(	int	tileSize,
		int	width,
		int	height
	)

Create creates a list of tiles.

Parameters

tileSize	is the width and height of a tile in pixels.
width	is the horizontal size of the original image in pixels.
height	is the vertical size of the original image in pixels.

getBBox()

PIC_INLINE BBox pic::TileList::getBBox

(

int

index

)

genBBox

Parameters

index

Returns

getNext()

PIC_INLINE uint pic::TileList::getNext

(

)

getNext returns the index of the next tile to process.

Returns

This function returns the index of the next tile to proces.

read()

PIC_INLINE bool pic::TileList::read	(	std::string	name,
		bool	flag
	)

read loads a TileList from a file.

Parameters

name	is the file name.
flag	is a boolean value. If it is true, this loads an Image from the tile name. Otherwise, an Image of the tile size is allocated.

Returns

This function returns true if it is successfull.

resetCounter()

PIC_INLINE void pic::TileList::resetCounter

(

)

resetCounter sets the counter to zero.

size()

PIC_INLINE uint pic::TileList::size

(

)

size

Returns

write()

PIC_INLINE bool pic::TileList::write

(

std::string

name

)

write saves a TileList into a file.

Parameters

name	is the file name

Returns

This function returns true if it is successfull.

writeIntoMemory()

PIC_INLINE void pic::TileList::writeIntoMemory

(

Image *

output

)

writeIntoMemory copies tiles inside an output image.

Parameters

output

is the Image where tiles will be copied to.

Member Data Documentation

counter

uint pic::pic::TileList::counter

protected

h_tile

int pic::pic::TileList::h_tile

height

int pic::pic::TileList::height

mod_h

int pic::pic::TileList::mod_h

mod_w

int pic::pic::TileList::mod_w

mutex

std::mutex pic::pic::TileList::mutex

protected

tiles

std::vector<Tile> pic::pic::TileList::tiles

tiles a list of tiles

w_tile

int pic::pic::TileList::w_tile

width

int pic::pic::TileList::width

---

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

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