Now you can download a copy of these docs so you can use them offline! Download now
ColorImage Class Reference
Inheritance diagram for ColorImage:
Collaboration diagram for ColorImage:

Public Member Functions

 ColorImage (ImageType type)
 
BinaryImage * ThresholdRGB (int redLow, int redHigh, int greenLow, int greenHigh, int blueLow, int blueHigh)
 
BinaryImage * ThresholdHSL (int hueLow, int hueHigh, int saturationLow, int saturationHigh, int luminenceLow, int luminenceHigh)
 
BinaryImage * ThresholdHSV (int hueLow, int hueHigh, int saturationLow, int saturationHigh, int valueHigh, int valueLow)
 
BinaryImage * ThresholdHSI (int hueLow, int hueHigh, int saturationLow, int saturationHigh, int intensityLow, int intensityHigh)
 
BinaryImage * ThresholdRGB (Threshold &threshold)
 
BinaryImage * ThresholdHSL (Threshold &threshold)
 
BinaryImage * ThresholdHSV (Threshold &threshold)
 
BinaryImage * ThresholdHSI (Threshold &threshold)
 
MonoImage * GetRedPlane ()
 
MonoImage * GetGreenPlane ()
 
MonoImage * GetBluePlane ()
 
MonoImage * GetHSLHuePlane ()
 
MonoImage * GetHSVHuePlane ()
 
MonoImage * GetHSIHuePlane ()
 
MonoImage * GetHSLSaturationPlane ()
 
MonoImage * GetHSVSaturationPlane ()
 
MonoImage * GetHSISaturationPlane ()
 
MonoImage * GetLuminancePlane ()
 
MonoImage * GetValuePlane ()
 
MonoImage * GetIntensityPlane ()
 
void ReplaceRedPlane (MonoImage *plane)
 
void ReplaceGreenPlane (MonoImage *plane)
 
void ReplaceBluePlane (MonoImage *plane)
 
void ReplaceHSLHuePlane (MonoImage *plane)
 
void ReplaceHSVHuePlane (MonoImage *plane)
 
void ReplaceHSIHuePlane (MonoImage *plane)
 
void ReplaceHSLSaturationPlane (MonoImage *plane)
 
void ReplaceHSVSaturationPlane (MonoImage *plane)
 
void ReplaceHSISaturationPlane (MonoImage *plane)
 
void ReplaceLuminancePlane (MonoImage *plane)
 
void ReplaceValuePlane (MonoImage *plane)
 
void ReplaceIntensityPlane (MonoImage *plane)
 
void ColorEqualize ()
 
void LuminanceEqualize ()
 
- Public Member Functions inherited from ImageBase
 ImageBase (ImageType type)
 
virtual ~ImageBase ()
 
virtual void Write (const char *fileName)
 
int GetHeight ()
 
int GetWidth ()
 
Image * GetImaqImage ()
 
- Public Member Functions inherited from ErrorBase
virtual Error & GetError ()
 Retrieve the current error. Get the current error information associated with this sensor.
 
virtual const Error & GetError () 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 Error & GetGlobalError ()
 
- 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 14 of file ColorImage.h.

Member Function Documentation

void ColorImage::ReplaceBluePlane ( MonoImage *  plane)

Replace the blue color plane with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 352 of file ColorImage.cpp.

void ColorImage::ReplaceGreenPlane ( MonoImage *  plane)

Replace the green color plane with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 342 of file ColorImage.cpp.

void ColorImage::ReplaceHSIHuePlane ( MonoImage *  plane)

Replace the first Hue plane in a HSI image with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 383 of file ColorImage.cpp.

void ColorImage::ReplaceHSISaturationPlane ( MonoImage *  plane)

Replace the Saturation color plane in a HSI image with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 413 of file ColorImage.cpp.

void ColorImage::ReplaceHSLHuePlane ( MonoImage *  plane)

Replace the Hue color plane in a HSL image with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 363 of file ColorImage.cpp.

void ColorImage::ReplaceHSLSaturationPlane ( MonoImage *  plane)

Replace the Saturation color plane in an HSL image with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 393 of file ColorImage.cpp.

void ColorImage::ReplaceHSVHuePlane ( MonoImage *  plane)

Replace the Hue color plane in a HSV image with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 373 of file ColorImage.cpp.

void ColorImage::ReplaceHSVSaturationPlane ( MonoImage *  plane)

