< LynkeosProcessableItem > Protocol Reference
[Processing classes]

This protocol is implemented by the classes that can be the target of a processing. More...

#import <LynkeosProcessing.h>

Inheritance diagram for < LynkeosProcessableItem >:

[legend]

Collaboration diagram for < LynkeosProcessableItem >:

[legend]

List of all members.

Public Member Functions
(u_short)	- numberOfPlanes
	Get the number of color planes.
(MyIntegerSize)	- imageSize
	Read the image size.
(NSImage *)	- getNSImage
	Returns an NSImage for displaying.
(void)	- getImageSample:inRect:
	Read a calibrated sample from an image.
(void)	- getFourierTransform:forRect:prepareInverse:
	Access to the Fourier transform of the image.
(void)	- setFourierTransform:
	Set the fourier transform after processing.
(void)	- setImage:
	Save the resulting image.
(void)	- setOriginalImage:
	Save the resulting image as the original image.
(void)	- revertToOriginal
	Delete any processing result and go back to using the "original" image.
(BOOL)	- isOriginal
	Wether the image is the original or has been processed.
(void)	- setBlackLevel:whiteLevel:gamma:
	Sets the levels for image visualization.
(BOOL)	- getBlackLevel:whiteLevel:gamma:
(BOOL)	- getMinLevel:maxLevel:

---

Detailed Description

This protocol is implemented by the classes that can be the target of a processing.

---

Member Function Documentation

- (u_short) numberOfPlanes

Get the number of color planes.

Returns:

The number of color planes

- (MyIntegerSize) imageSize

Read the image size.

Returns:

Image size

- (NSImage*) getNSImage

Returns an NSImage for displaying.

Returns:

A NSImage built from the processed image data.

- (void) getImageSample:		(MyImageBuffer **)	buffer
inRect:		(MyIntegerRect)	rect

Read a calibrated sample from an image.

Parameters:

	buffer	The image or Fourier buffer to fill, if nil it is created
	rect	The rectangle in which to extract the sample (it shall be entirely inside the image) *buffer can be nil, in which case it will be allocated by the called method. The precision of the buffer is implied by the "processing" method ; because Lynkeos provides only buffers of its compiled precision.

The image which sample is returned, is the latest processing result or the "original" image if no processing result was saved ; in which case, calibration frames, if any, are applied.

- (void) getFourierTransform:		(MyFourierBuffer **)	buffer
forRect:		(MyIntegerRect)	rect
prepareInverse:		(BOOL)	prepareInverse

Access to the Fourier transform of the image.

Parameters:

	buffer	The buffer in which to put the transform
	rect	The rectangle from which the data to transform is extracted
	prepareInverse	Wether to prepare the buffer for an inverse transform

Returns:

The Fourier transform of the processed image

- (void) setFourierTransform:

(MyFourierBuffer *)

buffer

Set the fourier transform after processing.

Parameters:

buffer

The processed fourier transform The processable item makes the inverse transform when appropriate

- (void) setImage:

(MyImageBuffer *)

buffer

Save the resulting image.

Parameters:

buffer

The buffer containing the image processing result.

- (void) setOriginalImage:

(MyImageBuffer *)

buffer

Save the resulting image as the original image.

Parameters:

buffer

The buffer containing the image processing result.

- (void) revertToOriginal

Delete any processing result and go back to using the "original" image.

Returns:

None

- (BOOL) isOriginal

Wether the image is the original or has been processed.

Returns:

YES if the image has not been processed

- (void) setBlackLevel:		(double)	black
whiteLevel:		(double)	white
gamma:		(double)	gamma

Sets the levels for image visualization.

Parameters:

	black	The level below which only black is diplayed
	white	The level above which white is displayed
	gamma	The gamma correction

---

The documentation for this protocol was generated from the following file:

• LynkeosProcessing.h

---