The base class to manage borders on data containers. More...

#include <aims/border/border.h>

Inheritance diagram for aims::Border:

[legend]

Public Member Functions
Constructor and Destructor
	Border (int dimx, int dimy, int dimz, int width=0)
	The constructor precalculates offsets to speed-up access to data during loops. More...

virtual	~Border ()


int	borderWidth () const
	Usefull offsets for A.I.M.S. More...

int	oFirstPoint () const
	Offset from the start of the allocated memory to the first point. More...

int	oLastPoint () const
	Offset from the start of the allocated memory to the last point. More...

int	oLine () const
	Offset between 2 consecutive lines. More...

int	oPointBetweenLine () const
	Offset between the end of a line and the start of the consecutive line. More...

int	oSlice () const
	Offset between 2 consecutive slices. More...

int	oLineBetweenSlice () const
	Number of lines between 2 consecutive slices. More...

int	oVolume () const
	Offset between 2 consecutive volumes. More...

int	oSliceBetweenVolume () const
	Number of slices between 2 consecutive volumes. More...

Protected Member Functions
Functions
void	_setBorder (int dimx, int dimy, int dimz, int width)
	Function that sets up all protected datas. More...

Protected Attributes
Data
int	_borderWidth
	Border width. More...

int	_oFirstPoint
	Offset up to first point. More...

int	_oLastPoint
	Offset up to last point. More...

int	_oLine
	Length of a line. More...

int	_oPointBetweenLine
	Offset between two consecutive lines. More...

int	_oSlice
	Length of a slice. More...

int	_oLineBetweenSlice
	Offset between two consecutive slices. More...

int	_oVolume
	Length of a volume. More...

int	_oSliceBetweenVolume
	Offset between two consecutive volumes. More...

Detailed Description

The base class to manage borders on data containers.

Definition at line 47 of file border.h.

Constructor & Destructor Documentation

◆ Border()

aims::Border::Border	(	int	dimx,
		int	dimy,
		int	dimz,
		int	width = `0`
	)

inline

The constructor precalculates offsets to speed-up access to data during loops.

Parameters

dimx	X dimension
dimy	Y dimension
dimz	Z dimension
width	border width

Definition at line 122 of file border.h.

◆ ~Border()

aims::Border::~Border ( )

inlinevirtual

Definition at line 129 of file border.h.

Member Function Documentation

◆ _setBorder()

void aims::Border::_setBorder	(	int	dimx,
		int	dimy,
		int	dimz,
		int	width
	)

protected

Function that sets up all protected datas.

Referenced by AimsData< AimsData< AimsData< T > > >::operator=().

◆ borderWidth()

int aims::Border::borderWidth ( ) const

inline

Usefull offsets for A.I.M.S.

data Size of the border

Definition at line 135 of file border.h.

Referenced by carto::ConverterAllocator< AimsData< INP >, AimsData< OUTP > >::alloc(), AimsThreshold< T, U >::bin(), AimsThreshold< T, U >::clip(), carto::Rescaler< AimsData< INP >, AimsData< OUTP > >::convert(), carto::RawConverter< AimsData< INP >, AimsData< INP > >::convert(), carto::Rescaler< AimsData< AimsRGB >, AimsData< AimsVector< T, D > > >::convert(), AimsData< AimsData< AimsData< T > > >::cross(), AimsFlip< T >::doXX(), AimsFlip< T >::doXXYY(), AimsFlip< T >::doXXYYZZ(), AimsFlip< T >::doXXZZ(), AimsFlip< T >::doXY(), AimsFlip< T >::doXZ(), AimsFlip< T >::doYY(), AimsFlip< T >::doYYZZ(), AimsFlip< T >::doYZ(), AimsFlip< T >::doZZ(), AimsThreshold< T, U >::operator()(), AimsData< AimsData< AimsData< T > > >::operator=(), AimsData< AimsData< AimsData< T > > >::transpose(), aims::triInf(), and aims::triSup().

◆ oFirstPoint()

int aims::Border::oFirstPoint ( ) const

inline

Offset from the start of the allocated memory to the first point.

Definition at line 142 of file border.h.

Referenced by AimsData< AimsData< AimsData< T > > >::maxIndex(), AimsData< AimsData< AimsData< T > > >::minIndex(), aims::minmax(), and AimsData< AimsData< AimsData< T > > >::operator=().

◆ oLastPoint()

int aims::Border::oLastPoint ( ) const

inline

Offset from the start of the allocated memory to the last point.

Definition at line 149 of file border.h.

◆ oLine()

int aims::Border::oLine ( ) const

inline

Offset between 2 consecutive lines.

Definition at line 156 of file border.h.

Referenced by aims::AimsConnectedComponent(), aims::AimsLabeledConnectedComponent(), and aims::ConnectedComponentEngine< AimsData< T >, AimsData< O > >::connectedInFrame().

