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

Protocol to conform for image file writers. More...

#import <LynkeosFileWriter.h>

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

Instance Methods

(void) - saveImageAtURL:withData:withPrecision:blackLevel:whiteLevel:withPlanes:width:lineWidth:height:metaData:
 Save the image data in a file at the given URL. Simple as that ;o) More...
 
- Instance Methods inherited from <LynkeosFileWriter>
(NSPanel *) - configurationPanel
 Get a configuration panel for this writer. More...
 

Additional Inherited Members

- Class Methods inherited from <LynkeosFileWriter>
(NSString *) + writerName
 Get a string identifying this writer. More...
 
(NSString *) + fileExtension
 Get the extension that should be appended to a file name, when written by this reader. More...
 
(BOOL) + canSaveDataWithPlanes:width:height:metaData:
 Check if this writer is able to save that kind of data. More...
 
(id< LynkeosFileWriter >) + writerForURL:planes:width:height:metaData:
 Constructor which creates a writer ready for writing some data with the given parameters. More...
 

Detailed Description

Protocol to conform for image file writers.

Method Documentation

- (void) saveImageAtURL: (NSURL *)  url
withData: (const void *const *const)  data
withPrecision: (floating_precision_t precision
blackLevel: (double)  black
whiteLevel: (double)  white
withPlanes: (u_short)  nPlanes
width: (u_short)  w
lineWidth: (u_short)  lineW
height: (u_short)  h
metaData: (NSDictionary *)  metaData 

Save the image data in a file at the given URL. Simple as that ;o)

The pixels in the data are already scaled to 0.0 for black and 1.0 for white. The parameters

Parameters
blackand
whitegive the value they had in the source image before scaling ; this can be used to save the original value (for example in floating point FITS).
urlThe URL of the file to save
dataAn array of pointers to the image color planes
precisionWether the data buffer contains floats or doubles
blackThe value of the black level in the source image
whiteThe value of the white level in the source image
nPlanesThe number of color planes.
wWidth of sample
lineWThe number of samples in each line, as it can be larger than w there may be spare at the end of the lines.
hHeight of sample
metaDataThe image meta data

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