WPILibC++  unspecified
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
ColorImage Class Reference
Inheritance diagram for ColorImage:
ImageBase ErrorBase HSLImage RGBImage

Public Member Functions

 ColorImage (ImageType type)
 
BinaryImageThresholdRGB (int redLow, int redHigh, int greenLow, int greenHigh, int blueLow, int blueHigh)
 Perform a threshold in RGB space. More...
 
BinaryImageThresholdHSL (int hueLow, int hueHigh, int saturationLow, int saturationHigh, int luminenceLow, int luminenceHigh)
 Perform a threshold in HSL space. More...
 
BinaryImageThresholdHSV (int hueLow, int hueHigh, int saturationLow, int saturationHigh, int valueHigh, int valueLow)
 Perform a threshold in HSV space. More...
 
BinaryImageThresholdHSI (int hueLow, int hueHigh, int saturationLow, int saturationHigh, int intensityLow, int intensityHigh)
 Perform a threshold in HSI space. More...
 
BinaryImageThresholdRGB (Threshold &threshold)
 Perform a threshold in RGB space. More...
 
BinaryImageThresholdHSL (Threshold &threshold)
 Perform a threshold in HSL space. More...
 
BinaryImageThresholdHSV (Threshold &threshold)
 Perform a threshold in HSV space. More...
 
BinaryImageThresholdHSI (Threshold &threshold)
 Perform a threshold in HSI space. More...
 
MonoImageGetRedPlane ()
 
MonoImageGetGreenPlane ()
 
MonoImageGetBluePlane ()
 
MonoImageGetHSLHuePlane ()
 
MonoImageGetHSVHuePlane ()
 
MonoImageGetHSIHuePlane ()
 
MonoImageGetHSLSaturationPlane ()
 
MonoImageGetHSVSaturationPlane ()
 
MonoImageGetHSISaturationPlane ()
 
MonoImageGetLuminancePlane ()
 
MonoImageGetValuePlane ()
 
MonoImageGetIntensityPlane ()
 
void ReplaceRedPlane (MonoImage *plane)
 Replace the red color plane with a MonoImage. More...
 
void ReplaceGreenPlane (MonoImage *plane)
 Replace the green color plane with a MonoImage. More...
 
void ReplaceBluePlane (MonoImage *plane)
 Replace the blue color plane with a MonoImage. More...
 
void ReplaceHSLHuePlane (MonoImage *plane)
 Replace the Hue color plane in a HSL image with a MonoImage. More...
 
void ReplaceHSVHuePlane (MonoImage *plane)
 Replace the Hue color plane in a HSV image with a MonoImage. More...
 
void ReplaceHSIHuePlane (MonoImage *plane)
 Replace the first Hue plane in a HSI image with a MonoImage. More...
 
void ReplaceHSLSaturationPlane (MonoImage *plane)
 Replace the Saturation color plane in an HSL image with a MonoImage. More...
 
void ReplaceHSVSaturationPlane (MonoImage *plane)
 Replace the Saturation color plane in a HSV image with a MonoImage. More...
 
void ReplaceHSISaturationPlane (MonoImage *plane)
 Replace the Saturation color plane in a HSI image with a MonoImage. More...
 
void ReplaceLuminancePlane (MonoImage *plane)
 Replace the Luminance color plane in an HSL image with a MonoImage. More...
 
void ReplaceValuePlane (MonoImage *plane)
 Replace the Value color plane in an HSV with a MonoImage. More...
 
void ReplaceIntensityPlane (MonoImage *plane)
 Replace the Intensity color plane in a HSI image with a MonoImage. More...
 
void ColorEqualize ()
 
void LuminanceEqualize ()
 
- Public Member Functions inherited from ImageBase
 ImageBase (ImageType type)
 Create a new instance of an ImageBase. More...
 
virtual ~ImageBase ()
 Frees memory associated with an ImageBase. More...
 
virtual void Write (const char *fileName)
 Writes an image to a file with the given filename. More...
 
int GetHeight ()
 Gets the height of an image. More...
 
int GetWidth ()
 Gets the width of an image. More...
 
Image * GetImaqImage ()
 Access the internal IMAQ Image data structure. More...
 
- Public Member Functions inherited from ErrorBase
 ErrorBase (const ErrorBase &)=delete
 
ErrorBaseoperator= (const ErrorBase &)=delete
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () const
 
virtual void SetErrnoError (llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef 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, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (llvm::StringRef errorMessage, Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (const 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, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber)
 
static void SetGlobalWPIError (llvm::StringRef errorMessage, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber)
 
static ErrorGetGlobalError ()
 Retrieve the current global error.
 
- Protected Attributes inherited from ImageBase
Image * m_imaqImage
 
- Protected Attributes inherited from ErrorBase
Error m_error
 
- Static Protected Attributes inherited from ErrorBase
static priority_mutex _globalErrorMutex
 
static Error _globalError
 

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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.

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