LBitmap::GetStatisticsInfo

#include "ltwrappr.h"

virtual L_INT LBitmap::GetStatisticsInfo (pStatisticsInfo, uChannel, uStart, uEnd, uFlags = 0)

pSTATISTICSINFO pStatisticsInfo;	/* address of the STATISTICSINFO structure variable to be updated */
L_UINT uChannel;	/* the color planes to be evaluated */
L_UINT uStart;	/* the starting color value */
L_UINT uEnd;	/* the ending color value */
L_UINT32 uFlags;	/* flags */

Returns statistical information about the bitmap.

Parameter	Description
pBitmap	Pointer to the bitmap handle that references the bitmap on which to apply the effect.
pStatisticsInfo	Address of the STATISTICSINFO structure variable to be updated with the image information.
uChannel	Flag that indicates the channel for which to get the information. This value is ignored if the bitmap is 12 or 16-bit grayscale. Possible values are:
	Value	Meaning
	CHANNEL_MASTER	[0] All channels.
	CHANNEL_RED	[1] Red channel only.
	CHANNEL_GREEN	[2] Green channel only.
	CHANNEL_BLUE	[3] Blue channel only.
uStart	Indicates the beginning color value of the range for the evaluation.
uEnd	Indicates the ending color value of the range for the evaluation.
uFlags	Reserved for future use. Must be 0.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function calculates statistical information about the bitmap.

The uStart and uEnd parameters designate the range of colors that will be taken in consideration for producing the results. Only the values between uStart and uEnd are used for the calculation of the results. The range of each one depends on the bits per pixel of the bitmap: in the case of 8 bits per component (RGB), the range is between 0 and 255; for 16 bits, the range is 0 through 65535; and for 12 bits, the range is 0 through 4095.

Support for 12 and 16-bit grayscale and 48 and 64-bit color images is available only in the Document/Medical toolkits.

This function does not support signed data images. It returns the error code ERROR_SIGNED_DATA_NOT_SUPPORTED if a signed data image is passed to this function.

This function does not support 32-bit grayscale images. It returns the error code ERROR_GRAY32_UNSUPPORTED if a 32-bit grayscale image is passed to this function.

Required DLLs and Libraries

LTIMGEFX

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:	LBitmap::ConvertToColoredGray, LBitmapBase::GrayScale, LBitmap::GrayScaleExt, LBitmapBase::IsGrayScale, LBitmap::AddShadow, LBitmap::AllocFTArray, LBitmap::ChangeHueSatInt, LBitmap::ColorReplace, LBitmap::ColorThreshold, LBitmap::DFT, LBitmap::DirectionEdgeStatistical, LBitmap::FFT, LBitmap::FreeFTArray, LBitmap::FrqFilter, LBitmap::FrqFilterMask, LBitmap::FTDisplay, LBitmap::GetFeretsDiameter, LBitmap::GetObjectInfo, LBitmap::GetRgnContourPoints, LBitmap::GetRgnPerimeterLength, LBitmap::GetStatisticsInfo2 LBitmap::MathFunction, LBitmap::RevEffect, LBitmap::Segment, LBitmap::SubtractBackground, LBitmap::UserFilter, LBitmap::DirectionEdgeStatistical2
Topics:	Raster Image Functions: Analysis: Image Analysis
	Color Halftones and Halftone Images
	Raster Image Functions: Working with Color Halftones, Halftones, and Grayscale Images

Example

L_INT LBitmap__GetStatisticsInfoExample(LBitmap *pLeadBitmap) 
{
   L_INT nRet;
   STATISTICSINFO  StatisticsInfo; 
 
   /*Get statistical image information */
   nRet =pLeadBitmap->GetStatisticsInfo (&StatisticsInfo,CHANNEL_MASTER, 0, 255);
   if(nRet !=SUCCESS)
      return nRet;
   return SUCCESS;
}