Visual Servoing Platform  version 3.6.1 under development (2024-04-27)
Public Member Functions | Public Attributes | Friends | Related Functions | List of all members
vpImage< Type > Class Template Reference
core: Core module » Image manipulation

#include <visp3/core/vpImage.h>

Public Member Functions

 vpImage ()
 
 vpImage (const vpImage< Type > &)
 
 vpImage (unsigned int height, unsigned int width)
 
 vpImage (unsigned int height, unsigned int width, Type value)
 
 vpImage (Type *const array, unsigned int height, unsigned int width, bool copyData=false)
 
virtual ~vpImage ()
 
void getMinMaxValue (vpRGBf &min, vpRGBf &max, bool onlyFiniteVal) const
 

Public Attributes

Type * bitmap
 
vpDisplay * display
 

Friends

class vpImageConvert
 

Related Functions

(Note that these are not member functions.)

template<class Type >
void init (unsigned int h, unsigned int w, Type value)
 
template<class Type >
void init (unsigned int h, unsigned int w)
 
template<class Type >
void init (Type *const array, unsigned int h, unsigned int w, bool copyData)
 
template<class Type >
 vpImage (unsigned int h, unsigned int w)
 
template<class Type >
 vpImage (unsigned int h, unsigned int w, Type value)
 
template<class Type >
 vpImage (Type *const array, unsigned int h, unsigned int w, bool copyData)
 
template<class Type >
 vpImage ()
 
template<class Type >
 vpImage (const vpImage< Type > &I)
 
template<>
void getMinMaxValue (double &min, double &max, bool onlyFiniteVal) const
 
template<>
void getMinMaxValue (float &min, float &max, bool onlyFiniteVal) const
 
template<>
double getValue (double i, double j) const
 
template<>
double getValue (const vpImagePoint &ip) const
 
template<>
void performLut (const unsigned char(&lut)[256], unsigned int nbThreads)
 
template<>
void performLut (const vpRGBa(&lut)[256], unsigned int nbThreads)
 

Inherited functionalities from vpImage

std::ostream & operator<< (std::ostream &s, const vpImage< Type > &I)
 
std::ostream & operator<< (std::ostream &s, const vpImage< unsigned char > &I)
 
std::ostream & operator<< (std::ostream &s, const vpImage< char > &I)
 
std::ostream & operator<< (std::ostream &s, const vpImage< float > &I)
 
std::ostream & operator<< (std::ostream &s, const vpImage< double > &I)
 
void swap (vpImage< Type > &first, vpImage< Type > &second)
 
void destroy ()
 
void doubleSizeImage (vpImage< Type > &res)
 
unsigned int getCols () const
 
unsigned int getHeight () const
 
Type getMaxValue (bool onlyFiniteVal=true) const
 
double getMeanValue (const vpImage< bool > *p_mask=nullptr, unsigned int *nbValidPoints=nullptr) const
 
Type getMinValue (bool onlyFiniteVal=true) const
 
void getMinMaxValue (Type &min, Type &max, bool onlyFiniteVal=true) const
 
void getMinMaxLoc (vpImagePoint *minLoc, vpImagePoint *maxLoc, Type *minVal=nullptr, Type *maxVal=nullptr) const
 
unsigned int getNumberOfPixel () const
 
unsigned int getRows () const
 
unsigned int getSize () const
 
double getStdev (const vpImage< bool > *p_mask=nullptr, unsigned int *nbValidPoints=nullptr) const
 
double getStdev (const double &mean, const vpImage< bool > *p_mask=nullptr, unsigned int *nbValidPoints=nullptr) const
 
double getSum (const vpImage< bool > *p_mask=nullptr, unsigned int *nbValidPoints=nullptr) const
 
Type getValue (unsigned int i, unsigned int j) const
 
Type getValue (double i, double j) const
 
Type getValue (const vpImagePoint &ip) const
 
unsigned int getWidth () const
 
void halfSizeImage (vpImage< Type > &res) const
 
void init (unsigned int height, unsigned int width)
 
void init (unsigned int height, unsigned int width, Type value)
 
void init (Type *const array, unsigned int height, unsigned int width, bool copyData=false)
 
void insert (const vpImage< Type > &src, const vpImagePoint &topLeft)
 
Type * operator[] (unsigned int i)
 
Type * operator[] (int i)
 
const Type * operator[] (unsigned int i) const
 
const Type * operator[] (int i) const
 
Type operator() (unsigned int i, unsigned int j) const
 
void operator() (unsigned int i, unsigned int j, const Type &v)
 
Type operator() (const vpImagePoint &ip) const
 
void operator() (const vpImagePoint &ip, const Type &v)
 
vpImage< Type > operator- (const vpImage< Type > &B) const
 
vpImage< Type > & operator= (vpImage< Type > other)
 
vpImage< Type > & operator= (const Type &v)
 
bool operator== (const vpImage< Type > &I) const
 
bool operator!= (const vpImage< Type > &I) const
 
void performLut (const Type(&lut)[256], unsigned int nbThreads=1)
 
void quarterSizeImage (vpImage< Type > &res) const
 
void resize (unsigned int h, unsigned int w)
 
void resize (unsigned int h, unsigned int w, const Type &val)
 
void sub (const vpImage< Type > &B, vpImage< Type > &C) const
 
void sub (const vpImage< Type > &A, const vpImage< Type > &B, vpImage< Type > &C) const
 
void subsample (unsigned int v_scale, unsigned int h_scale, vpImage< Type > &sampled) const
 

Detailed Description

template<class Type>
class vpImage< Type >

Definition of the vpImage class member functions.

This is a template class, therefore the type of each element of the array is not a priori defined.

Data structure

Each image is build using two structure (an array bitmap which size is [width*height]) and an array of pointer row (which size is [nrow]) the ith element in the row array row[i] is pointer toward the ith "line" of the image (ie, bitmap +i*width )

Such a structure allows a fast access to each element of the image. if i is the ith rows and j the jth columns the value of this pixel is given by I[i][j] (that is equivalent to row[i][j]).

Example

The following example available in tutorial-image-manipulation.cpp shows how to create gray level and color images and how to access to the pixels.

#include <visp3/core/vpImage.h>
int main()
{
try {
vpImage<unsigned char> gray_image(240, 320);
vpImage<vpRGBa> color_image(240, 320);
gray_image = 128;
vpRGBa color(255, 0, 0);
color_image = color;
unsigned int igray_max = gray_image.getHeight() - 1;
unsigned int jgray_max = gray_image.getWidth() - 1;
std::cout << "Gray image, last pixel intensity: " << (int)gray_image[igray_max][jgray_max] << std::endl;
unsigned int icolor_max = color_image.getHeight() - 1;
unsigned int jcolor_max = color_image.getWidth() - 1;
std::cout << "Color image, last pixel RGB components: " << (int)color_image[icolor_max][jcolor_max].R << " "
<< (int)color_image[icolor_max][jcolor_max].G << " " << (int)color_image[icolor_max][jcolor_max].B
<< std::endl;
} catch (const vpException &e) {
std::cout << "Catch an exception: " << e << std::endl;
}
}
vpException
error that can be emitted by ViSP classes.
Definition: vpException.h:59
vpRGBa
Definition: vpRGBa.h:61

Important remark

To provide high-performance access there is no verification to ensure that 0 $\le$ i < height and 0 $\le$ j < width. Since the memory allocated in the bitmap array is continuous, that means that if (i, j) is outside the image you will manipulate a pixel that is not as expected. To highlight this remark, we provide hereafter an example where the considered pixel is outside the image:

unsigned int width = 320;
unsigned int height = 240;
vpImage<unsigned char> I(height, width); // Create an 320x240 image
// Set pixel coordinates that is outside the image
unsigned int i = 100;
unsigned int j = 400;
unsigned char value;
value = I[i][j]; // Here we will get the pixel value at position (101, 80)
Examples
grabRealSense2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, readRealSenseData.cpp, saveRealSenseData.cpp, testColorConversion.cpp, testConnectedComponents.cpp, testDisplays.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageGetValue.cpp, testImageMeanAndStdev.cpp, testImagePrint.cpp, testIoEXR.cpp, testIoPFM.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint-7.cpp, testKeyPoint.cpp, testRealSense2_D435.cpp, testRealSense2_D435_align.cpp, testRealSense2_D435_pcl.cpp, testRealSense2_SR300.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-connected-components.cpp, tutorial-grabber-rgbd-D435-structurecore.cpp, tutorial-hsv-segmentation-pcl-viewer.cpp, tutorial-hsv-segmentation-pcl.cpp, tutorial-image-colormap.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd.cpp, and tutorial-pose-from-planar-object.cpp.

