Lynkeos
Instance Methods | Class Methods | Protected Attributes | List of all members
MyImageListItem Class Reference

Common class for all image list items. More...

#import <MyImageListItem.h>

Inheritance diagram for MyImageListItem:
Inheritance graph
[legend]
Collaboration diagram for MyImageListItem:
Collaboration graph
[legend]

Instance Methods

(id) - initWithURL:
 Initialization. More...
 
Read

Read accessors to the class attributes

(NSURL *) - getURL
 Read the URL of the associated file. More...
 
(int) - getSelectionState
 Read the item current selection state. More...
 
(NSNumber *) - selectionState
 Get the item current selection state as a NSNumber. More...
 
(NSString *) - name
 Read the name of the associated file. More...
 
(NSNumber *) - index
 Read the movie image index (nil if not in a movie) More...
 
(MyImageListItem *) - getParent
 Get the parent item if there is one. More...
 
(u_long) - numberOfChildren
 Return the number of children, 0 for leaf items. More...
 
(MyImageListItem *) - getChildAtIndex:
 Get the asked item. More...
 
(NSUInteger) - indexOfItem:
 Get the index of the given item in the child list (different from the item index which is the index of its frame in the movie) More...
 
(id< LynkeosFileReader >) - getReader
 Get the file reader for that item. More...
 
Write

Write accessors to the class attributes

(void) - addChild:
 Add the given child in the children list. More...
 
(void) - deleteChild:
 Delete the given child from the children list. More...
 
(void) - setSelected:
 Set the selection state (no tristate) More...
 
(void) - setParametersParent:
 Set the parent object for parameters chain. More...
 
- Instance Methods inherited from LynkeosProcessableImage
(u_long) - originalImageSequence
 Get the seqence number of the original image. More...
 
(id< LynkeosImageBuffer >) - getResult
 Get the current image or processed spectrum.
 
(void) - setResult:
 Save the result as the processed image or spectrum.
 
- Instance Methods inherited from <LynkeosProcessableItem>
(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...
 

Class Methods

(id) + imageListItemWithURL:
 Creator. More...
 
(NSArray *) + imageListItemFileTypes
 File types and subclasses registering. More...
 

Protected Attributes

id< LynkeosImageFileReader,
LynkeosMovieFileReader
_reader
 < The associated file reader
 
NSURL_itemURL
 Image or movie URL.
 
NSString * _itemName
 To be displayed to user.
 
NSMutableArray_childList
 Array of childs, if any.
 
MyImageListItem_parent
 Parent item, if any.
 
NSUInteger _index
 
int _selection_state
 Current selection state, can be tri state.
 
id< LynkeosImageBuffer_flat
 Cached flat field.
 
id< LynkeosImageBuffer_dark
 Cached dark frame.
 
- Protected Attributes inherited from LynkeosProcessableImage
LynkeosStandardImageBuffer_originalImage
 
LynkeosStandardImageBuffer_intermediateImage
 Intermediate result, input of the current processing.
 
LynkeosStandardImageBuffer_processedImage
 Stored processed image.
 
LynkeosFourierBuffer_processedSpectrum
 Processed spectrum if any.
 
u_long _imageSequenceNumber
 Sequence number of the image.
 
u_long _originalSequenceNumber
 
LynkeosProcessingParameterMgr_parameters
 Aggregate class for parameters.
 
LynkeosIntegerSize _size
 Cached image size.
 
u_short _nPlanes
 Cached number of planes.
 
BOOL _planeLevelsAreSet
 Whether the user has chaged them.
 
double * _black
 Black level for displaying the processed image.
 
double * _white
 White level for displaying the processed image.
 
double * _gamma
 Gamma correction for displaying.
 

Detailed Description

Common class for all image list items.

It provides a unique interface to the outline view, and the common data and methods for the image list items.

Method Documentation

- (void) addChild: (MyImageListItem*)  item

Add the given child in the children list.

Parameters
itemThe item to add

References _childList, _index, and setParametersParent:.

Referenced by MyDocument::addEntry:.

- (void) deleteChild: (MyImageListItem*)  item

Delete the given child from the children list.

Parameters
itemThe item to delete

References _childList.

- (MyImageListItem *) getChildAtIndex: (u_long)  index

Get the asked item.

Parameters
indexThe index of item to get.
Returns
The child item.

References _childList.

- (MyImageListItem *) getParent

Get the parent item if there is one.

Returns
The parent item or nil

References _parent.

Referenced by MyDocument::addEntry:, MyImageList::deleteItem:, MyImageListEnumerator::initWithImageList:startAt:directSense:skipUnselected:, and setSelected:.

- (id< LynkeosFileReader >) getReader

Get the file reader for that item.

Returns
The file reader associated with this item.

References _reader.

Referenced by MyCalibrationLock::addCalibrationItem:, MyCalibrationLock::addImageItem:, and MyCalibrationLock::removeItem:.

- (int) getSelectionState

Read the item current selection state.

Returns
Tristate selection state.

References _selection_state.

- (NSURL *) getURL

Read the URL of the associated file.

Returns
The URL

References _itemURL.

+ (NSArray *) imageListItemFileTypes

File types and subclasses registering.

Returns
The file types array.

References MyPluginsController::defaultPluginController.

+ (id) imageListItemWithURL: (NSURL*)  url

Creator.

Parameters
urlThe URL from which the item shall be created.
Returns
The allocated and intialized item.
- (NSNumber *) index

Read the movie image index (nil if not in a movie)

Returns
The index or nil

References _index.

- (NSUInteger) indexOfItem: (MyImageListItem*)  item

Get the index of the given item in the child list (different from the item index which is the index of its frame in the movie)

Parameters
itemThe item which index we need
Returns
The index

References _childList.

Referenced by MyImageListEnumerator::initWithImageList:startAt:directSense:skipUnselected:.

- (id) initWithURL: (NSURL*)  url

Initialization.

Parameters
urlImage or movie associated with this item.

References _childList, and _reader.

- (NSString *) name

Read the name of the associated file.

Returns
The name

References _itemName.

- (u_long) numberOfChildren

Return the number of children, 0 for leaf items.

Returns
Number of children.

References _childList.

Referenced by MyImageListEnumerator::initWithImageList:startAt:directSense:skipUnselected:.

- (NSNumber *) selectionState

Get the item current selection state as a NSNumber.

Returns
Tristate selection state in a NSNumber

References _selection_state.

- (void) setParametersParent: (LynkeosProcessingParameterMgr*)  parent

Set the parent object for parameters chain.

Parameters
parentThe parent of this item in the parameter chain

References LynkeosProcessableImage::_parameters, and LynkeosProcessingParameterMgr::_parent.

Referenced by addChild:, and MyImageList::addItem:.

- (void) setSelected: (BOOL)  value

Member Data Documentation

- (NSUInteger) _index
protected

Our index, if any

Referenced by addChild:, and index.


The documentation for this class was generated from the following files: