Now you can download a copy of these docs so you can use them offline! Download now

BinaryImage Class Reference

Inheritance diagram for BinaryImage:
Collaboration diagram for BinaryImage:

List of all members.

Public Member Functions

int GetNumberParticles ()
ParticleAnalysisReport GetParticleAnalysisReport (int particleNumber)
void GetParticleAnalysisReport (int particleNumber, ParticleAnalysisReport *par)
vector< ParticleAnalysisReport > * GetOrderedParticleAnalysisReports ()
virtual void Write (const char *fileName)

Detailed Description

Definition at line 21 of file BinaryImage.h.


Member Function Documentation

int BinaryImage::GetNumberParticles (  ) 

Get then number of particles for the image.

Returns:
the number of particles found for the image.

Definition at line 25 of file BinaryImage.cpp.

vector< ParticleAnalysisReport > * BinaryImage::GetOrderedParticleAnalysisReports (  ) 

Get an ordered vector of particles for the image. Create a vector of particle analysis reports sorted by size for an image. The vector contains the actual report structures.

Returns:
a pointer to the vector of particle analysis reports. The caller must delete the vector when finished using it.

Definition at line 102 of file BinaryImage.cpp.

ParticleAnalysisReport BinaryImage::GetParticleAnalysisReport ( int  particleNumber  ) 

Get a single particle analysis report. Get one (of possibly many) particle analysis reports for an image.

Parameters:
particleNumber Which particle analysis report to return.
Returns:
the selected particle analysis report

Definition at line 39 of file BinaryImage.cpp.

void BinaryImage::GetParticleAnalysisReport ( int  particleNumber,
ParticleAnalysisReport par 
)

Get a single particle analysis report. Get one (of possibly many) particle analysis reports for an image. This version could be more efficient when copying many reports.

Parameters:
particleNumber Which particle analysis report to return.
par the selected particle analysis report

Definition at line 53 of file BinaryImage.cpp.

void BinaryImage::Write ( const char *  fileName  )  [virtual]

Write a binary image to flash. Writes the binary image to flash on the cRIO for later inspection.

Parameters:
fileName the name of the image file written to the flash.

Reimplemented from ImageBase.

Definition at line 123 of file BinaryImage.cpp.


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

Generated on Thu Jan 12 2012 22:35:27 for WPILibC++ by doxygen 1.7.1