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

#import <LynkeosProcessing.h>

Inheritance diagram for <LynkeosProcessableItem>:

Collaboration diagram for <LynkeosProcessableItem>:

Instance Methods
(u_short)	- numberOfPlanes
	Get the number of color planes. More...

(LynkeosIntegerSize)	- imageSize
	Read the image size. More...

(id< LynkeosImageBuffer >)	- getImage
	Access to the processed image. More...

(id< LynkeosImageBuffer >)	- getOriginalImage
	Access to the unprocessed image. More...

(u_long)	- getSequenceNumber
	Gives the item's image "sequence number". More...

(NSImage *)	- getNSImage
	Returns an NSImage for displaying. More...

(void)	- getImageSample:inRect:
	Read a calibrated sample from an image. More...

(void)	- getFourierTransform:forRect:prepareInverse:
	Access to the Fourier transform of the image. More...

(void)	- setFourierTransform:
	Set the fourier transform after processing. More...

(void)	- setImage:
	Save the resulting image. More...

(void)	- setOriginalImage:
	Save the resulting image as the original image. More...

(void)	- revertToOriginal
	Delete any processing result and go back to using the "original" image. More...

(BOOL)	- isOriginal
	Wether the image is the original or has been processed. More...

(BOOL)	- isProcessed
	Whether the image (even if original) comes from some process. More...

(void)	- setBlackLevel:whiteLevel:gamma:
	Sets the levels for image visualization. More...

(BOOL)	- getBlackLevel:whiteLevel:gamma:
	Retrieves the global levels for image visualization. More...

(BOOL)	- getMinLevel:maxLevel:
	Retrieves the minimum and maximum levels of an image. More...

(void)	- setBlackLevel:whiteLevel:gamma:forPlane:
	Sets the levels for one color plane. More...

(BOOL)	- getBlackLevel:whiteLevel:gamma:forPlane:
	Retrieves the levels for image visualization. More...

(BOOL)	- getMinLevel:maxLevel:forPlane:
	Retrieves the minimum and maximum levels of an image. More...

Instance Methods inherited from <LynkeosProcessable>
(id< LynkeosProcessingParameter >)	- getProcessingParameterWithRef:forProcessing:
	Returns the required processing parameter. More...

(id< LynkeosProcessingParameter >)	- getProcessingParameterWithRef:forProcessing:goUp:
	Returns the required processing parameter. More...

(void)	- setProcessingParameter:withRef:forProcessing:
	Updates the required processing parameter. More...

Detailed Description

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

Method Documentation

- (BOOL) getBlackLevel:	(double *)	black
whiteLevel:	(double *)	white
gamma:	(double *)	gamma

Retrieves the global levels for image visualization.

If the levels are not set, all parameters will be NaNs

Parameters

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

Returns: Wether the levels are set

Parameters

gamma The gamma correction

Referenced by MyChromaticAlignerView::showOriginal:.

- (BOOL) getBlackLevel:	(double *)	black
whiteLevel:	(double *)	white
gamma:	(double *)	gamma
forPlane:	(u_short)	plane

Retrieves the levels for image visualization.

If the levels are not set, all parameters will be NaNs

Parameters

[out]	black	The level below which only black is diplayed
[out]	white	The level above which white is displayed
[out]	gamma	The gamma correction
	plane	The plane number

Returns: Wether the levels are set

- (void) getFourierTransform:	(LynkeosFourierBuffer **)	buffer
forRect:	(LynkeosIntegerRect)	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

- (id <LynkeosImageBuffer>) getImage

Access to the processed image.

Returns: The processed LynkeosImageBuffer

- (void) getImageSample:	(LynkeosStandardImageBuffer **)	buffer
inRect:	(LynkeosIntegerRect)	rect

Read a calibrated sample from an 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.

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)

Referenced by MyWaveletView::selectChange:.

- (BOOL) getMinLevel:	(double *)	vmin
maxLevel:	(double *)	vmax

Retrieves the minimum and maximum levels of an image.

If the levels are not set, min and max will be NaNs

Parameters

[out]	vmin	The minimum level of the image
[out]	vmax	The maximum level

Returns: Wether the levels are set

Referenced by MyWaveletView::selectChange:.

- (BOOL) getMinLevel:	(double *)	vmin
maxLevel:	(double *)	vmax
forPlane:	(u_short)	plane

Retrieves the minimum and maximum levels of an image.

If the levels are not set, min and max will be NaNs

Parameters

[out]	vmin	The minimum level of the image
[out]	vmax	The maximum level
	plane	The plane number

Returns: Wether the levels are set

- (NSImage*) getNSImage

Returns an NSImage for displaying.

Returns: A NSImage built from the processed image data.

- (id <LynkeosImageBuffer>) getOriginalImage

Access to the unprocessed image.

Returns: The LynkeosImageBuffer before processing

- (u_long) getSequenceNumber

Gives the item's image "sequence number".

Returns: The item's image sequence number

The sequence number is incremented each time the image is modified. And therefore, the item's image is guaranteed to be unchanged if the sequence number is.

- (LynkeosIntegerSize) imageSize

Read the image size.