ncut::BSISequence Class Reference

#include <ncutImage.h>

Inheritance diagram for ncut::BSISequence:

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

Public Member Functions

BSIImageoperator[] (unsigned long)
const BSIImageoperator[] (unsigned long) const
unsigned long nSeg () const
 Get the number of segments in the sequence.
int pushThrough (const Image< BSI_IMAGE_DATATYPE > &frame)
 Push a frame onto the sequence and pop the first frame.
int pushThrough (const BSIImage &frame)
 Push a frame onto the sequence and pop the first frame.
int pushFrame (const Image< BSI_IMAGE_DATATYPE > &frame)
 Push a frame to the back of the sequence.
int pushFrame (const BSIImage &frame)
 Push a frame to the back of the sequence.
void popFrame ()
 Pop the last frame of the sequence.
int clear ()
 Remove all frames from the sequence.
 BSISequence ()
 BSISequence empty constructor
 BSISequence (const BSISequence &clone)
 BSISequence copy constructor.
virtual ~BSISequence ()
 BSISequence destructor.
virtual BSISequenceoperator= (const BSISequence &clone)
 BSISequence assignment operator.

Protected Attributes

unsigned long nSeg_

Detailed Description

A BSISequence keeps track of the total number of segments in the sequence. Only images of type BSIImage are allowed in a BSISequence.


Constructor & Destructor Documentation

ncut::BSISequence::BSISequence  ) 
 

BSISequence empty constructor

Creates an empty BSISequence with=height=channels=segments=0.

ncut::BSISequence::BSISequence const BSISequence clone  ) 
 

BSISequence copy constructor.

Parameters:
clone The BSISequence to be cloned.


Member Function Documentation

int ncut::BSISequence::clear  )  [virtual]
 

Remove all frames from the sequence.

Returns:
0 if successful.
Deletes all frames in the sequence and sets width, height, number of channels and number of segments to zero. The length of the sequence is zero.

Reimplemented from ncut::Sequence< BSI_IMAGE_DATATYPE >.

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

Get the number of segments in the sequence.

Returns:
The number of segments in the seuqence

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

BSISequence assignment operator.

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

void ncut::BSISequence::popFrame  )  [virtual]
 

Pop the last frame of the sequence.

Deletes the last frame and removes it from the sequence. This does nothing if the sequence is empty.

Reimplemented from ncut::Sequence< BSI_IMAGE_DATATYPE >.

int ncut::BSISequence::pushFrame const BSIImage frame  ) 
 

Push a frame to the back of the sequence.

Parameters:
frame The Image to be pushed onto the sequence.
Returns:
0 if successful.
Pushes a copy of Image to the back of the sequence. The length of the sequence is increased by one. Only BSI images of the same dimension as all other images in the sequence are accepted.

int ncut::BSISequence::pushFrame const Image< BSI_IMAGE_DATATYPE > &  frame  )  [virtual]
 

Push a frame to the back of the sequence.

Parameters:
frame The Image to be pushed onto the sequence.
Returns:
0 if successful.
Pushes a copy of Image to the back of the sequence. The length of the sequence is increased by one. Only BSI images of the same dimension as all other images in the sequence are accepted. frame is cast to a BSIImage.

Reimplemented from ncut::Sequence< BSI_IMAGE_DATATYPE >.

int ncut::BSISequence::pushThrough const BSIImage frame  ) 
 

Push a frame onto the sequence and pop the first frame.

Parameters:
frame The Image to be pushed onto the sequence.
Returns:
0 if successful.
Pushes a copy of Image onto the sequence and removes the first frame of the sequence. The length of the sequence remains unchanged. Only BSI images of the same dimension as all other images in the sequence are accepted.

int ncut::BSISequence::pushThrough const Image< BSI_IMAGE_DATATYPE > &  frame  )  [virtual]
 

Push a frame onto the sequence and pop the first frame.

Parameters:
frame The Image to be pushed onto the sequence.
Returns:
0 if successful.
Pushes a copy of Image onto the sequence and removes the first frame of the sequence. The length of the sequence remains unchanged. Only BSI images of the same dimension as all other images in the sequence are accepted. frame is cast to a BSIImage.

Reimplemented from ncut::Sequence< BSI_IMAGE_DATATYPE >.


Member Data Documentation

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

The total number of segments in the sequence.


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