The blo Library
Loading...
Searching...
No Matches
Public Member Functions | Related Functions | List of all members
blo::MultiscaleImage< T, C > Class Template Reference

Multiscale image. More...

#include <MultiscaleImage.h>

Public Member Functions

 MultiscaleImage ()
 Default constructor.
 
 MultiscaleImage (int levels)
 Constructs multiscale image of specified size.
 
 MultiscaleImage (const MultiscaleImage &rhs)
 Copy constructor.
 
 MultiscaleImage (MultiscaleImage &&rhs) noexcept
 Move constructor.
 
virtual ~MultiscaleImage ()
 Destructor.
 
MultiscaleImage & operator= (const MultiscaleImage &rhs)
 Copy assignment operator.
 
MultiscaleImage & operator= (MultiscaleImage &&rhs) noexcept
 Move assignment operator.
 
void resize (int levels)
 Resizes multiscale image.
 
void clear ()
 Resizes multiscale image to zero levels.
 
void swap (MultiscaleImage &rhs)
 Swaps this multiscale image with another one.
 
int levels () const
 Number of levels of the multiscale image.
 
bool empty () const
 Tests if the multiscale image is empty.
 
Image< T, C > & operator[] (int level)
 Index multiscale image level.
 
const Image< T, C > & operator[] (int level) const
 Index multiscale image level.
 

Related Functions

(Note that these are not member functions.)

BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint8_t, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint8_t, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint8_t, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint16_t, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint16_t, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint16_t, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< float, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< float, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< float, 4 >
 

Detailed Description

template<typename T, size_t C>
class blo::MultiscaleImage< T, C >

Multiscale image.

Template Parameters
TData type.
CNumber of channels.

Constructor & Destructor Documentation

◆ MultiscaleImage() [1/4]

template<typename T , size_t C>
blo::MultiscaleImage< T, C >::MultiscaleImage ( )

Default constructor.

◆ MultiscaleImage() [2/4]

template<typename T , size_t C>
blo::MultiscaleImage< T, C >::MultiscaleImage ( int  levels)
explicit

Constructs multiscale image of specified size.

Parameters
levelsNumber of levels of the multiscale image.

◆ MultiscaleImage() [3/4]

template<typename T , size_t C>
blo::MultiscaleImage< T, C >::MultiscaleImage ( const MultiscaleImage< T, C > &  rhs)

Copy constructor.

◆ MultiscaleImage() [4/4]

template<typename T , size_t C>
blo::MultiscaleImage< T, C >::MultiscaleImage ( MultiscaleImage< T, C > &&  rhs)
noexcept

Move constructor.

◆ ~MultiscaleImage()

template<typename T , size_t C>
virtual blo::MultiscaleImage< T, C >::~MultiscaleImage ( )
virtual

Destructor.

Member Function Documentation

◆ clear()

template<typename T , size_t C>
void blo::MultiscaleImage< T, C >::clear ( )

Resizes multiscale image to zero levels.

◆ empty()

template<typename T , size_t C>
bool blo::MultiscaleImage< T, C >::empty ( ) const

Tests if the multiscale image is empty.

Returns
true if multiscale image is empty, false otherwise.

◆ levels()

template<typename T , size_t C>
int blo::MultiscaleImage< T, C >::levels ( ) const

Number of levels of the multiscale image.

Returns
Number of levels of the multiscale image.

◆ operator=() [1/2]

template<typename T , size_t C>
MultiscaleImage & blo::MultiscaleImage< T, C >::operator= ( const MultiscaleImage< T, C > &  rhs)

Copy assignment operator.

◆ operator=() [2/2]

template<typename T , size_t C>
MultiscaleImage & blo::MultiscaleImage< T, C >::operator= ( MultiscaleImage< T, C > &&  rhs)
noexcept

Move assignment operator.

◆ operator[]() [1/2]

template<typename T , size_t C>
Image< T, C > & blo::MultiscaleImage< T, C >::operator[] ( int  level)

Index multiscale image level.

Parameters
levelLevel of the multiscale image.
Returns
Image of the multiscale image level.

◆ operator[]() [2/2]

template<typename T , size_t C>
const Image< T, C > & blo::MultiscaleImage< T, C >::operator[] ( int  level) const

Index multiscale image level.

Parameters
levelLevel of the multiscale image.
Returns
Image of the multiscale image level.

◆ resize()

template<typename T , size_t C>
void blo::MultiscaleImage< T, C >::resize ( int  levels)

Resizes multiscale image.

Parameters
levelsNumber of levels to resize multiscale image to.

◆ swap()

template<typename T , size_t C>
void blo::MultiscaleImage< T, C >::swap ( MultiscaleImage< T, C > &  rhs)

Swaps this multiscale image with another one.

Friends And Related Function Documentation

◆ MultiscaleImage< float, 1 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< float, 1 >
related

◆ MultiscaleImage< float, 3 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< float, 3 >
related

◆ MultiscaleImage< float, 4 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< float, 4 >
related

◆ MultiscaleImage< uint16_t, 1 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint16_t, 1 >
related

◆ MultiscaleImage< uint16_t, 3 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint16_t, 3 >
related

◆ MultiscaleImage< uint16_t, 4 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint16_t, 4 >
related

◆ MultiscaleImage< uint8_t, 1 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint8_t, 1 >
related

◆ MultiscaleImage< uint8_t, 3 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint8_t, 3 >
related

◆ MultiscaleImage< uint8_t, 4 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API MultiscaleImage< uint8_t, 4 >
related

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