ncut::BSIImage Class Reference

#include <ncutImage.h>

Inheritance diagram for ncut::BSIImage:

ncut::Image< BSI_IMAGE_DATATYPE > List of all members.

Public Member Functions

unsigned long nSeg () const
 Get the number of segments of the images.
int load (const char *filename, unsigned long modNum=0)
 Load the BSI image file "filename".
 BSIImage ()
 BSIImage empty constructor.
 BSIImage (const BSIImage &clone)
 BSIImage copy constructor.
 BSIImage (const char *filename, unsigned long &modNum)
 A BSIImage can be constructed using a BSI image stored on disk.
virtual ~BSIImage ()
 &BSIImage destructor.
virtual BSIImageoperator= (const BSIImage &clone)
 BSIImage assignment operator.

Protected Attributes

unsigned long nSeg_

Detailed Description

BSIImage adds BSI-specific load and functionality to its base class Image. It also provides information about the number of segments and the maximum label number stored.


Constructor & Destructor Documentation

ncut::BSIImage::BSIImage  ) 
 

BSIImage empty constructor.

Creates an empty image with width=height=channels=0.

ncut::BSIImage::BSIImage const BSIImage clone  ) 
 

BSIImage copy constructor.

Parameters:
clone The BSIImage to be cloned.

ncut::BSIImage::BSIImage const char *  filename,
unsigned long &  modNum
 

A BSIImage can be constructed using a BSI image stored on disk.

Parameters:
filename A char array specifying the location of a BSI image.
modNum A constant to be added to all labels.
Creates a BSIImage from the BSI image located at filename and optionally adds the constant modNum to all labels in the BSI image to avoid duplicate labels in a sequence of BSI images.


Member Function Documentation

int ncut::BSIImage::load const char *  filename,
unsigned long  modNum = 0
 

Load the BSI image file "filename".

Parameters:
filename A char array specifying the location of a BSI image.
modNum A constant to be added to all labels.
Returns:
0 if successful.
Replaces this BSI image with the BSI image located at filename and optionally adds the constant modNum to all labels in the BSI image to avoid duplicate labels in a sequence of BSI images.

unsigned long ncut::BSIImage::nSeg  )  const [inline]
 

Get the number of segments of the images.

Returns:
The number of segemtns of the images

BSIImage & ncut::BSIImage::operator= const BSIImage clone  )  [virtual]
 

BSIImage assignment operator.

Parameters:
clone The BSIImage to be cloned.
Returns:
This object.


Member Data Documentation

unsigned long ncut::BSIImage::nSeg_ [protected]
 

The number of segments in this BSI image


The documentation for this class was generated from the following files:
Generated on Thu Jun 22 14:47:22 2006 for ncut.kdevelop by  doxygen 1.4.6