The bucket base class to manage packages of points associated to their value during time. More...

#include <aims/bucket/bucket.h>

Inheritance diagram for AimsBucket< T >:

Collaboration diagram for AimsBucket< T >:

[legend]

Public Types
typedef std::map< int, std::list< AimsBucketItem< T > > >::iterator	iterator

typedef std::map< int, std::list< AimsBucketItem< T > > >::const_iterator	const_iterator

typedef std::map< int, std::list< AimsBucketItem< T > > >::key_type	key_type

Public Member Functions
	AimsBucket ()

	AimsBucket (const AimsBucket< T > &other)

	AimsBucket (const aims::BucketMap< T > &other)

virtual	~AimsBucket ()

AimsBucket< T > &	operator= (const aims::BucketMap< T > &)

Item manipulation and methods
aims::PythonHeader	_header

void	push_front (const AimsBucketItem< T > &item)
	Function redefined to omit time.

void	push_back (const AimsBucketItem< T > &item)

void	pop_front ()

void	pop_back ()

const std::list< AimsBucketItem< T > > &	operator[] (const key_type &n) const

std::list< AimsBucketItem< T > > &	operator[] (const key_type &n)

float	sizeX () const
	returns the X resolution in mm

float	sizeY () const
	returns the Y resolution in mm

float	sizeZ () const
	returns the Z resolution in mm

float	sizeT () const
	returns the T resolution in mm

std::vector< float >	getVoxelSize () const

void	setSizeX (float sizex)
	sets the X resolution of the data in mm

void	setSizeY (float sizey)
	sets the Y resolution of the data in mm

void	setSizeZ (float sizez)
	sets the Z resolution of the data in mm

void	setSizeT (float sizet)
	sets the T resolution of the data in mm

void	setSizeXYZT (float sizex, float sizey, float sizez, float sizet)
	sets X,Y,Z and T resolutions of the data in mm

void	setSizeXYZT (const std::vector< float > &vsize)

void	setVoxelSize (float sizex, float sizey, float sizez, float sizet)

void	setVoxelSize (const std::vector< float > &vsize)

void	erase ()
	Empty the whole map.

const aims::PythonHeader &	header () const

aims::PythonHeader &	header ()

void	setHeader (const aims::PythonHeader &hdr)

std::ostream &	operator<< (std::ostream &out, const AimsBucket< T > &thing)

Detailed Description

template<class T>
class AimsBucket< T >

The bucket base class to manage packages of points associated to their value during time.

Time can be omitted if not needed. Buckets are based upon STL maps of lists of basic bucket items. One can get some more details in STL documentation.

Definition at line 68 of file bucket.h.

Member Typedef Documentation

◆ const_iterator

template<class T>

typedef std::map<int,std::list<AimsBucketItem<T>>>::const_iterator AimsBucket< T >::const_iterator

Definition at line 76 of file bucket.h.

◆ iterator

template<class T>

typedef std::map<int,std::list<AimsBucketItem<T>>>::iterator AimsBucket< T >::iterator

Definition at line 73 of file bucket.h.

◆ key_type

template<class T>

typedef std::map<int,std::list<AimsBucketItem<T>>>::key_type AimsBucket< T >::key_type

Definition at line 78 of file bucket.h.

Constructor & Destructor Documentation

◆ AimsBucket() [1/3]

template<class T>

AimsBucket< T >::AimsBucket ( )

inline

Definition at line 80 of file bucket.h.

Referenced by AimsBucket(), and operator<<.

◆ AimsBucket() [2/3]

template<class T>

AimsBucket< T >::AimsBucket ( const AimsBucket< T > & other )

inline

Definition at line 82 of file bucket.h.

References _header, and AimsBucket().

◆ AimsBucket() [3/3]

template<class T>

AimsBucket< T >::AimsBucket ( const aims::BucketMap< T > & other )

inline

Definition at line 400 of file bucketMap.h.

◆ ~AimsBucket()

template<class T>

virtual AimsBucket< T >::~AimsBucket ( )

inlinevirtual

Definition at line 86 of file bucket.h.

Member Function Documentation

◆ erase()

template<class T>

void AimsBucket< T >::erase ( )

inline

Empty the whole map.

Definition at line 334 of file bucket.h.

References erase().

Referenced by erase().

◆ getVoxelSize()

template<class T>

std::vector< float > AimsBucket< T >::getVoxelSize ( ) const

inline

Definition at line 208 of file bucket.h.

References _header.

◆ header() [1/2]

template<class T>

aims::PythonHeader & AimsBucket< T >::header ( )

inline

Definition at line 148 of file bucket.h.

References _header.

◆ header() [2/2]

template<class T>

const aims::PythonHeader & AimsBucket< T >::header ( ) const

inline

Definition at line 147 of file bucket.h.

References _header.

Referenced by aims::BucketMap< T >::operator=(), and aims::BckWriter< T >::write().

◆ operator=()

template<class T>

AimsBucket< T > & AimsBucket< T >::operator= ( const aims::BucketMap< T > & b2 )

inline

Definition at line 407 of file bucketMap.h.

References _header, aims::BucketMap< T >::header(), AimsBucketItem< T >::location(), and AimsBucketItem< T >::value().

◆ operator[]() [1/2]

template<class T>

std::list< AimsBucketItem< T > > & AimsBucket< T >::operator[] ( const key_type & n )

inline

Definition at line 110 of file bucket.h.

◆ operator[]() [2/2]

template<class T>

const std::list< AimsBucketItem< T > > & AimsBucket< T >::operator[] ( const key_type & n ) const

inline

