Biomedical Image Analysis Library
The Biomedical Image Analysis Library is a poweful tool for developers, physicians, researchers, engineers, and so on.
Bial::OrientedExternPathFunction< D > Class Template Reference

#include <OrientedExternPathFunction.hpp>

Inheritance diagram for Bial::OrientedExternPathFunction< D >:
Inheritance graph
Collaboration diagram for Bial::OrientedExternPathFunction< D >:
Collaboration graph

Public Member Functions

 OrientedExternPathFunction (const Image< D > &handicap, const Image< D > &new_intensity, Image< int > *restriction=nullptr, double new_alpha=0.0)
 Basic constructor. More...
 
 OrientedExternPathFunction (const OrientedExternPathFunction< D > &pf)
 Copy constructor. More...
 
 ~OrientedExternPathFunction ()
 Destructor. More...
 
OrientedExternPathFunction< D > operator= (const OrientedExternPathFunction< D > &pf)
 Assignment operator. More...
 
void Initialize (Image< D > &init_value, Image< int > *init_label, Image< int > *init_predecessor, bool sequential_label)
 Initializes object attributes. More...
 
bool RemoveSimple (size_t index, BucketState state)
 Sets initial value for root pixel of index 'index'. More...
 
bool RemoveLabel (size_t index, BucketState state)
 Sets initial value for root pixel of index 'index'. Also sets its label value. More...
 
bool Capable (int index, int adj_index, BucketState adj_state)
 Checks if index can offer better value to adj_index, prior to computing it by Propagate function. This function makes IFT faster. More...
 
bool Propagate (int index, int adj_index)
 Updates adjacent pixel values and returns true if path_function is propagated. More...
 
bool Increasing ()
 Returns whether this path function uses increasing or decreasing values. More...
 
- Public Member Functions inherited from Bial::PathFunction< Image, D >
 PathFunction ()
 Basic constructor. More...
 
 PathFunction (const PathFunction< Image, D > &pf)
 Copy constructor. More...
 
virtual ~PathFunction ()
 Virtual destructor required for virtual classes. More...
 
void UpdateCompleteData (size_t index, size_t adj_index)
 Updates value, label, and predecessor images of index adj_index according to 'index' and value. One of these functions will be used depending on the chosen resultant images. More...
 
void UpdatePredecessorData (size_t index, size_t adj_index)
 
void UpdateLabelData (size_t index, size_t adj_index)
 
void UpdateSimpleData (size_t index, size_t adj_index)
 
PathFunction< Image, D >::RemoveFn RemoveFunction ()
 Returns a root initialization function that will be used depending on used maps. More...
 
PathFunction< Image, D >::UpdateFn UpdateFunction ()
 Returns an update function that will be used depending on used maps. More...
 

Protected Attributes

const Image< D > & intensity
 Reference to source image. More...
 
Image< D > handicap
 Handicap image. More...
 
Image< int > * geodesic_restriction
 Restrictions to geodesic star. Generated by GeodesicRestriction IFT. More...
 
double alpha
 Orientation weight. 0.0 to 1.0. The higher is the value, the higher is the orientation weight.
Default value is 0.0. More...
 
- Protected Attributes inherited from Bial::PathFunction< Image, D >
Image< D > * value
 Pointer to value container (Vector, Matrix, Image, etc). More...
 
Image< int > * label
 Pointer to label container (Vector, Matrix, Image, etc). More...
 
Image< int > * predecessor
 Pointer to predecessor container (Vector, Matrix, Image, etc). More...
 
int next_label
 

Additional Inherited Members

- Public Types inherited from Bial::PathFunction< Image, D >
typedef bool(PathFunction< Image, D >::* RemoveFn) (size_t index, BucketState state)
 Initialization functions of IFT. It will operate on valid maps among value, label, predecessor, and. More...
 
typedef void(PathFunction< Image, D >::* UpdateFn) (size_t index, size_t adj_index)
 Update functions of IFT. It will operate on valid maps among value, label, and predecessor. More...
 

Detailed Description

template<class D>
class Bial::OrientedExternPathFunction< D >

Definition at line 23 of file OrientedExternPathFunction.hpp.

Constructor & Destructor Documentation

