< LynkeosImageFileReader > Protocol Reference
[Graphic files access]

Protocol for image file readers. More...

#import <LynkeosFileReader.h>

Inheritance diagram for < LynkeosImageFileReader >:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

(NSImage *) - getNSImage
 Returns an NSImage for displaying.
(void) - getImageSample:withPrecision:withPlanes:atX:Y:W:H:lineWidth:
 Retrieves image data for processing.
(id< LynkeosImageBuffer >) - getCustomImageSampleAtX:Y:W:H:
 Retrieves image data in a custom format for calibration (see hasCustomImageBuffer).


Detailed Description

Protocol for image file readers.

It allows the application to access image data.


Member Function Documentation

- (NSImage*) getNSImage  

Returns an NSImage for displaying.

Returns:
A NSImage built from the image data.

- (void) getImageSample: (void *const *const )  sample
withPrecision: (floating_precision_t precision
withPlanes: (u_short)  nPlanes
atX: (u_short)  x
Y: (u_short)  y
W: (u_short)  w
H: (u_short)  h
lineWidth: (u_short)  lineW 

Retrieves image data for processing.

The (x,y) coordinate system has its origin in the top left corner of the image. The samples shall be ordered left to right, then top to bottom.
Most file formats share this orientation and pixels ordering.

Implementors can use the macro SET_SAMPLE to fill the output buffer.

Parameters:
sample An array of buffers to fill with image data
precision Wether the sample buffer shall be filled with floats or doubles
nPlanes The number of buffers in the array. It can be 1 (the data shall be converted to monochrome), or 3 (RGB data).
x X origin of the sample
y Y origin of the sample
w Width of sample
h Height of sample
lineW The number of samples in each line, as it can be larger than w there may be spare at the end of the lines. This only applies to sample

- (id <LynkeosImageBuffer>) getCustomImageSampleAtX: (u_short)  x
Y: (u_short)  y
W: (u_short)  w
H: (u_short)  h 

Retrieves image data in a custom format for calibration (see hasCustomImageBuffer).

Parameters:
x X origin of the sample
y Y origin of the sample
w Width of sample
h Height of sample
Returns:
The image data in a custom format class conforming to LynkeosImageBuffer


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