WPILibC++  trunk
Public Member Functions | List of all members
BinaryImage Class Reference
Inheritance diagram for BinaryImage:
Inheritance graph
[legend]
Collaboration diagram for BinaryImage:
Collaboration graph
[legend]

Public Member Functions

int GetNumberParticles ()
 
ParticleAnalysisReport GetParticleAnalysisReport (int particleNumber)
 
void GetParticleAnalysisReport (int particleNumber, ParticleAnalysisReport *par)
 
vector< ParticleAnalysisReport > * GetOrderedParticleAnalysisReports ()
 
BinaryImageRemoveSmallObjects (bool connectivity8, int erosions)
 
BinaryImageRemoveLargeObjects (bool connectivity8, int erosions)
 
BinaryImageConvexHull (bool connectivity8)
 
BinaryImageParticleFilter (ParticleFilterCriteria2 *criteria, int criteriaCount)
 
virtual void Write (const char *fileName)
 
- Public Member Functions inherited from MonoImage
vector< EllipseMatch > * DetectEllipses (EllipseDescriptor *ellipseDescriptor, CurveOptions *curveOptions, ShapeDetectionOptions *shapeDetectionOptions, ROI *roi)
 
vector< EllipseMatch > * DetectEllipses (EllipseDescriptor *ellipseDescriptor)
 
- Public Member Functions inherited from ImageBase
 ImageBase (ImageType type)
 
virtual ~ImageBase ()
 
int GetHeight ()
 
int GetWidth ()
 
Image * GetImaqImage ()
 
- Public Member Functions inherited from ErrorBase
virtual ErrorGetError ()
 Retrieve the current error. Get the current error information associated with this sensor.
 
virtual const ErrorGetError () const
 
virtual void SetErrnoError (const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
 Set error information associated with a C library call that set an error to the "errno" global variable. More...
 
virtual void SetImaqError (int success, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (ErrorBase *rhs) const
 
virtual void ClearError () const
 Clear the current error information associated with this sensor.
 
virtual bool StatusIsFatal () const
 Check if the current error code represents a fatal error. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ErrorBase
static void SetGlobalError (Error::Code code, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber)
 
static void SetGlobalWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber)
 
static ErrorGetGlobalError ()
 
- Protected Member Functions inherited from ErrorBase
 ErrorBase ()
 Initialize the instance status to 0 for now.
 
- Protected Attributes inherited from ImageBase
Image * m_imaqImage
 
- Protected Attributes inherited from ErrorBase
Error m_error
 
- Static Protected Attributes inherited from ErrorBase
static SEM_ID _globalErrorMutex = semMCreate(SEM_Q_PRIORITY | SEM_DELETE_SAFE | SEM_INVERSION_SAFE)
 
static Error _globalError
 

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 26 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 103 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
particleNumberWhich particle analysis report to return.
Returns
the selected particle analysis report

Definition at line 40 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
particleNumberWhich particle analysis report to return.
parthe selected particle analysis report

Definition at line 54 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
fileNamethe name of the image file written to the flash.

Reimplemented from ImageBase.

Definition at line 124 of file BinaryImage.cpp.


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