Definition at line 72 of file vpImage.h.

Constructor & Destructor Documentation

◆ vpImage() [1/5]

template<class Type >
vpImage ( )

constructor

Definition at line 760 of file vpImage.h.

◆ vpImage() [2/5]

template<class Type >
vpImage ( const vpImage< Type > &  I)

copy constructor

Definition at line 839 of file vpImage.h.

References vpImage< Type >::bitmap, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

◆ vpImage() [3/5]

template<class Type >
vpImage ( unsigned int  height,
unsigned int  width 
)

constructor set the size of the image

Definition at line 730 of file vpImage.h.

References vpImage< Type >::init().

◆ vpImage() [4/5]

template<class Type >
vpImage ( unsigned int  height,
unsigned int  width,
Type  value 
)

constructor set the size of the image and init all the pixel

Definition at line 740 of file vpImage.h.

References vpImage< Type >::init().

◆ vpImage() [5/5]

template<class Type >
vpImage ( Type *const  array,
unsigned int  height,
unsigned int  width,
bool  copyData = false 
)

constructor from an image stored as a continuous array in memory

Definition at line 750 of file vpImage.h.

References vpImage< Type >::init().

◆ ~vpImage()

template<class Type >
vpImage< Type >::~vpImage
virtual

destructor

Destructor : Memory de-allocation.

Warning
does not deallocate memory for display and video

Definition at line 833 of file vpImage.h.

Member Function Documentation

◆ destroy()

template<class Type >
void vpImage< Type >::destroy

Destructor : Memory de-allocation.

Warning
does not deallocate memory for display and video

Definition at line 812 of file vpImage.h.

Referenced by vpImageFilter::filter(), vpImageFilter::gaussianBlur(), and vpTemplateTracker::initTracking().

◆ doubleSizeImage()

template<class Type >
void vpImage< Type >::doubleSizeImage ( vpImage< Type > &  res)

Returns a new image that's double size of the current image. Used (eg. in case of keypoints extraction, we might double size of the image in order to have more keypoints). The double size image is computed by nearest-neighbour interpolation:

A B C
E F G
H I J
where
A C H J are pixels from original image
B E G I are interpolated pixels
Warning
Operator = must be defined for Type.
Parameters
res[out] : Image that is double size of the current image.

The example below shows how to use this method:

vpImage<unsigned char> I; // original image
vpImageIo::read(I, "myImage.pgm");
vpImage<unsigned char> I2; // double size image
I.doubleSizeImage(I2);
vpImageIo::write(I2, "myDoubleSizeImage.pgm");
vpImageIo::read
static void read(vpImage< unsigned char > &I, const std::string &filename, int backend=IO_DEFAULT_BACKEND)
Definition: vpImageIo.cpp:143
vpImageIo::write
static void write(const vpImage< unsigned char > &I, const std::string &filename, int backend=IO_DEFAULT_BACKEND)
Definition: vpImageIo.cpp:287
vpImage::doubleSizeImage
void doubleSizeImage(vpImage< Type > &res)
Definition: vpImage.h:1716

See halfSizeImage(vpImage<Type> &) for an example of pyramid construction.

Definition at line 1716 of file vpImage.h.

References vpImage< Type >::resize().

◆ getCols()

template<class Type >
unsigned int vpImage< Type >::getCols ( ) const
inline

Get the number of columns in the image.

Returns
The image number of column, or image width.
See also
getWidth()

Definition at line 175 of file vpImage.h.

Referenced by vpCircleHoughTransform::computeCenterCandidates(), vpImageConvert::convert(), vpMomentObject::fromImage(), vpMeTracker::inMeMaskCandidates(), and vpMbKltTracker::reinit().

◆ getHeight()

template<class Type >
unsigned int vpImage< Type >::getHeight ( ) const
inline

Get the image height.

Returns
The image height.
See also
getWidth()
Examples
saveRealSenseData.cpp, testColorConversion.cpp, testConnectedComponents.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testIoEXR.cpp, testIoPFM.cpp, testKeyPoint-3.cpp, testKeyPoint.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, and tutorial-image-colormap.cpp.

Definition at line 184 of file vpImage.h.

