Developer documentation
Version 3.0.3-105-gd3941f44
MR::DWI::Directions::Mask Class Reference

#include "dwi/directions/mask.h"

Inheritance diagram for MR::DWI::Directions::Mask:
MR::BitSet

Public Member Functions

 Mask (const Set &master, const bool allocator=false)
 
 Mask (const Mask &that)
 
const Setget_dirs () const
 
void erode (const size_t iterations=1)
 
void dilate (const size_t iterations=1)
 
bool is_adjacent (const size_t) const
 
size_t get_min_linkage (const Mask &)
 
- Public Member Functions inherited from MR::BitSet
 BitSet (const size_t, const bool allocator=false)
 create a new bitset with the desired size. More...
 
 BitSet (const BitSet &)
 copy-construct a bitset, with explicit copying of data into the new instance More...
 
 ~BitSet ()
 
void resize (const size_t, const bool allocator=false)
 resize the bitset, retaining existing data More...
 
void clear (const bool allocator=false)
 clear the data More...
 
ConstValue operator[] (const size_t i) const
 access boolean value at a given index More...
 
Value operator[] (const size_t i)
 
size_t size () const
 the number of boolean elements in the set More...
 
bool full () const
 whether or not the bitset is 'full' i.e. all elements are true More...
 
bool empty () const
 whether or not the bitset is 'empty' i.e. all elements are false More...
 
size_t count () const
 count the number of true entries in the set More...
 
BitSetoperator= (const BitSet &)
 convenience functions for performing boolean operations More...
 
bool operator== (const BitSet &) const
 
bool operator!= (const BitSet &) const
 
BitSetoperator|= (const BitSet &)
 
BitSetoperator&= (const BitSet &)
 
BitSetoperator^= (const BitSet &)
 
BitSet operator| (const BitSet &) const
 
BitSet operator& (const BitSet &) const
 
BitSet operator^ (const BitSet &) const
 
BitSet operator~ () const
 
const uint8_t * get_data_ptr () const
 

Additional Inherited Members

- Protected Member Functions inherited from MR::BitSet
bool have_excess_bits () const
 
size_t excess_bits () const
 
uint8_t excess_bit_mask () const
 
bool test (const size_t index) const
 
void set (const size_t index)
 
void reset (const size_t index)
 
- Protected Attributes inherited from MR::BitSet
size_t bits
 
size_t bytes
 

Detailed Description

Definition at line 35 of file mask.h.

Constructor & Destructor Documentation

◆ Mask() [1/2]

MR::DWI::Directions::Mask::Mask ( const Set master,
const bool  allocator = false 
)
inline

Definition at line 38 of file mask.h.

◆ Mask() [2/2]

MR::DWI::Directions::Mask::Mask ( const Mask that)
inline

Definition at line 42 of file mask.h.

Member Function Documentation

◆ dilate()

void MR::DWI::Directions::Mask::dilate ( const size_t  iterations = 1)

◆ erode()

void MR::DWI::Directions::Mask::erode ( const size_t  iterations = 1)

◆ get_dirs()

const Set & MR::DWI::Directions::Mask::get_dirs ( ) const
inline

Definition at line 46 of file mask.h.

◆ get_min_linkage()

size_t MR::DWI::Directions::Mask::get_min_linkage ( const Mask )

◆ is_adjacent()

bool MR::DWI::Directions::Mask::is_adjacent ( const  size_t) const

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