Lynkeos
Instance Methods | List of all members
<LynkeosProcessableItem> Protocol Reference

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

#import <LynkeosProcessing.h>

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

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]blackThe level below which only black is diplayed
[out]whiteThe level above which white is displayed
[out]gammaThe gamma correction
Returns
Wether the levels are set
Parameters
gammaThe 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]blackThe level below which only black is diplayed
[out]whiteThe level above which white is displayed
[out]gammaThe gamma correction
planeThe 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
bufferThe buffer in which to put the transform
rectThe rectangle from which the data to transform is extracted
prepareInverseWether 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
bufferThe image or Fourier buffer to fill, if nil it is created
rectThe 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]vminThe minimum level of the image
[out]vmaxThe 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]vminThe minimum level of the image
[out]vmaxThe maximum level
planeThe 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
- (BOOL) isOriginal

Wether the image is the original or has been processed.

Returns
YES if the image has not been processed
- (BOOL) isProcessed

Whether the image (even if original) comes from some process.

A freshly stacked image is the original image for the item, but does come from the stacking process.

Returns
NO when the image comes from a file
- (u_short) numberOfPlanes

Get the number of color planes.

Returns
The number of color planes

Referenced by MyChromaticLevelsView::changeGammaStep:, and MyChromaticLevelsView::changeLevelStep:.

- (void) revertToOriginal

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

Returns
None

Referenced by ProcessStackManager::getParameterForItem:andParam:, and MyLucyRichardsonView::startProcess:.

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

Sets the levels for image visualization.

Parameters
blackThe level below which only black is diplayed
whiteThe level above which white is displayed
gammaThe gamma correction

Referenced by MyChromaticLevelsView::changeLevel:, MyWaveletView::selectChange:, and MyChromaticAlignerView::showOriginal:.

- (void) setBlackLevel: (double)  black
whiteLevel: (double)  white
gamma: (double)  gamma
forPlane: (u_short)  plane 

Sets the levels for one color plane.

These settings are applied before the global settings during image visualization

Parameters
blackThe level below which only black is diplayed
whiteThe level above which white is displayed
gammaThe gamma correction
planeThe plane number

Referenced by MyChromaticLevelsView::changeLevel:.

- (void) setFourierTransform: (LynkeosFourierBuffer *)  buffer

Set the fourier transform after processing.

The processable item makes the inverse transform when appropriate

Parameters
bufferThe processed fourier transform
- (void) setImage: (LynkeosStandardImageBuffer *)  buffer

Save the resulting image.

Parameters
bufferThe buffer containing the image processing result.

Referenced by MyChromaticAlignerView::automaticOffsets:, and LynkeosProcessableImage::setResult:.

- (void) setOriginalImage: (LynkeosStandardImageBuffer *)  buffer

Save the resulting image as the original image.

Parameters
bufferThe buffer containing the image processing result.

Referenced by MyImageList::deleteItem:, MyWaveletView::selectChange:, and MyChromaticAlignerView::showOriginal:.


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