DICe::Conformal_Area_Def Class Reference

A simple container for geometry information defining the boundary of a DICe::Subset. More...

#include <DICe_Shape.h>

Public Member Functions
	Conformal_Area_Def (const multi_shape &boundary)
	Constructor that takes only one argument, the boundary of the subset. More...
	Conformal_Area_Def (const multi_shape &boundary, const multi_shape &excluded_area)
	Constructor to define both the outer boundary and an interior excluded region. More...
	Conformal_Area_Def (const multi_shape &boundary, const multi_shape &excluded_area, const multi_shape &obstructed_area)
	Constructor that defines the outer boundary, an excluded interior region and obstucted areas. More...
bool	has_boundary () const
	Returns true if the boundary has been defined (should be true for a valid Conformal_Area_Def)
bool	has_excluded_area () const
	Returns true if the Conformal_Area_Def has an internal area initially inactive.
bool	has_obstructed_area () const
	Returns true if the Conformal_Area_Def has obstructed areas defined.
const multi_shape *	boundary () const
	Returns a pointer to the multi_shape that defines the boundary.
const multi_shape *	excluded_area () const
	Returns a pointer to the multi_shape that defines the excluded area.
const multi_shape *	obstructed_area () const
	Returns a pointer to the multi_shape that defines the obstructed area.

Private Attributes
bool	has_excluded_area_
	An excluded are has been defined.
bool	has_boundary_
	The boundary has been defined.
bool	has_obstructed_area_
	An obstructed area has been defined.
multi_shape	boundary_
	Defines the boundary.
multi_shape	excluded_area_
	Defines the excluded area.
multi_shape	obstructed_area_
	Defines the obstructed area.

Detailed Description

A simple container for geometry information defining the boundary of a DICe::Subset.

There are three parts to a Conformal_Area_Def. The boundary defines the outer boundary of the region of interest for a subset, the excluded area defines a region interior to the boundary that is deactivated initially (possibly becuase it begins obstructed in the image sequence) and the obstructed area which defines fixed or moving regions in the image in which the pixels should be deactivated. Deactivated pixels do not contribute to the correlation criteria or the optimization process.

Constructor & Destructor Documentation

Conformal_Area_Def() [1/3]

DICe::Conformal_Area_Def::Conformal_Area_Def ( const multi_shape &  boundary )

inline

Constructor that takes only one argument, the boundary of the subset.

Parameters

boundary

A multi_shape the defines the outer perimeter of the subset

Conformal_Area_Def() [2/3]

DICe::Conformal_Area_Def::Conformal_Area_Def ( const multi_shape &  boundary, const multi_shape &  excluded_area  )

inline

Constructor to define both the outer boundary and an interior excluded region.

Parameters

boundary	A multi_shape that defines the outer perimeter ofd the susbet
excluded_area	An additional multi_shape that defines an internal region that should be deactivated

Conformal_Area_Def() [3/3]

DICe::Conformal_Area_Def::Conformal_Area_Def ( const multi_shape &  boundary, const multi_shape &  excluded_area, const multi_shape &  obstructed_area  )

inline

Constructor that defines the outer boundary, an excluded interior region and obstucted areas.

Parameters

boundary	A multi_shape that defines the outer perimeter ofd the susbet
excluded_area	An additional multi_shape that defines an internal region that should be deactivated
obstructed_area	A third multi_shape that defines regions that are obstructed