template<class D>
Bial::OrientedExternPathFunction< D >::OrientedExternPathFunction ( const Image< D > &  handicap,
const Image< D > &  new_intensity,
Image< int > *  restriction = nullptr,
double  new_alpha = 0.0 
)

Basic constructor.

Date
2013/Jul/02
Parameters
new_intensitySource image intensity. Value image is a gradient.
restrictionGeodesic path restrictions for data propagation. It is the predecessor map of the Computed GeodesicRestrictionPathFunction IFT.
new_alphaAlpha weight to orient the edges.
Returns
none.
Warning
none.

Copy constructor.

Date
2013/Jul/01
Parameters
pfpath-function to be copied.
Returns
none.
Warning
none.

Destructor.

Date
2013/Jul/01
Parameters
none.
Returns
none.
Warning
none.

Member Function Documentation

template<class D>
bool Bial::OrientedExternPathFunction< D >::Capable ( int  index,
int  adj_index,
BucketState  adj_state 
)
virtual

Checks if index can offer better value to adj_index, prior to computing it by Propagate function. This function makes IFT faster.

Date
2013/Oct/14
Parameters
sourceSource pixel index.
targetAdjacent pixel index.
Returns
True if it is possible to propagate.
Warning
none.

Implements Bial::PathFunction< Image, D >.

template<class D>
bool Bial::OrientedExternPathFunction< D >::Increasing ( )
virtual

Returns whether this path function uses increasing or decreasing values.

Date
2012/Sep/19
Parameters
none.
Returns
True for increasing and false for decreasing values.
Warning
none.

Implements Bial::PathFunction< Image, D >.

template<class D>
void Bial::OrientedExternPathFunction< D >::Initialize ( Image< D > &  init_value,
Image< int > *  init_label,
Image< int > *  init_predecessor,
bool  sequential_label 
)
virtual

Initializes object attributes.

Date
2012/Oct/02
Parameters
init_valueReference for initial value container.
init_labelReference for initial label container.
init_predecessorReference for predecessor container.
sequential_labelSets labeling sequentially.
Returns
none.
Warning
This function is called automatically by IFT constructor.

Reimplemented from Bial::PathFunction< Image, D >.

Assignment operator.

Date
2013/Jul/01
Parameters
pfpath-function to be assigned.
Returns
none.
Warning
none.
template<class D>
bool Bial::OrientedExternPathFunction< D >::Propagate ( int  index,
int  adj_index 
)
virtual

Updates adjacent pixel values and returns true if path_function is propagated.

Date
2013/Jun/28
Parameters
sourceSource pixel index.
targetAdjacent pixel index.
Returns
True if path-value is propagated.
Warning
none.

Implements Bial::PathFunction< Image, D >.

template<class D>
bool Bial::OrientedExternPathFunction< D >::RemoveLabel ( size_t  index,
BucketState  state 
)
virtual

Sets initial value for root pixel of index 'index'. Also sets its label value.

Date
2014/Dec/05
Parameters
indexThe index of the pixel to be initalized.
Returns
Whether this node can propagate or not.
Warning
none.

Implements Bial::PathFunction< Image, D >.

template<class D>
bool Bial::OrientedExternPathFunction< D >::RemoveSimple ( size_t  index,
BucketState  state 
)
virtual

Sets initial value for root pixel of index 'index'.

Date
2012/Sep/25
Parameters
indexThe index of the pixel to be initalized.
Returns
Whether this node can propagate or not.
Warning
none.

Implements Bial::PathFunction< Image, D >.

Member Data Documentation

template<class D>
double Bial::OrientedExternPathFunction< D >::alpha
protected

Orientation weight. 0.0 to 1.0. The higher is the value, the higher is the orientation weight.
Default value is 0.0.

Definition at line 36 of file OrientedExternPathFunction.hpp.

template<class D>
Image< int >* Bial::OrientedExternPathFunction< D >::geodesic_restriction
protected

Restrictions to geodesic star. Generated by GeodesicRestriction IFT.

Definition at line 32 of file OrientedExternPathFunction.hpp.

template<class D>
Image< D > Bial::OrientedExternPathFunction< D >::handicap
protected

Handicap image.

Definition at line 30 of file OrientedExternPathFunction.hpp.

template<class D>
const Image< D >& Bial::OrientedExternPathFunction< D >::intensity
protected

Reference to source image.

Definition at line 28 of file OrientedExternPathFunction.hpp.


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