aimsdata  5.0.5
Neuroimaging data handling
aims::BundleReader Class Reference

Reads a bundles file, and emits events while walking through its data. More...

#include <aims/fibers/bundles.h>

Inheritance diagram for aims::BundleReader:
Collaboration diagram for aims::BundleReader:

Public Member Functions

 BundleReader (const std::string &fileName)
 
virtual ~BundleReader ()
 
void read ()
 read() is the entry point to fibers processing, and triggers the producer machinery. More...
 
virtual carto::Object readHeader ()
 
- Public Member Functions inherited from aims::BundleProducer
void addBundleListener (BundleListener &)
 
- Public Member Functions inherited from aims::BundleListener
virtual ~BundleListener ()
 

Static Public Member Functions

static std::set< std::string > supportedFormats ()
 
static std::set< std::string > formatExtensions (const std::string &format="ALL")
 

Protected Member Functions

virtual void bundleStarted (const BundleProducer &, const BundleInfo &)
 
virtual void bundleTerminated (const BundleProducer &, const BundleInfo &)
 
virtual void fiberStarted (const BundleProducer &, const BundleInfo &, const FiberInfo &)
 
virtual void fiberTerminated (const BundleProducer &, const BundleInfo &, const FiberInfo &)
 
virtual void newFiberPoint (const BundleProducer &, const BundleInfo &, const FiberInfo &, const FiberPoint &)
 
virtual void noMoreBundle (const BundleProducer &)
 
- Protected Member Functions inherited from aims::BundleProducer
void startBundle (const BundleInfo &)
 
void terminateBundle (const BundleInfo &)
 
void startFiber (const BundleInfo &, const FiberInfo &)
 
void terminateFiber (const BundleInfo &, const FiberInfo &)
 
void addFiberPoint (const BundleInfo &, const FiberInfo &, const FiberPoint &)
 
void noMoreBundle ()
 

Detailed Description

Reads a bundles file, and emits events while walking through its data.

BundleReader is a BundleProducer, so can be listened by any BundleListener. It may read several bundles/fibers formats, using a lower-level BundleProducer dedicated to a specific format.

Currently .bundles (AIMS/Connectomist) and .trk (Trackvis) formats are supported.

Definition at line 272 of file bundles.h.

Constructor & Destructor Documentation

◆ BundleReader()

aims::BundleReader::BundleReader ( const std::string &  fileName)

◆ ~BundleReader()

virtual aims::BundleReader::~BundleReader ( )
virtual

Member Function Documentation

◆ bundleStarted()

virtual void aims::BundleReader::bundleStarted ( const BundleProducer ,
const BundleInfo  
)
protectedvirtual

Reimplemented from aims::BundleListener.

◆ bundleTerminated()

virtual void aims::BundleReader::bundleTerminated ( const BundleProducer ,
const BundleInfo  
)
protectedvirtual

Reimplemented from aims::BundleListener.

◆ fiberStarted()

virtual void aims::BundleReader::fiberStarted ( const BundleProducer ,
const BundleInfo ,
const FiberInfo  
)
protectedvirtual

Reimplemented from aims::BundleListener.

◆ fiberTerminated()

virtual void aims::BundleReader::fiberTerminated ( const BundleProducer ,
const BundleInfo ,
const FiberInfo  
)
protectedvirtual

Reimplemented from aims::BundleListener.

◆ formatExtensions()

static std::set<std::string> aims::BundleReader::formatExtensions ( const std::string &  format = "ALL")
static

◆ newFiberPoint()

virtual void aims::BundleReader::newFiberPoint ( const BundleProducer ,
const BundleInfo ,
const FiberInfo ,
const FiberPoint  
)
protectedvirtual

Reimplemented from aims::BundleListener.

◆ noMoreBundle()

virtual void aims::BundleReader::noMoreBundle ( const BundleProducer )
protectedvirtual

Reimplemented from aims::BundleListener.

◆ read()

void aims::BundleReader::read ( )

read() is the entry point to fibers processing, and triggers the producer machinery.

◆ readHeader()

virtual carto::Object aims::BundleReader::readHeader ( )
virtual

◆ supportedFormats()

static std::set<std::string> aims::BundleReader::supportedFormats ( )
static

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