Developer documentation
Version 3.0.3-105-gd3941f44
Public Member Functions | Protected Attributes | Friends | List of all members
MR::DWI::Shell Class Reference

#include "dwi/shells.h"

Public Member Functions

 Shell ()
 
 Shell (const Eigen::MatrixXd &grad, const vector< size_t > &indices)
 
const vector< size_t > & get_volumes () const
 
size_t count () const
 
default_type get_mean () const
 
default_type get_stdev () const
 
default_type get_min () const
 
default_type get_max () const
 
bool is_bzero () const
 
bool operator< (const Shell &rhs) const
 

Protected Attributes

vector< size_t > volumes
 
default_type mean
 
default_type stdev
 
default_type min
 
default_type max
 

Friends

std::ostream & operator<< (std::ostream &stream, const Shell &S)
 

Detailed Description

Definition at line 74 of file shells.h.

Constructor & Destructor Documentation

◆ Shell() [1/2]

MR::DWI::Shell::Shell ( )
inline

Definition at line 79 of file shells.h.

◆ Shell() [2/2]

MR::DWI::Shell::Shell ( const Eigen::MatrixXd &  grad,
const vector< size_t > &  indices 
)

Member Function Documentation

◆ count()

size_t MR::DWI::Shell::count ( ) const
inline

Definition at line 83 of file shells.h.

◆ get_max()

default_type MR::DWI::Shell::get_max ( ) const
inline

Definition at line 88 of file shells.h.

◆ get_mean()

default_type MR::DWI::Shell::get_mean ( ) const
inline

Definition at line 85 of file shells.h.

◆ get_min()

default_type MR::DWI::Shell::get_min ( ) const
inline

Definition at line 87 of file shells.h.

◆ get_stdev()

default_type MR::DWI::Shell::get_stdev ( ) const
inline

Definition at line 86 of file shells.h.

◆ get_volumes()

const vector< size_t > & MR::DWI::Shell::get_volumes ( ) const
inline

Definition at line 82 of file shells.h.

◆ is_bzero()

bool MR::DWI::Shell::is_bzero ( ) const
inline

Definition at line 90 of file shells.h.

◆ operator<()

bool MR::DWI::Shell::operator< ( const Shell &  rhs) const
inline

Definition at line 93 of file shells.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  stream,
const Shell &  S 
)
friend

Definition at line 95 of file shells.h.

Member Data Documentation

◆ max

default_type MR::DWI::Shell::max
protected

Definition at line 105 of file shells.h.

◆ mean

default_type MR::DWI::Shell::mean
protected

Definition at line 105 of file shells.h.

◆ min

default_type MR::DWI::Shell::min
protected

Definition at line 105 of file shells.h.

◆ stdev

default_type MR::DWI::Shell::stdev
protected

Definition at line 105 of file shells.h.

◆ volumes

vector<size_t> MR::DWI::Shell::volumes
protected

Definition at line 104 of file shells.h.

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