Referenced by vpDiskGrabber::acquire(), vp1394CMUGrabber::acquire(), vpV4l2Grabber::acquire(), vp1394TwoGrabber::acquire(), vpImageTools::binarise(), vpHistogram::calculate(), vpImageTools::changeLUT(), vp::clahe(), vpMbtDistanceLine::closeToImageBorder(), vpImageTools::columnMean(), vpImageFilter::computeCannyThreshold(), vpCircleHoughTransform::computeCircleProbability(), vpImageFilter::computePartialDerivatives(), vpImageCircle::computePixelsInMask(), vpPose::computePlanarObjectPoseFromRGBD(), vpMbTracker::computeProjectionErrorImpl(), vpMeLine::computeRhoTheta(), vpCircleHoughTransform::computeVotingMask(), vp::connectedComponents(), vpColormap::convert(), vpImageConvert::convert(), vpMeSite::convolution(), vpKeyPoint::createImageMatching(), vpImageTools::crop(), vp1394TwoGrabber::dequeue(), vpCannyEdgeDetection::detect(), vpDetectorDataMatrixCode::detect(), vpDetectorQRCode::detect(), vpImageMorphology::dilatation(), vpHistogram::display(), vpMbtDistanceCylinder::display(), vpMbtDistanceLine::display(), vpMbtFaceDepthDense::display(), vpMbtFaceDepthNormal::display(), vpMbDepthDenseTracker::display(), vpMbDepthNormalTracker::display(), vpMbEdgeKltTracker::display(), vpMbEdgeTracker::display(), vpMbKltTracker::display(), vpWireFrameSimulator::display_scene(), vpMbtFaceDepthNormal::displayFeature(), vpDisplayGTK::displayImageROI(), vpMeLine::displayLine(), vpDisplay::displayLine(), vpFeatureDisplay::displayLine(), vpKeyPoint::displayMatching(), vpCircleHoughTransform::edgeDetection(), vpHistogram::equalize(), vp::equalizeHistogram(), vpImageMorphology::erosion(), vp::fillHoles(), vpTemplateTrackerZone::fillTriangle(), vpImageFilter::filter(), vpCircleHoughTransform::filterEdgeMap(), vpImageFilter::filterX(), vpImageFilter::filterY(), vp::findContours(), vpImageTools::flip(), vp::floodFill(), vp::gammaCorrection(), vpSimulatorAfma6::getCameraParameters(), vpSimulatorViper850::getCameraParameters(), vpAfma6::getCameraParameters(), vpViper650::getCameraParameters(), vpViper850::getCameraParameters(), vpServolens::getCameraParameters(), vpTemplateTrackerSSD::getCost(), vpTemplateTrackerZNCC::getCost(), vpTemplateTrackerMI::getCost(), vpKinect::getDepthMap(), vpRobotWireFrameSimulator::getExternalCameraParameters(), vpWireFrameSimulator::getExternalCameraParameters(), vpSimulatorAfma6::getExternalImage(), vpSimulatorViper850::getExternalImage(), vpWireFrameSimulator::getExternalImage(), vpVideoReader::getFrame(), vpImageFilter::getGaussPyramidal(), vpImageFilter::getGaussXPyramidal(), vpImageFilter::getGaussYPyramidal(), vpImageFilter::getGradX(), vpImageFilter::getGradY(), vpRobotBebop2::getGrayscaleImage(), vpImageSimulator::getImage(), vpWireFrameSimulator::getInternalCameraParameters(), vpWireFrameSimulator::getInternalImage(), vpRobotWireFrameSimulator::getInternalView(), vpTemplateTrackerMI::getMI(), vpTemplateTrackerMI::getMI256(), vpPolygon3D::getNbCornerInsideImage(), vpTemplateTrackerMI::getNormalizedCost(), vpAROgre::getRenderingOutput(), vpRobotBebop2::getRGBaImage(), vpTemplateTrackerSSD::getSSD(), vpImage< Type >::getStdev(), vpImage< Type >::getSum(), vpImageTools::imageAdd(), vpImageTools::imageDifference(), vpImageTools::imageDifferenceAbsolute(), vpImageTools::imageSubtract(), vpMbDepthDenseTracker::init(), vpMbDepthNormalTracker::init(), vpMbEdgeTracker::init(), vpMbKltTracker::init(), vpAROgre::init(), vpDisplayGTK::init(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpDisplayWin32::init(), drawingHelpers::init(), vpTemplateTrackerZone::initFromPoints(), vpTemplateTrackerZNCCForwardAdditional::initHessienDesired(), vpTemplateTrackerZNCCInverseCompositional::initHessienDesired(), vpTemplateTrackerMIESM::initHessienDesired(), vpTemplateTrackerMIForwardAdditional::initHessienDesired(), vpTemplateTrackerMIForwardCompositional::initHessienDesired(), vpTemplateTrackerMIInverseCompositional::initHessienDesired(), vpMbtDistanceLine::initMovingEdge(), vpMbEdgeTracker::initPyramid(), vpTemplateTracker::initTracking(), vpImageTools::inMask(), vpImage< Type >::insert(), vpKeyPoint::insertImageMatching(), vpImageTools::integralImage(), vpMeEllipse::leastSquare(), vpMeEllipse::leastSquareRobust(), vpMeNurbs::localReSample(), vpImageConvert::merge(), vpWireFrameSimulator::navigation(), vpImageTools::normalize(), vpImageTools::normalizedCorrelation(), vpDiskGrabber::open(), vpVideoWriter::open(), vpImage< Type >::operator==(), vpImage< Type >::performLut(), vpMeEllipse::plugHoles(), vpMbKltTracker::postTracking(), vpMbEdgeKltTracker::postTracking(), vpColorDepthConversion::projectColorToDepth(), vp::reconstruct(), vpMbKltTracker::reinit(), vpImageTools::remap(), vpImageTools::resize(), vpImageTools::resizeBilinear(), vp::retinex(), vpPolygon3D::roiInsideImage(), vpMeNurbs::sample(), vpMeEllipse::sample(), vpMeLine::sample(), vpDot2::searchDotsInArea(), vpMeLine::seekExtremities(), vpMeNurbs::seekExtremities(), vpMeNurbs::seekExtremitiesCanny(), vpImageFilter::sepFilter(), vpAR::setImage(), vpMbEdgeKltTracker::setPose(), vpMbKltTracker::setPose(), vpImageConvert::split(), vp::stretchContrast(), vp::stretchContrastHSV(), vpImage< Type >::sub(), vpImageTools::templateMatching(), vpMbEdgeTracker::track(), vpTemplateTrackerSSDESM::trackNoPyr(), vpTemplateTrackerSSDForwardAdditional::trackNoPyr(), vpTemplateTrackerSSDForwardCompositional::trackNoPyr(), vpTemplateTrackerSSDInverseCompositional::trackNoPyr(), vpTemplateTrackerZNCCForwardAdditional::trackNoPyr(), vpTemplateTrackerZNCCInverseCompositional::trackNoPyr(), vpTemplateTrackerMIESM::trackNoPyr(), vpTemplateTrackerMIForwardAdditional::trackNoPyr(), vpTemplateTrackerMIForwardCompositional::trackNoPyr(), vpTemplateTrackerMIInverseCompositional::trackNoPyr(), vpImageTools::undistort(), vp::unsharpMask(), vpMbtDistanceLine::updateMovingEdge(), vpMbEdgeTracker::visibleFace(), vpDisplayGDI::vpDisplayGDI(), vpDisplayGTK::vpDisplayGTK(), vpDisplayOpenCV::vpDisplayOpenCV(), vpDisplayX::vpDisplayX(), vpImage< Type >::vpImage(), vpImageTools::warpImage(), vpImageTools::warpLinear(), and vpKinect::warpRGBFrame().

◆ getMaxValue()

template<class Type >
float getMaxValue ( bool  onlyFiniteVal = true) const
inline

Return the maximum value within the bitmap.

Return the maximum value within the float bitmap.

Return the maximum value within the double bitmap.

Parameters
onlyFiniteVal: This parameter is ignored for non double or non float bitmap. If true, consider only finite values.
See also
getMinValue()

Definition at line 874 of file vpImage.h.

References vpException::fatalError.

◆ getMeanValue()

template<class Type >
double vpImage< Type >::getMeanValue ( const vpImage< bool > *  p_mask = nullptr,
unsigned int *  nbValidPoints = nullptr 
) const

Return the mean value of the bitmap.

For vpRGBa and vpRGBf image types, the sum of image intensities is computed by (R+G+B).

Parameters
[in]p_maskOptional parameter. If not set to nullptr, a boolean mask that indicates which points must be considered, if set to true.
[out]nbValidPointsOptional parameter. When different from nullptr contains the number of points that are valid according to the boolean mask or image size when p_mask is set to nullptr.

Definition at line 954 of file vpImage.h.

References vpException::divideByZeroError.

Referenced by vpImageTools::normalizedCorrelation().

◆ getMinMaxLoc()

template<class Type >
void vpImage< Type >::getMinMaxLoc ( vpImagePoint *  minLoc,
vpImagePoint *  maxLoc,
Type *  minVal = nullptr,
Type *  maxVal = nullptr 
) const

Get the position of the minimum and/or the maximum pixel value within the bitmap and the corresponding value. Following code allows retrieving only minimum value and position:

vpImage<double> I(h, w);
//[...] Fill I
vpImagePoint min_loc;
double min_val = 0.0;
I.getMinMaxLoc(&min_loc, nullptr, &min_val, nullptr);
vpImagePoint
Class that defines a 2D point in an image. This class is useful for image processing and stores only ...
Definition: vpImagePoint.h:82
vpImage::getMinMaxLoc
void getMinMaxLoc(vpImagePoint *minLoc, vpImagePoint *maxLoc, Type *minVal=nullptr, Type *maxVal=nullptr) const
Get the position of the minimum and/or the maximum pixel value within the bitmap and the correspondin...
Definition: vpImage.h:1399
Parameters
minLoc: Position of the pixel with minimum value if not nullptr.
maxLoc: Position of the pixel with maximum value if not nullptr.
minVal: Minimum pixel value if not nullptr.
maxVal: Maximum pixel value if not nullptr.
See also
getMaxValue()
getMinValue()
getMinMaxValue()

Definition at line 1399 of file vpImage.h.

References vpException::fatalError, and vpImagePoint::set_ij().

◆ getMinMaxValue() [1/2]

template<class Type >
void vpImage< Type >::getMinMaxValue ( Type &  min,
Type &  max,
bool  onlyFiniteVal = true 
) const

Look for the minimum and the maximum value within the bitmap.

Parameters
min: The minimal value within the bitmap.
max: The maximal value within the bitmap.
onlyFiniteVal: This parameter is ignored for non double or non float bitmap.
See also
getMaxValue()
getMinValue()
getMinMaxLoc()

Definition at line 1230 of file vpImage.h.

References vpException::fatalError.

Referenced by vpImageConvert::convert(), vpColormap::convert(), vp::stretchContrast(), and vp::stretchContrastHSV().

◆ getMinMaxValue() [2/2]

void vpImage< vpRGBf >::getMinMaxValue ( vpRGBf &  min,
vpRGBf &  max,
bool  onlyFiniteVal 
) const
inline

Look for the minimum and the maximum value within the 3-channels float bitmap.

Parameters
min: The minimal values within the bitmap.
max: The maximal values within the bitmap.
onlyFiniteVal: If true, consider only finite values.
See also
getMaxValue()
getMinValue()
getMinMaxLoc()

Definition at line 1329 of file vpImage.h.

References vpRGBf::B, vpException::fatalError, vpRGBf::G, vpMath::isFinite(), and vpRGBf::R.

◆ getMinValue()

template<class Type >
float getMinValue ( bool  onlyFiniteVal = true) const
inline

Return the minimum value within the bitmap.

Return the minimum value within the float bitmap.

Return the minimum value within the double bitmap.

Parameters
onlyFiniteVal: This parameter is ignored for non double or non float bitmap. If true, consider only finite values.
See also
getMaxValue()

Definition at line 1154 of file vpImage.h.

References vpException::fatalError.

◆ getNumberOfPixel()

template<class Type >
unsigned int vpImage< Type >::getNumberOfPixel ( ) const
inline

Get the image number of pixels which corresponds to the image width multiplied by the image height.

Returns
The image number of pixels or image size.
See also
getWidth(), getHeight()

Definition at line 206 of file vpImage.h.

Referenced by vpImageConvert::split().

◆ getRows()

template<class Type >
unsigned int vpImage< Type >::getRows ( ) const
inline

Get the number of rows in the image.

Returns
The image number of rows, or image height.
See also
getHeight()

Definition at line 215 of file vpImage.h.

Referenced by vpCircleHoughTransform::computeCenterCandidates(), vpImageConvert::convert(), vpMomentObject::fromImage(), vpMeTracker::inMeMaskCandidates(), and vpMbKltTracker::reinit().

◆ getSize()

template<class Type >
unsigned int vpImage< Type >::getSize ( ) const
inline

Get the image size.

Returns
The image size = width * height.
See also
getWidth(), getHeight()
Examples
testIoEXR.cpp, and testIoPFM.cpp.

Definition at line 224 of file vpImage.h.

Referenced by vp1394CMUGrabber::acquire(), vpFlyCaptureGrabber::acquire(), vp::autoThreshold(), vpHistogram::calculate(), vp::connectedComponents(), vpImageConvert::convert(), vpImageMorphology::dilatation(), vp::drawContours(), vpImageMorphology::erosion(), vp::fillHoles(), vp::findContours(), vp::floodFill(), vpImageTools::imageAdd(), vpImageTools::imageDifference(), vpImageTools::imageSubtract(), vpImageTools::inMask(), vpImageTools::integralImage(), vpImageTools::normalizedCorrelation(), vpImage< Type >::performLut(), vp::reconstruct(), vpImageConvert::split(), vpImageTools::templateMatching(), vp::unsharpMask(), and vpImageTools::warpImage().

◆ getStdev() [1/2]

template<class Type >
double vpImage< Type >::getStdev ( const double &  mean,
const vpImage< bool > *  p_mask = nullptr,
unsigned int *  nbValidPoints = nullptr 
) const

Return the standard deviation of the bitmap.

  • For a vpRGBa or a vpRGBf image, we compute the standard deviation as follow:

    \[ stdev = \sqrt{\frac{1}{size} \sum_{r = 0}^{height-1} \sum_{c = 0}^{width-1} (I[r][c].R + I[r][c].G + I[r][c].B - \mu)^2}\]

  • For a unary type image (unsigned char, float, double), we compute the standard deviation as follow:

    \[ stdev = \sqrt{\frac{1}{size} \sum_{r = 0}^{height-1} \sum_{c = 0}^{width-1} (I[r][c] - \mu)^2}\]

where $ \mu $ is the mean of the image as computed by vpImage::getMeanValue() and $ \mbox{size} $ is the number of pixels to consider in the mask.

Parameters
[in]meanThe mean of the image.
[in]p_maskOptional parameter. When different from nullptr, a boolean mask that indicates which pixels must be considered, if set to true.
[out]nbValidPointsOptional parameter. When different from nullptr contains the number of points that are valid according to the boolean mask or image size when p_mask is set to nullptr.
Returns
double The standard deviation taking into account only the points for which the mask is true.

Definition at line 1009 of file vpImage.h.

References vpImage< Type >::bitmap, vpException::fatalError, vpImage< Type >::getHeight(), and vpImage< Type >::getWidth().

◆ getStdev() [2/2]

template<class Type >
double vpImage< Type >::getStdev ( const vpImage< bool > *  p_mask = nullptr,
unsigned int *  nbValidPoints = nullptr 
) const

Return the standard deviation of the bitmap.

  • For a vpRGBa or a vpRGBf image, we compute the standard deviation as follow:

    \[ stdev = \sqrt{\frac{1}{size} \sum_{r = 0}^{height-1} \sum_{c = 0}^{width-1} (I[r][c].R + I[r][c].G + I[r][c].B - \mu)^2}\]

  • For a unary type image (unsigned char, float, double), we compute the standard deviation as follow:

    \[ stdev = \sqrt{\frac{1}{size} \sum_{r = 0}^{height-1} \sum_{c = 0}^{width-1} (I[r][c] - \mu)^2}\]

where $ \mu $ is the mean of the image as computed by vpImage::getMeanValue() and $ \mbox{size} $ is the number of pixels to consider in the mask.

Parameters
[in]p_maskA boolean mask that indicates which points must be considered, if set to true.
[out]nbValidPointsOptional parameter. When different from nullptr contains the number of points that are valid according to the boolean mask or image size when p_mask is set to nullptr.

Definition at line 985 of file vpImage.h.

◆ getSum()

template<class Type >
double vpImage< Type >::getSum ( const vpImage< bool > *  p_mask = nullptr,
unsigned int *  nbValidPoints = nullptr 
) const
inline

Compute the sum of image intensities.

  • For unary image types (unsigned char, float, double), compute the sum of image intensities.
  • For vpRGBa image type, compute the sum (R+G+B) of image intensities.
  • For vpRGBf image type, compute the sum (R+G+B) of image intensities.
Parameters
[in]p_maskOptional parameter. If not set to nullptr, pointer to a boolean mask that indicates the valid points by a true flag.
[out]nbValidPointsOptional parameter. When different from nullptr contains the number of points that are valid according to the boolean mask or image size when p_mask is set to nullptr.

Definition at line 2064 of file vpImage.h.

References vpImage< Type >::bitmap, vpException::fatalError, vpImage< Type >::getHeight(), and vpImage< Type >::getWidth().

Referenced by vpImageTools::normalize().

◆ getValue() [1/3]

template<class Type >
double getValue ( const vpImagePoint &  ip) const
inline

Retrieves pixel value from an image containing values of type Type with sub-pixel accuracy.

Gets the value of a sub-pixel with coordinates (i,j) with bilinear interpolation.

See also vpImageTools::interpolate() for a similar result, but with a choice of the interpolation method.

Parameters
ip: Sub-pixel coordinates of a point in the image.
Returns
Interpolated sub-pixel value from the four neighbours.
Exceptions
vpImageException::notInTheImage: If the image point ip is out of the image.

Definition at line 2024 of file vpImage.h.

References vpImagePoint::get_i(), vpImagePoint::get_j(), and vpImage< Type >::getValue().

◆ getValue() [2/3]

template<class Type >
double getValue ( double  i,
double  j 
) const
inline

Retrieves pixel value from an image containing values of type Type with sub-pixel accuracy.

Gets the value of a sub-pixel with coordinates (i,j) with bilinear interpolation.

See also vpImageTools::interpolate() for a similar result, but with a choice of the interpolation method.

Parameters
i: Sub-pixel coordinate along the rows.
j: Sub-pixel coordinate along the columns.
Returns
Interpolated sub-pixel value from the four neighbours.
Exceptions
vpImageException::notInTheImage: If (i,j) is out of the image.

Definition at line 1789 of file vpImage.h.

References vpImageException::notInitializedError, vpImageException::notInTheImage, and vpMath::round().

◆ getValue() [3/3]

template<class Type >
Type vpImage< Type >::getValue ( unsigned int  i,
unsigned int  j 
) const
inline

Retrieves pixel value from an image containing values of type Type.

Gets the value of a sub-pixel with coordinates (i,j).

Parameters
i: Pixel coordinate along the rows.
j: Pixel coordinate along the columns.
Returns
Pixel value.
Exceptions
vpImageException::notInTheImage: If (i,j) is out of the image.

Definition at line 1764 of file vpImage.h.

References vpImageException::notInTheImage.

Referenced by vpTemplateTrackerSSD::getCost(), vpTemplateTrackerZNCC::getCost(), vpTemplateTrackerMI::getCost(), vpTemplateTrackerMI::getMI(), vpTemplateTrackerMI::getMI256(), vpTemplateTrackerMI::getNormalizedCost(), vpTemplateTrackerSSD::getSSD(), vpImage< Type >::getValue(), vpTemplateTrackerZNCCForwardAdditional::initHessienDesired(), vpTemplateTrackerZNCCInverseCompositional::initHessienDesired(), vpTemplateTrackerMIESM::initHessienDesired(), vpTemplateTrackerMIForwardAdditional::initHessienDesired(), vpTemplateTrackerMIForwardCompositional::initHessienDesired(), vpTemplateTrackerMIInverseCompositional::initHessienDesired(), vpMeTracker::inRoiMask(), vpTemplateTrackerSSDESM::trackNoPyr(), vpTemplateTrackerSSDForwardAdditional::trackNoPyr(), vpTemplateTrackerSSDForwardCompositional::trackNoPyr(), vpTemplateTrackerSSDInverseCompositional::trackNoPyr(), vpTemplateTrackerZNCCForwardAdditional::trackNoPyr(), vpTemplateTrackerZNCCInverseCompositional::trackNoPyr(), vpTemplateTrackerMIESM::trackNoPyr(), vpTemplateTrackerMIForwardAdditional::trackNoPyr(), vpTemplateTrackerMIForwardCompositional::trackNoPyr(), and vpTemplateTrackerMIInverseCompositional::trackNoPyr().

◆ getWidth()

template<class Type >
unsigned int vpImage< Type >::getWidth ( ) const
inline

Get the image width.

Returns
The image width.
See also
getHeight()
Examples
saveRealSenseData.cpp, testColorConversion.cpp, testConnectedComponents.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testIoEXR.cpp, testIoPFM.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, and tutorial-image-colormap.cpp.

Definition at line 245 of file vpImage.h.

Referenced by vpDiskGrabber::acquire(), vp1394CMUGrabber::acquire(), vpV4l2Grabber::acquire(), vp1394TwoGrabber::acquire(), vpImageTools::binarise(), vpHistogram::calculate(), vpImageTools::changeLUT(), vp::clahe(), vpMbtDistanceLine::closeToImageBorder(), vpImageTools::columnMean(), vpImageFilter::computeCannyThreshold(), vpCircleHoughTransform::computeCircleProbability(), vpImageFilter::computePartialDerivatives(), vpImageCircle::computePixelsInMask(), vpPose::computePlanarObjectPoseFromRGBD(), vpMbTracker::computeProjectionErrorImpl(), vpMeLine::computeRhoTheta(), vpCircleHoughTransform::computeVotingMask(), vp::connectedComponents(), vpColormap::convert(), vpImageConvert::convert(), vpMeSite::convolution(), vpKeyPoint::createImageMatching(), vpImageTools::crop(), vp1394TwoGrabber::dequeue(), vpCannyEdgeDetection::detect(), vpDetectorDataMatrixCode::detect(), vpDetectorQRCode::detect(), vpImageMorphology::dilatation(), vpHistogram::display(), vpMbtDistanceCylinder::display(), vpMbtDistanceLine::display(), vpMbtFaceDepthDense::display(), vpMbtFaceDepthNormal::display(), vpMbDepthDenseTracker::display(), vpMbDepthNormalTracker::display(), vpMbEdgeKltTracker::display(), vpMbEdgeTracker::display(), vpMbKltTracker::display(), vpWireFrameSimulator::display_scene(), vpMbtFaceDepthNormal::displayFeature(), vpDisplayGTK::displayImageROI(), vpMeLine::displayLine(), vpDisplay::displayLine(), vpFeatureDisplay::displayLine(), vpKeyPoint::displayMatching(), vpCircleHoughTransform::edgeDetection(), vpHistogram::equalize(), vp::equalizeHistogram(), vpImageMorphology::erosion(), vp::fillHoles(), vpTemplateTrackerZone::fillTriangle(), vpImageFilter::filter(), vpCircleHoughTransform::filterEdgeMap(), vpImageFilter::filterX(), vpImageFilter::filterY(), vp::findContours(), vpImageTools::flip(), vp::floodFill(), vp::gammaCorrection(), vpSimulatorAfma6::getCameraParameters(), vpSimulatorViper850::getCameraParameters(), vpAfma6::getCameraParameters(), vpViper650::getCameraParameters(), vpViper850::getCameraParameters(), vpServolens::getCameraParameters(), vpTemplateTrackerSSD::getCost(), vpTemplateTrackerZNCC::getCost(), vpTemplateTrackerMI::getCost(), vpRobotWireFrameSimulator::getExternalCameraParameters(), vpWireFrameSimulator::getExternalCameraParameters(), vpSimulatorAfma6::getExternalImage(), vpSimulatorViper850::getExternalImage(), vpWireFrameSimulator::getExternalImage(), vpVideoReader::getFrame(), vpImageFilter::getGaussPyramidal(), vpImageFilter::getGaussXPyramidal(), vpImageFilter::getGaussYPyramidal(), vpImageFilter::getGradX(), vpImageFilter::getGradY(), vpRobotBebop2::getGrayscaleImage(), vpImageSimulator::getImage(), vpWireFrameSimulator::getInternalCameraParameters(), vpWireFrameSimulator::getInternalImage(), vpRobotWireFrameSimulator::getInternalView(), vpTemplateTrackerMI::getMI(), vpTemplateTrackerMI::getMI256(), vpPolygon3D::getNbCornerInsideImage(), vpTemplateTrackerMI::getNormalizedCost(), vpAROgre::getRenderingOutput(), vpRobotBebop2::getRGBaImage(), vpTemplateTrackerSSD::getSSD(), vpImage< Type >::getStdev(), vpImage< Type >::getSum(), vpImageTools::imageAdd(), vpImageTools::imageDifference(), vpImageTools::imageDifferenceAbsolute(), vpImageTools::imageSubtract(), vpMbDepthDenseTracker::init(), vpMbDepthNormalTracker::init(), vpMbEdgeTracker::init(), vpMbKltTracker::init(), vpAROgre::init(), vpDisplayGTK::init(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpDisplayWin32::init(), drawingHelpers::init(), vpMbTracker::initClick(), vpTemplateTrackerZone::initFromPoints(), vpTemplateTrackerZNCCForwardAdditional::initHessienDesired(), vpTemplateTrackerZNCCInverseCompositional::initHessienDesired(), vpTemplateTrackerMIESM::initHessienDesired(), vpTemplateTrackerMIForwardAdditional::initHessienDesired(), vpTemplateTrackerMIForwardCompositional::initHessienDesired(), vpTemplateTrackerMIInverseCompositional::initHessienDesired(), vpMbtDistanceLine::initMovingEdge(), vpMbEdgeTracker::initPyramid(), vpTemplateTracker::initTracking(), vpImageTools::inMask(), vpImage< Type >::insert(), vpKeyPoint::insertImageMatching(), vpImageTools::integralImage(), vpMeEllipse::leastSquare(), vpMeEllipse::leastSquareRobust(), vpMeNurbs::localReSample(), vpImageConvert::merge(), vpWireFrameSimulator::navigation(), vpImageTools::normalize(), vpImageTools::normalizedCorrelation(), vpDiskGrabber::open(), vpVideoWriter::open(), vpImage< Type >::operator==(), vpImage< Type >::performLut(), vpMeEllipse::plugHoles(), vpMbKltTracker::postTracking(), vpMbEdgeKltTracker::postTracking(), vpColorDepthConversion::projectColorToDepth(), vp::reconstruct(), vpMbKltTracker::reinit(), vpImageTools::remap(), vpImageTools::resize(), vpImageTools::resizeBilinear(), vp::retinex(), vpPolygon3D::roiInsideImage(), vpMeNurbs::sample(), vpMeEllipse::sample(), vpMeLine::sample(), vpDot2::searchDotsInArea(), vpMeLine::seekExtremities(), vpMeNurbs::seekExtremities(), vpMeNurbs::seekExtremitiesCanny(), vpImageFilter::sepFilter(), vpAR::setImage(), vpMbEdgeKltTracker::setPose(), vpMbKltTracker::setPose(), vpImageConvert::split(), vp::stretchContrast(), vp::stretchContrastHSV(), vpImage< Type >::sub(), vpImageTools::templateMatching(), vpMbEdgeTracker::track(), vpTemplateTrackerSSDESM::trackNoPyr(), vpTemplateTrackerSSDForwardAdditional::trackNoPyr(), vpTemplateTrackerSSDForwardCompositional::trackNoPyr(), vpTemplateTrackerSSDInverseCompositional::trackNoPyr(), vpTemplateTrackerZNCCForwardAdditional::trackNoPyr(), vpTemplateTrackerZNCCInverseCompositional::trackNoPyr(), vpTemplateTrackerMIESM::trackNoPyr(), vpTemplateTrackerMIForwardAdditional::trackNoPyr(), vpTemplateTrackerMIForwardCompositional::trackNoPyr(), vpTemplateTrackerMIInverseCompositional::trackNoPyr(), vpImageTools::undistort(), vp::unsharpMask(), vpMbtDistanceLine::updateMovingEdge(), vpMbEdgeTracker::visibleFace(), vpDisplayGDI::vpDisplayGDI(), vpDisplayGTK::vpDisplayGTK(), vpDisplayOpenCV::vpDisplayOpenCV(), vpDisplayX::vpDisplayX(), vpImage< Type >::vpImage(), vpImageTools::warpImage(), vpImageTools::warpLinear(), and vpKinect::warpRGBFrame().

◆ halfSizeImage()

template<class Type >
void vpImage< Type >::halfSizeImage ( vpImage< Type > &  res) const

Returns a new image that's half size of the current image. No filtering is used during the sub sampling.

Used for building pyramid of the image.

Warning
Operator = must be defined for Type.
Parameters
res[out] : Subsampled image that is half size of the current image.

The example below shows how to use this method:

vpImage<unsigned char> I; // original image
vpImageIo::read(I, "myImage.pgm");
vpImage<unsigned char> I2; // half size image
I.halfSizeImage(I2);
vpImageIo::write(I2, "myHalfSizeImage.pgm");
vpImage::halfSizeImage
void halfSizeImage(vpImage< Type > &res) const
Definition: vpImage.h:1610

This other example shows how to construct a pyramid of the image:

vpImage<unsigned char> I[4]; // pyramid with 4 levels
vpImageIo::read(I[1], "myImage.pgm"); // Original image at level 1
// compute the other levels
I5[1].doubleSizeImage(I5[0]); // double size image at level 0
I5[1].halfSizeImage(I5[2]); // half size image at level 2
I5[1].quarterSizeImage(I5[3]); // quarter size image at level 3
See also
subsample()
Examples
testKeyPoint-5.cpp.

Definition at line 1610 of file vpImage.h.

References vpImage< Type >::resize().

◆ init() [1/3]

template<class Type >
void init ( Type *const  array,
unsigned int  height,
unsigned int  width,
bool  copyData = false 
)

init from an image stored as a continuous array in memory

Definition at line 674 of file vpImage.h.

References vpException::memoryAllocationError.

◆ init() [2/3]

template<class Type >
void init ( unsigned int  height,
unsigned int  width 
)

Set the size of the image.

Examples
testDisplays.cpp, and testRealSense2_D435.cpp.

Definition at line 631 of file vpImage.h.

References vpException::memoryAllocationError.

Referenced by vpPlot::init(), and vpImage< Type >::vpImage().

◆ init() [3/3]

template<class Type >
void init ( unsigned int  height,
unsigned int  width,
Type  value 
)

Set the size of the image.

Definition at line 619 of file vpImage.h.

References vpImage< Type >::init().

◆ insert()

template<class Type >
void vpImage< Type >::insert ( const vpImage< Type > &  src,
const vpImagePoint &  topLeft 
)

Insert an image into another one.

It is possible to insert the image $ src $ into the calling vpImage. You can set the point in the destination image where the top left corner of the $ src $ image will be located.

Parameters
src: Image to insert
topLeft: Upper/left coordinates in the image where the image src is inserted in the destination image.
Examples
testKeyPoint-3.cpp, testKeyPoint-4.cpp, and testKeyPoint.cpp.

Definition at line 1533 of file vpImage.h.

References vpImage< Type >::bitmap, vpImagePoint::get_i(), vpImagePoint::get_j(), vpImage< Type >::getHeight(), and vpImage< Type >::getWidth().

Referenced by vpPose::computePlanarObjectPoseFromRGBD(), and vpKeyPoint::insertImageMatching().

◆ operator!=()

template<class Type >
bool vpImage< Type >::operator!= ( const vpImage< Type > &  I) const

Compare two images.

Returns
true if the images are different, false if they are the same.

Definition at line 1488 of file vpImage.h.

◆ operator()() [1/4]

template<class Type >
Type vpImage< Type >::operator() ( const vpImagePoint &  ip) const
inline

Get the value of an image point.

Parameters
ip: An image point with sub-pixel coordinates. Sub-pixel coordinates are roughly transformed to insigned int coordinates by cast.
Returns
Value of the image point ip.
See also
getValue(const vpImagePoint &)

Definition at line 293 of file vpImage.h.

References vpImage< Type >::bitmap, vpImagePoint::get_i(), and vpImagePoint::get_j().

◆ operator()() [2/4]

template<class Type >
void vpImage< Type >::operator() ( const vpImagePoint &  ip,
const Type &  v 
)
inline

Set the value of an image point.

Parameters
ip: An image point with sub-pixel coordinates. Sub-pixel coordinates are roughly transformed to insigned int coordinates by cast.
v: Value to set for the image point.

Definition at line 309 of file vpImage.h.

References vpImage< Type >::bitmap, vpImagePoint::get_i(), and vpImagePoint::get_j().

◆ operator()() [3/4]

template<class Type >
Type vpImage< Type >::operator() ( unsigned int  i,
unsigned int  j 
) const
inline

Get the value of an image point with coordinates (i, j), with i the row position and j the column position.

Returns
Value of the image point (i, j).

Definition at line 275 of file vpImage.h.

References vpImage< Type >::bitmap.

◆ operator()() [4/4]

template<class Type >
void vpImage< Type >::operator() ( unsigned int  i,
unsigned int  j,
const Type &  v 
)
inline

Set the value v of an image point with coordinates (i, j), with i the row position and j the column position.

Definition at line 281 of file vpImage.h.

References vpImage< Type >::bitmap.

◆ operator-()

template<class Type >
vpImage< Type > vpImage< Type >::operator- ( const vpImage< Type > &  B) const

Operation A - B (A is unchanged).

#include <visp3/core/vpImage.h>
int main()
{
vpImage<unsigned char> A(288, 384);
vpImage<unsigned char> B(288, 384);
vpImage<unsigned char> C;
A = 128;
B = 120;
// operator-() : C = A - B
C = A - B;
return 0;
}
See also
sub(const vpImage<Type> &, const vpImage<Type> &, vpImage<Type> &) to avoid matrix allocation for each use.

Definition at line 1515 of file vpImage.h.

◆ operator=() [1/2]

template<class Type >
vpImage< Type > & vpImage< Type >::operator= ( const Type &  v)

= operator : Set all the element of the bitmap to a given value v. $ A = v <=> A[i][j] = v $

Warning
= must be defined for $ <$ Type $ > $

Definition at line 1452 of file vpImage.h.

◆ operator=() [2/2]

template<class Type >
vpImage< Type > & vpImage< Type >::operator= ( vpImage< Type >  other)

Copy operator.

Definition at line 1437 of file vpImage.h.

References vpImage< Type >::display.

◆ operator==()

template<class Type >
bool vpImage< Type >::operator== ( const vpImage< Type > &  I) const

Compare two images.

Returns
true if the images are the same, false otherwise.

Definition at line 1465 of file vpImage.h.

References vpImage< Type >::bitmap, vpImage< Type >::getHeight(), and vpImage< Type >::getWidth().

◆ operator[]() [1/4]

template<class Type >
Type* vpImage< Type >::operator[] ( int  i)
inline

Definition at line 263 of file vpImage.h.

◆ operator[]() [2/4]

template<class Type >
const Type* vpImage< Type >::operator[] ( int  i) const
inline

Definition at line 267 of file vpImage.h.

◆ operator[]() [3/4]

template<class Type >
Type* vpImage< Type >::operator[] ( unsigned int  i)
inline

operator[] allows operation like I[i] = x.

Definition at line 262 of file vpImage.h.

◆ operator[]() [4/4]

template<class Type >
const Type* vpImage< Type >::operator[] ( unsigned int  i) const
inline

operator[] allows operation like x = I[i]

Definition at line 266 of file vpImage.h.

◆ performLut()

template<class Type >
void vpImage< Type >::performLut ( const Type(&)  lut[256],
unsigned int  nbThreads = 1 
)
Warning
This generic method is not implemented. You should rather use the instantiated methods for unsigned char and vpRGBa images.
See also
vpImage<unsigned char>::performLut(const unsigned char (&lut)[256], unsigned int nbThreads)
vpImage<vpRGBa>::performLut(const vpRGBa (&lut)[256], unsigned int nbThreads)

Definition at line 2277 of file vpImage.h.

Referenced by vp::adjust(), vpImageTools::binarise(), vpHistogram::equalize(), vp::gammaCorrection(), and vp::stretchContrast().

◆ quarterSizeImage()

template<class Type >
void vpImage< Type >::quarterSizeImage ( vpImage< Type > &  res) const

Returns a new image that's a quarter size of the current image. No filtering is used during the sub sampling. Used for building a quarter of the image.

Warning
Operator = must be defined for Type.
Parameters
res[out] : Subsampled image that is quarter size of the current image.

The example below shows how to use this method:

vpImage<unsigned char> I; // original image
vpImageIo::read(I, "myImage.pgm");
vpImage<unsigned char> I4; // quarter size image
I.halfSizeImage(I4);
vpImageIo::write(I4, "myQuarterSizeImage.pgm");

See halfSizeImage(vpImage<Type> &) for an example of pyramid construction.

See also
subsample()
Examples
testKeyPoint-6.cpp.

Definition at line 1674 of file vpImage.h.

References vpImage< Type >::resize().

◆ resize() [1/2]

template<class Type >
void vpImage< Type >::resize ( unsigned int  h,
unsigned int  w 
)

resize the image : Image initialization

Allocate memory for an [height x width] image.

Warning
The image is not initialized.
Parameters
w: Image width.
h: Image height.

Element of the bitmap are not initialized

If the image has been already initialized, memory allocation is done only if the new image size is different, else we re-use the same memory space.

Exceptions
vpException::memoryAllocationError
See also
init(unsigned int, unsigned int)
Examples
mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, readRealSenseData.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, and tutorial-mb-generic-tracker-rgbd.cpp.

Definition at line 783 of file vpImage.h.

References vpImage< Type >::init().

Referenced by vpPylonGrabberGigE::acquire(), vpPylonGrabberUsb::acquire(), vpFlyCaptureGrabber::acquire(), vpV4l2Grabber::acquire(), vpRealSense2::acquire(), vp1394TwoGrabber::acquire(), vp::clahe(), vpImageFilter::computePartialDerivatives(), vp::connectedComponents(), vpColormap::convert(), vpImageConvert::convert(), vp1394TwoGrabber::dequeue(), vpCannyEdgeDetection::detect(), vpImage< Type >::doubleSizeImage(), vpImageTools::extract(), vpImageFilter::filter(), vpImageTools::flip(), vpRealSense2::getColorFrame(), vpImageFilter::getGaussXPyramidal(), vpImageFilter::getGaussYPyramidal(), vpRobotBebop2::getGrayscaleImage(), vpRealSense2::getGreyFrame(), vpSimulator::getInternalImage(), vpAROgre::getRenderingOutput(), vpRobotBebop2::getRGBaImage(), vpImage< Type >::halfSizeImage(), vpImageTools::imageAdd(), vpImageTools::imageDifference(), vpImageTools::imageDifferenceAbsolute(), vpImageTools::imageSubtract(), vpProjectionDisplay::init(), vpImageTools::inMask(), vpImageTools::integralImage(), vpImageConvert::merge(), vp1394CMUGrabber::open(), vpV4l2Grabber::open(), vpImage< Type >::quarterSizeImage(), vpImageTools::remap(), vpImageTools::resize(), vpImageFilter::sepFilter(), vpImageConvert::split(), vpImage< Type >::sub(), vpImage< Type >::subsample(), vpImageTools::templateMatching(), vpImageTools::undistort(), vpImage< Type >::vpImage(), vpKinect::vpKinect(), vpRobotWireFrameSimulator::vpRobotWireFrameSimulator(), vpImageTools::warpImage(), and vpKinect::warpRGBFrame().

◆ resize() [2/2]

template<class Type >
void vpImage< Type >::resize ( unsigned int  h,
unsigned int  w,
const Type &  val 
)

resize the image : Image initialization

Allocate memory for an [height x width] image and initialize the image.

Parameters
w: Image width.
h: Image height.
val: Pixels value.

Element of the bitmap are not initialized

If the image has been already initialized, memory allocation is done only if the new image size is different, else we re-use the same memory space.

Exceptions
vpException::memoryAllocationError
See also
init(unsigned int, unsigned int)

Definition at line 804 of file vpImage.h.

References vpImage< Type >::init().

◆ sub() [1/2]

template<class Type >
void vpImage< Type >::sub ( const vpImage< Type > &  A,
const vpImage< Type > &  B,
vpImage< Type > &  C 
) const

Operation C = A - B.

The result is placed in the third parameter C and not returned. A new image won't be allocated for every use of the function (Speed gain if used many times with the same result matrix size).

Exceptions
vpException::memoryAllocationErrorIf the images size differ.
See also
operator-()

Definition at line 2248 of file vpImage.h.

References vpImage< Type >::bitmap, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpException::memoryAllocationError, and vpImage< Type >::resize().

◆ sub() [2/2]

template<class Type >
void vpImage< Type >::sub ( const vpImage< Type > &  B,
vpImage< Type > &  C 
) const

Operation C = *this - B.

#include <visp3/core/vpImage.h>
int main()
{
vpImage<unsigned char> A(288, 384);
vpImage<unsigned char> B(288, 384);
vpImage<unsigned char> C;
A = 128;
B = 120;
A.sub(B, C); // C = A - B
return 0;
}
vpImage::sub
void sub(const vpImage< Type > &B, vpImage< Type > &C) const
Definition: vpImage.h:2216

The result is placed in the third parameter C and not returned. A new image won't be allocated for every use of the function (Speed gain if used many times with the same result matrix size).

Exceptions
vpException::memoryAllocationErrorIf the images size differ.
See also
operator-()

Definition at line 2216 of file vpImage.h.

References vpImage< Type >::bitmap, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpException::memoryAllocationError, and vpImage< Type >::resize().

◆ subsample()

template<class Type >
void vpImage< Type >::subsample ( unsigned int  v_scale,
unsigned int  h_scale,
vpImage< Type > &  sampled 
) const

Computes a subsampled image. No filtering is used during the sub sampling.

Parameters
v_scale[in] : Vertical subsampling factor.
h_scale[in] : Horizontal subsampling factor.
sampled[out] : Subsampled image.

The example below shows how to use this method:

vpImage<unsigned char> I; // original image
vpImageIo::read(I, "myImage.pgm");
vpImage<unsigned char> I2; // half size image
I.subsample(2, 2, I2);
vpImageIo::write(I2, "myHalfSizeImage.pgm");
vpImage::subsample
void subsample(unsigned int v_scale, unsigned int h_scale, vpImage< Type > &sampled) const
Definition: vpImage.h:1638

Definition at line 1638 of file vpImage.h.

References vpImage< Type >::resize().

Friends And Related Function Documentation

◆ getMinMaxValue() [1/2]

void getMinMaxValue ( double &  min,
double &  max,
bool  onlyFiniteVal 
) const
related

Look for the minimum and the maximum value within the double bitmap.

Parameters
min: The minimal value within the bitmap.
max: The maximal value within the bitmap.
onlyFiniteVal: If true, consider only finite values.
See also
getMaxValue()
getMinValue()
getMinMaxLoc()

Definition at line 1256 of file vpImage.h.

References vpImage< Type >::bitmap, vpException::fatalError, and vpMath::isFinite().

◆ getMinMaxValue() [2/2]

void getMinMaxValue ( float &  min,
float &  max,
bool  onlyFiniteVal 
) const
related

Look for the minimum and the maximum value within the float bitmap.

Parameters
min: The minimal value within the bitmap.
max: The maximal value within the bitmap.
onlyFiniteVal: If true, consider only finite values.
See also
getMaxValue()
getMinValue()
getMinMaxLoc()

Definition at line 1293 of file vpImage.h.

References vpImage< Type >::bitmap, vpException::fatalError, and vpMath::isFinite().

◆ getValue() [1/2]

vpRGBa getValue ( const vpImagePoint &  ip) const
related

Definition at line 2032 of file vpImage.h.

References vpImagePoint::get_i(), vpImagePoint::get_j(), and vpImage< Type >::getValue().

◆ getValue() [2/2]

vpRGBf getValue ( double  i,
double  j 
) const
related
Examples
testImageGetValue.cpp.

Definition at line 1821 of file vpImage.h.

References vpImageException::notInitializedError, and vpImageException::notInTheImage.

Referenced by vpImage< Type >::getValue().

◆ init() [1/3]

template<class Type >
void init ( Type *const  array,
unsigned int  h,
unsigned int  w,
bool  copyData 
)
related

Definition at line 674 of file vpImage.h.

◆ init() [2/3]

template<class Type >
void init ( unsigned int  h,
unsigned int  w 
)
related

Definition at line 631 of file vpImage.h.

◆ init() [3/3]

template<class Type >
void init ( unsigned int  h,
unsigned int  w,
Type  value 
)
related
Examples
servoAfma6FourPoints2DCamVelocityLs_cur.cpp, servoAfma6MegaposePBVS.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper850FourPoints2DArtVelocityLs_cur.cpp, servoViper850FourPoints2DCamVelocityLs_cur.cpp, servoViper850FourPointsKinect.cpp, tutorial-pose-from-points-image.cpp, and tutorial-pose-from-qrcode-image.cpp.

Definition at line 619 of file vpImage.h.

Referenced by vpImage< Type >::init(), vpImage< Type >::resize(), and vpKeyboard::vpKeyboard().

◆ operator<< [1/5]

template<class Type >
std::ostream& operator<< ( std::ostream &  s,
const vpImage< char > &  I 
)
friend

Definition at line 407 of file vpImage.h.

◆ operator<< [2/5]

template<class Type >
std::ostream& operator<< ( std::ostream &  s,
const vpImage< double > &  I 
)
friend

Definition at line 460 of file vpImage.h.

◆ operator<< [3/5]

template<class Type >
std::ostream& operator<< ( std::ostream &  s,
const vpImage< float > &  I 
)
friend

Definition at line 433 of file vpImage.h.

◆ operator<< [4/5]

template<class Type >
std::ostream& operator<< ( std::ostream &  s,
const vpImage< Type > &  I 
)
friend

Definition at line 358 of file vpImage.h.

◆ operator<< [5/5]

template<class Type >
std::ostream& operator<< ( std::ostream &  s,
const vpImage< unsigned char > &  I 
)
friend

Definition at line 381 of file vpImage.h.

◆ performLut() [1/2]

void performLut ( const unsigned char(&)  lut[256],
unsigned int  nbThreads 
)
related

Modify the intensities of a grayscale image using the look-up table passed in parameter.

Parameters
lut: Look-up table (unsigned char array of size=256) which maps each intensity to his new value.
nbThreads: Number of threads to use for the computation.

Definition at line 2292 of file vpImage.h.

References vpImage< Type >::bitmap, vpImage< Type >::getHeight(), vpImage< Type >::getSize(), and vpImage< Type >::getWidth().

◆ performLut() [2/2]

void performLut ( const vpRGBa(&)  lut[256],
unsigned int  nbThreads 
)
related

Modify the intensities of a color image using the look-up table passed in parameter.

Parameters
lut: Look-up table (vpRGBa array of size=256) which maps each intensity to his new value.
nbThreads: Number of threads to use for the computation.

Definition at line 2371 of file vpImage.h.

References vpImage< Type >::bitmap, vpImage< Type >::getHeight(), vpImage< Type >::getSize(), and vpImage< Type >::getWidth().

◆ swap

template<class Type >
void swap ( vpImage< Type > &  first,
vpImage< Type > &  second 
)
friend

Definition at line 2448 of file vpImage.h.

◆ vpImage() [1/5]

template<class Type >
vpImage ( )
related

Definition at line 760 of file vpImage.h.

◆ vpImage() [2/5]

template<class Type >
vpImage ( const vpImage< Type > &  I)
related

Definition at line 839 of file vpImage.h.

◆ vpImage() [3/5]

template<class Type >
vpImage ( Type *const  array,
unsigned int  h,
unsigned int  w,
bool  copyData 
)
related

Definition at line 750 of file vpImage.h.

◆ vpImage() [4/5]

template<class Type >
vpImage ( unsigned int  h,
unsigned int  w 
)
related

Definition at line 730 of file vpImage.h.

◆ vpImage() [5/5]

template<class Type >
vpImage ( unsigned int  h,
unsigned int  w,
Type  value 
)
related

Definition at line 740 of file vpImage.h.

◆ vpImageConvert

template<class Type >
friend class vpImageConvert
friend

Definition at line 136 of file vpImage.h.

Member Data Documentation

◆ bitmap

template<class Type >
Type* vpImage< Type >::bitmap

points toward the bitmap

Examples
grabRealSense2.cpp, testColorConversion.cpp, testRealSense2_D435.cpp, testRealSense2_D435_pcl.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-grabber-rgbd-D435-structurecore.cpp, tutorial-hsv-segmentation-pcl-viewer.cpp, tutorial-hsv-segmentation-pcl.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, and tutorial-mb-generic-tracker-rgbd-realsense.cpp.

Definition at line 139 of file vpImage.h.

Referenced by vpOccipitalStructure::acquire(), vp1394CMUGrabber::acquire(), vpPylonGrabberGigE::acquire(), vpPylonGrabberUsb::acquire(), vpFlyCaptureGrabber::acquire(), vpV4l2Grabber::acquire(), vp1394TwoGrabber::acquire(), vpImageTools::binarise(), vpHistogram::calculate(), vp::clahe(), vpImageConvert::convert(), vp1394TwoGrabber::dequeue(), vpDetectorDataMatrixCode::detect(), vpDetectorQRCode::detect(), vp::equalizeHistogram(), vp::findContours(), vpImageTools::flip(), vp::gammaCorrection(), vpRealSense2::getColorFrame(), vpRobotBebop2::getGrayscaleImage(), vpRealSense2::getGreyFrame(), vpImageSimulator::getImage(), vpSimulator::getInternalImage(), vpImage< Type >::getMinMaxValue(), vpAROgre::getRenderingOutput(), vpRobotBebop2::getRGBaImage(), vpImage< Type >::getStdev(), vpImage< Type >::getSum(), vpImageTools::imageAdd(), vpImageTools::imageDifference(), vpImageTools::imageDifferenceAbsolute(), vpImageTools::imageSubtract(), vpImageTools::inMask(), vpImage< Type >::insert(), vpImageConvert::merge(), vpImageTools::normalizedCorrelation(), vpImage< Type >::operator()(), vpImage< Type >::operator==(), vpImage< Type >::performLut(), vpColorDepthConversion::projectColorToDepth(), vpImageTools::remap(), vpImageConvert::split(), vp::stretchContrastHSV(), vpImage< Type >::sub(), vpImageTools::templateMatching(), vpImageTools::undistort(), vp::unsharpMask(), vpAROgre::updateBackgroundTexture(), and vpImage< Type >::vpImage().

◆ display

template<class Type >
vpDisplay* vpImage< Type >::display

Definition at line 140 of file vpImage.h.

Referenced by vpTemplateTracker::display(), vpWireFrameSimulator::getExternalImage(), vpDisplay::getImage(), vpWireFrameSimulator::getInternalImage(), vpDisplayGTK::init(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpDisplayWin32::init(), vpMbTracker::initClick(), vpImage< Type >::operator=(), and vpImageQueue< Type >::record().