aimstil  5.0.5
til::Box< T, D > Class Template Reference

A 3D box parallel to canonical axes. More...

#include <til/Box.h>

Inheritance diagram for til::Box< T, D >:

Public Types

typedef Box< T, D > Self
 

Public Member Functions

 Box ()
 Default constructor. All coordinates are set to zero. More...
 
 Box (const numeric_array< T, D > &posMin, const numeric_array< T, D > &posMax)
 Set min and max bounds for all dimensions. More...
 
const numeric_array< T, D > & min_bounds () const
 Get min bounds. More...
 
const numeric_array< T, D > & max_bounds () const
 Get max bounds. More...
 
void set_min_bounds (const numeric_array< T, D > &min)
 Set min bounds. More...
 
void set_max_bounds (const numeric_array< T, D > &min)
 Set max bounds. More...
 
void set_min_bound (std::size_t i, T value)
 Set min bound on axis i. More...
 
void set_max_bound (std::size_t i, T value)
 Set max bound on axis i. More...
 
void set_bounds (const numeric_array< T, D > &minBounds, const numeric_array< T, D > &maxBounds)
 Set min and max bounds. More...
 
void set_bounds (std::size_t i, T min, T max)
 Set min and max bounds for axis i. More...
 

Detailed Description

template<typename T, std::size_t D>
class til::Box< T, D >

A 3D box parallel to canonical axes.

Definition at line 25 of file Box.h.

Member Typedef Documentation

◆ Self

template<typename T, std::size_t D>
typedef Box<T,D> til::Box< T, D >::Self

Definition at line 28 of file Box.h.

Constructor & Destructor Documentation

◆ Box() [1/2]

template<typename T , std::size_t D>
til::Box< T, D >::Box ( )

Default constructor. All coordinates are set to zero.

Definition at line 76 of file Box.h.

◆ Box() [2/2]

template<typename T, std::size_t D>
til::Box< T, D >::Box ( const numeric_array< T, D > &  posMin,
const numeric_array< T, D > &  posMax 
)

Set min and max bounds for all dimensions.

Definition at line 81 of file Box.h.

Member Function Documentation

◆ max_bounds()

template<typename T, std::size_t D>
const numeric_array<T,D>& til::Box< T, D >::max_bounds ( ) const
inline

◆ min_bounds()

template<typename T, std::size_t D>
const numeric_array<T,D>& til::Box< T, D >::min_bounds ( ) const
inline

◆ set_bounds() [1/2]

template<typename T, std::size_t D>
void til::Box< T, D >::set_bounds ( const numeric_array< T, D > &  minBounds,
const numeric_array< T, D > &  maxBounds 
)

Set min and max bounds.

Definition at line 87 of file Box.h.

Referenced by til::Box< int, D >::max_bounds(), til::setCenterAndHalfSizes(), til::setCenterAndSizes(), and til::setSlice().

◆ set_bounds() [2/2]

template<typename T, std::size_t D>
void til::Box< T, D >::set_bounds ( std::size_t  i,
min,
max 
)

Set min and max bounds for axis i.

Definition at line 95 of file Box.h.

◆ set_max_bound()

template<typename T, std::size_t D>
void til::Box< T, D >::set_max_bound ( std::size_t  i,
value 
)

Set max bound on axis i.

Definition at line 124 of file Box.h.

Referenced by til::Box< int, D >::max_bounds().

◆ set_max_bounds()

template<typename T, std::size_t D>
void til::Box< T, D >::set_max_bounds ( const numeric_array< T, D > &  min)

Set max bounds.

Definition at line 110 of file Box.h.

Referenced by til::Box< int, D >::max_bounds().

◆ set_min_bound()

template<typename T, std::size_t D>
void til::Box< T, D >::set_min_bound ( std::size_t  i,
value 
)

Set min bound on axis i.

Definition at line 117 of file Box.h.

Referenced by til::Box< int, D >::max_bounds().

◆ set_min_bounds()

template<typename T, std::size_t D>
void til::Box< T, D >::set_min_bounds ( const numeric_array< T, D > &  min)

Set min bounds.

Definition at line 103 of file Box.h.

Referenced by til::Box< int, D >::max_bounds().


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