aimsdata  5.0.5
Neuroimaging data handling
aims::BundleSampler Class Reference

Filter fibers by randomly discarding a proportion of them. More...

#include <aims/fibers/bundleSampler.h>

Inheritance diagram for aims::BundleSampler:
Collaboration diagram for aims::BundleSampler:

Public Member Functions

 BundleSampler (float percent, const std::string &bundle_name, const std::string &sampled_bundle_name, int mode)
 Parameters: More...
 
 BundleSampler (float percent, const std::string &bundle_name, const std::string &sampled_bundle_name, int mode, bool discarded)
 Parameters: More...
 
virtual ~BundleSampler ()
 
- Public Member Functions inherited from aims::BundleProducer
void addBundleListener (BundleListener &)
 
- Public Member Functions inherited from aims::BundleListener
virtual ~BundleListener ()
 

Protected Member Functions

virtual void bundleStarted (const aims::BundleProducer &, const aims::BundleInfo &)
 
virtual void bundleTerminated (const aims::BundleProducer &, const aims::BundleInfo &)
 
virtual void fiberStarted (const aims::BundleProducer &, const aims::BundleInfo &, const aims::FiberInfo &)
 
virtual void fiberTerminated (const aims::BundleProducer &, const aims::BundleInfo &, const aims::FiberInfo &)
 
virtual void newFiberPoint (const aims::BundleProducer &, const aims::BundleInfo &, const aims::FiberInfo &, const aims::FiberPoint &)
 
virtual void noMoreBundle (const aims::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

Filter fibers by randomly discarding a proportion of them.

Discarded fibers may optionally be kept in an additional "discarded" bundle.

Definition at line 55 of file bundleSampler.h.

Constructor & Destructor Documentation

◆ BundleSampler() [1/2]

aims::BundleSampler::BundleSampler ( float  percent,
const std::string &  bundle_name,
const std::string &  sampled_bundle_name,
int  mode 
)

Parameters:

Parameters
percentproportion of accepted fibers
bundle_name?
mode0: fibers are randomly selected (default), 1: at least one fiber per bundle is selected

◆ BundleSampler() [2/2]

aims::BundleSampler::BundleSampler ( float  percent,
const std::string &  bundle_name,
const std::string &  sampled_bundle_name,
int  mode,
bool  discarded 
)

Parameters:

Parameters
percentproportion of accepted fibers
bundle_name?
mode0: fibers are randomly selected (default), 1: at least one fiber per bundle is selected
discardedif true, discarded fibers will be used in an additional bundle with the name "discarded".

◆ ~BundleSampler()

virtual aims::BundleSampler::~BundleSampler ( )
virtual

Member Function Documentation

◆ bundleStarted()

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

Reimplemented from aims::BundleListener.

◆ bundleTerminated()

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

Reimplemented from aims::BundleListener.

◆ fiberStarted()

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

Reimplemented from aims::BundleListener.

◆ fiberTerminated()

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

Reimplemented from aims::BundleListener.

◆ newFiberPoint()

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

Reimplemented from aims::BundleListener.

◆ noMoreBundle()

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

Reimplemented from aims::BundleListener.


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