◆ oLineBetweenSlice()

int aims::Border::oLineBetweenSlice ( ) const

inline

Number of lines between 2 consecutive slices.

Definition at line 177 of file border.h.

Referenced by AimsData< AimsData< AimsData< T > > >::maxIndex(), AimsData< AimsData< AimsData< T > > >::minIndex(), aims::minmax(), and AimsData< AimsData< AimsData< T > > >::operator=().

◆ oPointBetweenLine()

int aims::Border::oPointBetweenLine ( ) const

inline

Offset between the end of a line and the start of the consecutive line.

Definition at line 163 of file border.h.

Referenced by AimsData< AimsData< AimsData< T > > >::maxIndex(), AimsData< AimsData< AimsData< T > > >::minIndex(), aims::minmax(), and AimsData< AimsData< AimsData< T > > >::operator=().

◆ oSlice()

int aims::Border::oSlice ( ) const

inline

Offset between 2 consecutive slices.

Definition at line 170 of file border.h.

Referenced by aims::AimsConnectedComponent(), aims::AimsLabeledConnectedComponent(), and aims::ConnectedComponentEngine< AimsData< T >, AimsData< O > >::connectedInFrame().

◆ oSliceBetweenVolume()

int aims::Border::oSliceBetweenVolume ( ) const

inline

Number of slices between 2 consecutive volumes.

Definition at line 191 of file border.h.

Referenced by AimsData< AimsData< AimsData< T > > >::maxIndex(), AimsData< AimsData< AimsData< T > > >::minIndex(), aims::minmax(), and AimsData< AimsData< AimsData< T > > >::operator=().

◆ oVolume()

int aims::Border::oVolume ( ) const

inline

Offset between 2 consecutive volumes.

Definition at line 184 of file border.h.

Member Data Documentation

◆ _borderWidth

int aims::Border::_borderWidth

protected

Border width.

Definition at line 92 of file border.h.

◆ _oFirstPoint

int aims::Border::_oFirstPoint

protected

Offset up to first point.

Definition at line 94 of file border.h.

Referenced by AimsData< AimsData< AimsData< T > > >::AimsData(), and AimsData< AimsData< AimsData< T > > >::operator=().

◆ _oLastPoint

int aims::Border::_oLastPoint

protected

Offset up to last point.

Definition at line 96 of file border.h.

◆ _oLine

int aims::Border::_oLine

protected

Length of a line.

Definition at line 98 of file border.h.

Referenced by AimsData< AimsData< AimsData< T > > >::AimsData(), and AimsData< AimsData< AimsData< T > > >::operator=().

◆ _oLineBetweenSlice

int aims::Border::_oLineBetweenSlice

protected

Offset between two consecutive slices.

Definition at line 104 of file border.h.

Referenced by AimsData< AimsData< AimsData< T > > >::AimsData(), and AimsData< AimsData< AimsData< T > > >::operator=().

◆ _oPointBetweenLine

int aims::Border::_oPointBetweenLine

protected

Offset between two consecutive lines.

Definition at line 100 of file border.h.

Referenced by AimsData< AimsData< AimsData< T > > >::AimsData(), and AimsData< AimsData< AimsData< T > > >::operator=().

◆ _oSlice

int aims::Border::_oSlice

protected

Length of a slice.

Definition at line 102 of file border.h.

Referenced by AimsData< AimsData< AimsData< T > > >::AimsData(), and AimsData< AimsData< AimsData< T > > >::operator=().

◆ _oSliceBetweenVolume

int aims::Border::_oSliceBetweenVolume

protected

Offset between two consecutive volumes.

Definition at line 108 of file border.h.

Referenced by AimsData< AimsData< AimsData< T > > >::AimsData(), and AimsData< AimsData< AimsData< T > > >::operator=().

◆ _oVolume

int aims::Border::_oVolume

protected

Length of a volume.

Definition at line 106 of file border.h.

Referenced by AimsData< AimsData< AimsData< T > > >::AimsData(), and AimsData< AimsData< AimsData< T > > >::operator=().

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

aims/border/border.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Border()

◆ ~Border()

Member Function Documentation

◆ _setBorder()

◆ borderWidth()

◆ oFirstPoint()

◆ oLastPoint()

◆ oLine()

◆ oLineBetweenSlice()

◆ oPointBetweenLine()

◆ oSlice()

◆ oSliceBetweenVolume()

◆ oVolume()

Member Data Documentation

◆ _borderWidth

◆ _oFirstPoint

◆ _oLastPoint

◆ _oLine

◆ _oLineBetweenSlice

◆ _oPointBetweenLine

◆ _oSlice

◆ _oSliceBetweenVolume

◆ _oVolume