Definition at line 108 of file bucket.h.

◆ pop_back()

template<class T>

void AimsBucket< T >::pop_back ( )

inline

Definition at line 202 of file bucket.h.

◆ pop_front()

template<class T>

void AimsBucket< T >::pop_front ( )

inline

Definition at line 196 of file bucket.h.

◆ push_back()

template<class T>

void AimsBucket< T >::push_back ( const AimsBucketItem< T > & item )

inline

Definition at line 190 of file bucket.h.

◆ push_front()

template<class T>

void AimsBucket< T >::push_front ( const AimsBucketItem< T > & item )

inline

Function redefined to omit time.

Push an item into the front of the list of index 0 of the map. It is equivalent to write:\ AimsBucket<T> bucket; \ AimsBucketItem<T> item; \ bucket.push_front(item); \ \ than to write : \ bucket[0].push_front(item)

Definition at line 184 of file bucket.h.

◆ setHeader()

template<class T>

void AimsBucket< T >::setHeader ( const aims::PythonHeader & hdr )

inline

Definition at line 149 of file bucket.h.

References _header.

Referenced by aims::BckReader< T >::read().

◆ setSizeT()

template<class T>

void AimsBucket< T >::setSizeT ( float sizet )

inline

sets the T resolution of the data in mm

Definition at line 298 of file bucket.h.

References _header.

◆ setSizeX()

template<class T>

void AimsBucket< T >::setSizeX ( float sizex )

inline

sets the X resolution of the data in mm

Definition at line 259 of file bucket.h.

References _header.

◆ setSizeXYZT() [1/2]

template<class T>

void AimsBucket< T >::setSizeXYZT ( const std::vector< float > & vsize )

inline

Definition at line 324 of file bucket.h.

References _header.

◆ setSizeXYZT() [2/2]

template<class T>

void AimsBucket< T >::setSizeXYZT	(	float	sizex,
		float	sizey,
		float	sizez,
		float	sizet )

inline

sets X,Y,Z and T resolutions of the data in mm

Definition at line 311 of file bucket.h.

References _header.

Referenced by setVoxelSize(), and setVoxelSize().

◆ setSizeY()

template<class T>

void AimsBucket< T >::setSizeY ( float sizey )

inline

sets the Y resolution of the data in mm

Definition at line 272 of file bucket.h.

References _header.

◆ setSizeZ()

template<class T>

void AimsBucket< T >::setSizeZ ( float sizez )

inline

sets the Z resolution of the data in mm

Definition at line 285 of file bucket.h.

References _header.

◆ setVoxelSize() [1/2]

template<class T>

void AimsBucket< T >::setVoxelSize ( const std::vector< float > & vsize )

inline

Definition at line 140 of file bucket.h.

References setSizeXYZT().

◆ setVoxelSize() [2/2]

template<class T>

void AimsBucket< T >::setVoxelSize	(	float	sizex,
		float	sizey,
		float	sizez,
		float	sizet )

inline

Definition at line 137 of file bucket.h.

References setSizeXYZT().

◆ sizeT()

template<class T>

float AimsBucket< T >::sizeT ( ) const

inline

returns the T resolution in mm

Definition at line 248 of file bucket.h.

References _header.

Referenced by aims::BckWriter< T >::write().

◆ sizeX()

template<class T>

float AimsBucket< T >::sizeX ( ) const

inline

returns the X resolution in mm

Definition at line 218 of file bucket.h.

References _header.

Referenced by aims::BckWriter< T >::write().

◆ sizeY()

template<class T>

float AimsBucket< T >::sizeY ( ) const

inline

returns the Y resolution in mm

Definition at line 228 of file bucket.h.

References _header.

Referenced by aims::BckWriter< T >::write().

◆ sizeZ()

template<class T>

float AimsBucket< T >::sizeZ ( ) const

inline

returns the Z resolution in mm

Definition at line 238 of file bucket.h.

References _header.

Referenced by aims::BckWriter< T >::write().

Friends And Related Symbol Documentation

◆ operator<<

template<class T>

std::ostream & operator<<	(	std::ostream &	out,
		const AimsBucket< T > &	thing )

friend

Definition at line 344 of file bucket.h.

References AimsBucket().

Member Data Documentation

◆ _header

template<class T>

aims::PythonHeader AimsBucket< T >::_header

protected

Definition at line 156 of file bucket.h.

Referenced by AimsBucket(), getVoxelSize(), header(), header(), operator=(), setHeader(), setSizeT(), setSizeX(), setSizeXYZT(), setSizeXYZT(), setSizeY(), setSizeZ(), sizeT(), sizeX(), sizeY(), and sizeZ().

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

aims/bucket/bucket.h
aims/bucket/bucketMap.h

Public Types

Public Member Functions

Item manipulation and methods

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ key_type

Constructor & Destructor Documentation

◆ AimsBucket() [1/3]

◆ AimsBucket() [2/3]

◆ AimsBucket() [3/3]

◆ ~AimsBucket()

Member Function Documentation

◆ erase()

◆ getVoxelSize()

◆ header() [1/2]

◆ header() [2/2]

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pop_back()

◆ pop_front()

◆ push_back()

◆ push_front()

◆ setHeader()

◆ setSizeT()

◆ setSizeX()

◆ setSizeXYZT() [1/2]

◆ setSizeXYZT() [2/2]

◆ setSizeY()

◆ setSizeZ()

◆ setVoxelSize() [1/2]

◆ setVoxelSize() [2/2]

◆ sizeT()

◆ sizeX()

◆ sizeY()

◆ sizeZ()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ _header