< LynkeosImageBuffer > Protocol Reference
[Processing classes]

Generic image management. More...

#import <LynkeosImageBuffer.h>

Inheritance diagram for < LynkeosImageBuffer >:

Inheritance graph
[legend]
Collaboration diagram for < LynkeosImageBuffer >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

(u_short) - width
 Get the image pixels width.
(u_short) - height
 Get the image pixels height.
(u_short) - numberOfPlanes
 Get the number of color planes.
(NSBitmapImageRep *) - getNSImageWithBlack:white:gamma:
 Retrieve a Cocoa 24 bits RGB bitmap representation.
(void) - add:
 Add another image buffer.
(void) - calibrateWithDarkFrame:flatField:atX:Y:
 Calibrate the image with the calibration images.
(void) - normalizeWithFactor:mono:
 Multiplies all values with a scalar.
(void) - convertToPlanar:withPrecision:withPlanes:lineWidth:
 Convert the image buffer data to a floating precision planar representation.


Detailed Description

Generic image management.

Member Function Documentation

- (u_short) width  

Get the image pixels width.

Returns:
The image width

- (u_short) height  

Get the image pixels height.

Returns:
The image height

- (u_short) numberOfPlanes  

Get the number of color planes.

Returns:
The number of color planes

- (NSBitmapImageRep*) getNSImageWithBlack: (double)  black
white: (double)  white
gamma: (double)  gamma 

Retrieve a Cocoa 24 bits RGB bitmap representation.

Parameters:
black Black level for conversion
white White level for conversion
gamma Gamma correction exponent (ie: 1 = no correction)
Returns:
The 8 bits RGB bitmap representation of the buffer data

- (void) add: (id< LynkeosImageBuffer >)  image  

Add another image buffer.

The image to add shall be an instance of the same class as self and have the same size (method implementation can rely on this).

Parameters:
image The image to add

- (void) calibrateWithDarkFrame: (id< LynkeosImageBuffer >)  darkFrame
flatField: (id< LynkeosImageBuffer >)  flatField
atX: (u_short)  ox
Y: (u_short)  oy 

Calibrate the image with the calibration images.

darkFrame and flatField, when present, are instances of the same class as self. They are "full sensor" images.

The darkFrame, if any, shall be substracted from the image and the result shall be divided by the flatField, if any.

The coordinates are specified using the same orientation as in LynkeosFileReader

Parameters:
darkFrame The dark frame image, nil if not present
flatField The flat field image, nil if not present
ox The X origin of our image in the full sensor frame.
oy The Y origin of our image in the full sensor frame.

- (void) normalizeWithFactor: (double)  factor
mono: (BOOL)  mono 

Multiplies all values with a scalar.

Parameters:
factor The value by which each pixel is multiplied. If 0, the factor is taken as to set the maximum value of the resulting image to 1.0
mono If true and factor is zero, the color planes are leveled to obtain a non color biased image

- (void) convertToPlanar: (void *const *const )  planes
withPrecision: (floating_precision_t precision
withPlanes: (u_short)  nPlanes
lineWidth: (u_short)  lineW 

Convert the image buffer data to a floating precision planar representation.

The pixels ordering is the same as in LynkeosFileReader.

Parameters:
planes The color planes to fill with the image data. There are as many planes as there are in this instance and their size is the same as this instance's image.
nPlanes Number of planes in the output buffer.
precision The floating precision of pixels in the output buffer.
lineW The line width of the output buffer (may be larger than this instance's image width).


The documentation for this protocol was generated from the following file:
Generated on Sat Mar 22 17:44:50 2008 for Lynkeos by  doxygen 1.5.4