Replace the Saturation color plane in a HSV image with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 403 of file ColorImage.cpp.

void ColorImage::ReplaceIntensityPlane ( MonoImage *  plane)

Replace the Intensity color plane in a HSI image with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 443 of file ColorImage.cpp.

void ColorImage::ReplaceLuminancePlane ( MonoImage *  plane)

Replace the Luminance color plane in an HSL image with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 423 of file ColorImage.cpp.

void ColorImage::ReplaceRedPlane ( MonoImage *  plane)

Replace the red color plane with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 332 of file ColorImage.cpp.

void ColorImage::ReplaceValuePlane ( MonoImage *  plane)

Replace the Value color plane in an HSV with a MonoImage.

Parameters
modeThe color mode in which to operate.
planeA pointer to a MonoImage that will replace the specified color plane.

Definition at line 433 of file ColorImage.cpp.

BinaryImage * ColorImage::ThresholdHSI ( int  hueLow,
int  hueHigh,
int  saturationLow,
int  saturationHigh,
int  intensityLow,
int  intensityHigh 
)

Perform a threshold in HSI space.

Parameters
hueLowLow value for hue
hueHighHigh value for hue
saturationLowLow value for saturation
saturationHighHigh value for saturation
valueLowLow intensity
valueHighHigh intensity
Returns
a pointer to a BinaryImage that represents the result of the threshold operation.

Definition at line 132 of file ColorImage.cpp.

BinaryImage * ColorImage::ThresholdHSI ( Threshold &  t)

Perform a threshold in HSI space.

Parameters
thresholda reference to the Threshold object to use.
Returns
A pointer to a BinaryImage that represents the result of the threshold operation.

Definition at line 142 of file ColorImage.cpp.

BinaryImage * ColorImage::ThresholdHSL ( int  hueLow,
int  hueHigh,
int  saturationLow,
int  saturationHigh,
int  luminenceLow,
int  luminenceHigh 
)

Perform a threshold in HSL space.

Parameters
hueLowLow value for hue
hueHighHigh value for hue
saturationLowLow value for saturation
saturationHighHigh value for saturation
luminenceLowLow value for luminence
luminenceHighHigh value for luminence
Returns
a pointer to a BinaryImage that represents the result of the threshold operation.

Definition at line 78 of file ColorImage.cpp.

BinaryImage * ColorImage::ThresholdHSL ( Threshold &  t)

Perform a threshold in HSL space.

Parameters
thresholda reference to the Threshold object to use.
Returns
A pointer to a BinaryImage that represents the result of the threshold operation.

Definition at line 88 of file ColorImage.cpp.

BinaryImage * ColorImage::ThresholdHSV ( int  hueLow,
int  hueHigh,
int  saturationLow,
int  saturationHigh,
int  valueLow,
int  valueHigh 
)

Perform a threshold in HSV space.

Parameters
hueLowLow value for hue
hueHighHigh value for hue
saturationLowLow value for saturation
saturationHighHigh value for saturation
valueLowLow value
valueHighHigh value
Returns
a pointer to a BinaryImage that represents the result of the threshold operation.

Definition at line 105 of file ColorImage.cpp.

BinaryImage * ColorImage::ThresholdHSV ( Threshold &  t)

Perform a threshold in HSV space.

Parameters
thresholda reference to the Threshold object to use.
Returns
A pointer to a BinaryImage that represents the result of the threshold operation.

Definition at line 115 of file ColorImage.cpp.

BinaryImage * ColorImage::ThresholdRGB ( int  redLow,
int  redHigh,
int  greenLow,
int  greenHigh,
int  blueLow,
int  blueHigh 
)

Perform a threshold in RGB space.

Parameters
redLowRed low value
redHighRed high value
greenLowGreen low value
greenHighGreen high value
blueLowBlue low value
blueHighBlue high value
Returns
A pointer to a BinaryImage that represents the result of the threshold operation.

Definition at line 51 of file ColorImage.cpp.

BinaryImage * ColorImage::ThresholdRGB ( Threshold &  t)

Perform a threshold in RGB space.

Parameters
thresholda reference to the Threshold object to use.
Returns
A pointer to a BinaryImage that represents the result of the threshold operation.

Definition at line 61 of file ColorImage.cpp.


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

Generated on Sat Apr 26 2014 12:26:45 for WPILibC++ by doxygen 1.8.6