< LynkeosMovieFileReader > Protocol Reference
[Graphic files access]

Protocol for movie file readers. More...

#import <LynkeosFileReader.h>

Inheritance diagram for < LynkeosMovieFileReader >:

[legend]

Collaboration diagram for < LynkeosMovieFileReader >:

[legend]

List of all members.

Public Member Functions
(u_long)	- numberOfFrames
	Returns the number of frames in the movie.
(NSImage *)	- getNSImageAtIndex:
	Returns an NSImage for displaying one movie frame.
(void)	- getImageSample:atIndex:withPrecision:withPlanes:atX:Y:W:H:lineWidth:
	Retrieves one movie frame data for processing.
(id< LynkeosImageBuffer >)	- getCustomImageSampleAtIndex:atX:Y:W:H:
	Retrieves image data in a custom format for calibration.(see hasCustomImageBuffer).

---

Detailed Description

Protocol for movie file readers.

It allows the application to access each movie frame data.

---

Member Function Documentation

- (u_long) numberOfFrames

Returns the number of frames in the movie.

Returns:

The number of movie frames.

- (NSImage*) getNSImageAtIndex:

(u_long)

index

Returns an NSImage for displaying one movie frame.

Parameters:

index

The index of the frame to read.

Returns:

A NSImage built from the image data.

- (void) getImageSample:		(void *const *const )	sample
atIndex:		(u_long)	index
withPrecision:		(floating_precision_t)	precision
withPlanes:		(u_short)	nPlanes
atX:		(u_short)	x
Y:		(u_short)	y
W:		(u_short)	w
H:		(u_short)	h
lineWidth:		(u_short)	lineW

Retrieves one movie frame data for processing.

The (x,y) coordinate system has its origin in the top left corner of the image. The samples shall be ordered left to right, then top to bottom.
Most file formats share this orientation and pixels ordering.

Implementors can use the macro SET_SAMPLE (from LynkeosImageBuffer.h) to fill the output buffer.

Parameters:

	sample	An array of buffers to fill with image data
	precision	Wether the sample buffer shall be filled with floats or doubles
	index	The index of the frame to read.
	nPlanes	The number of buffers in the array. It can be 1 (the data shall be converted to monochrome), or 3 (RGB data).
	x	X origin of the sample
	y	Y origin of the sample
	w	Width of sample
	h	Height of sample
	lineW	The number of samples in each line, as it can be larger than w there may be spare at the end of the lines. This only applies to sample

- (id <LynkeosImageBuffer>) getCustomImageSampleAtIndex:		(u_long)	index
atX:		(u_short)	x
Y:		(u_short)	y
W:		(u_short)	w
H:		(u_short)	h

Retrieves image data in a custom format for calibration.(see hasCustomImageBuffer).

Parameters:

	index	The index of the frame to read.
	x	X origin of the sample
	y	Y origin of the sample
	w	Width of sample
	h	Height of sample

Returns:

The image data in a custom format class conforming to LynkeosImageBuffer protocol

---

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

• LynkeosFileReader.h

---