Developer documentation
Version 3.0.3-105-gd3941f44
MR::DWI::Tractography::Reader< ValueType > Class Template Reference

A class to read streamlines data. More...

#include "dwi/tractography/file.h"

Inheritance diagram for MR::DWI::Tractography::Reader< ValueType >:
MR::DWI::Tractography::ReaderInterface< float >

Public Member Functions

 Reader (const std::string &file, Properties &properties)
 open the file for reading and load header into properties More...
 
bool operator() (Streamline< ValueType > &tck)
 fetch next track from file More...
 
- Public Member Functions inherited from MR::DWI::Tractography::ReaderInterface< float >
virtual bool operator() (Streamline< float > &)=0
 
virtual ~ReaderInterface ()
 

Protected Member Functions

Eigen::Matrix< ValueType, 3, 1 > get_next_point ()
 takes care of byte ordering issues More...
 
void check_excess_weights ()
 Check that the weights file does not contain excess entries. More...
 
 Reader (const Reader &)=delete
 

Protected Attributes

Eigen::Matrix< ValueType, Eigen::Dynamic, 1 > weights
 

Detailed Description

template<class ValueType = float>
class MR::DWI::Tractography::Reader< ValueType >

A class to read streamlines data.

Definition at line 62 of file file.h.

Constructor & Destructor Documentation

◆ Reader() [1/2]

template<class ValueType = float>
MR::DWI::Tractography::Reader< ValueType >::Reader ( const std::string &  file,
Properties properties 
)
inline

open the file for reading and load header into properties

Definition at line 67 of file file.h.

◆ Reader() [2/2]

template<class ValueType = float>
MR::DWI::Tractography::Reader< ValueType >::Reader ( const Reader< ValueType > &  )
protecteddelete

Member Function Documentation

◆ check_excess_weights()

template<class ValueType = float>
void MR::DWI::Tractography::Reader< ValueType >::check_excess_weights ( )
inlineprotected

Check that the weights file does not contain excess entries.

Definition at line 172 of file file.h.

◆ get_next_point()

template<class ValueType = float>
Eigen::Matrix< ValueType, 3, 1 > MR::DWI::Tractography::Reader< ValueType >::get_next_point ( )
inlineprotected

takes care of byte ordering issues

Definition at line 136 of file file.h.

◆ operator()()

template<class ValueType = float>
bool MR::DWI::Tractography::Reader< ValueType >::operator() ( Streamline< ValueType > &  tck)
inline

fetch next track from file

Definition at line 77 of file file.h.

Member Data Documentation

◆ weights

template<class ValueType = float>
Eigen::Matrix<ValueType, Eigen::Dynamic, 1> MR::DWI::Tractography::Reader< ValueType >::weights
protected

Definition at line 132 of file file.h.


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