Rx::LFR::Net::SeqFileReader Class Reference

Detailed Description

Provides methods for reading a ray sequence from a rays file.

Inherits Rx::Net::NativeInterfaceWrapper< Rx::LFR::CSeqFileReader, Rx::LFR::Net::Interfaces::ESeqFileReader >.

Public Member Functions
	SeqFileReader ()
	Default constructor. More...
	~SeqFileReader ()
	Destructor. Closes the file if opened. More...
void	Close ()
	Closes the opened sequence file and stops the background buffer thread. More...
unsigned	GetDoubleShotMode ()
	Gets the double shot mode of the opened sequence. Is 0 if the sequence wasn't recorded in double shot mode. More...
unsigned __int64	GetFileSize ()
	Gets the file size in bytes. More...
unsigned	GetFrameCount ()
	Gets the number of frames in the opened sequence. More...
unsigned	GetFrameIndex ()
	Gets the current frame index. More...
unsigned	GetFrameSize ()
	Gets the size of a frame in bytes. More...
virtual System::Object^	GetInterface (Rx::LFR::Net::Interfaces::ESeqFileReader eData)
	Gets the interface. More...
unsigned	GetUsedFrameBufferCount ()
	Gets the current number of used buffer slots. More...
bool	IsOpen ()
	Queries if a file has been opened. More...
void	MoveFrameIndex (int iDelta)
	Moves the current frame index by the given number forward or backward. More...
void	Open (System::String^ sFilename, unsigned uFrameBufferCount)
	Opens the given ray sequence for reading. More...
void	ReadFrame (Rx::Net::Image^ xFrame)
	Reads the frame at the current frame index. Reads the frame from buffer if already buffered. More...
void	SetFrameIndex (unsigned uNewIdx)
	Sets the current frame index. More...
void	StartReading (RayImage^ xRayImg)
	Reads the first frame including the meta data and the calibration. This starts the background buffer thread. More...

Constructor & Destructor Documentation

Rx::LFR::Net::SeqFileReader::SeqFileReader ( )

inline

Default constructor.

Rx::LFR::Net::SeqFileReader::~SeqFileReader ( )

inline

Destructor. Closes the file if opened.

Member Function Documentation

void Rx::LFR::Net::SeqFileReader::Close ( )

inline

Closes the opened sequence file and stops the background buffer thread.

unsigned Rx::LFR::Net::SeqFileReader::GetDoubleShotMode ( )

inline

Gets the double shot mode of the opened sequence. Is 0 if the sequence wasn't recorded in double shot mode.

Returns

The double shot mode.

unsigned __int64 Rx::LFR::Net::SeqFileReader::GetFileSize ( )

inline

Gets the file size in bytes.

Returns

The file size.

unsigned Rx::LFR::Net::SeqFileReader::GetFrameCount ( )

inline

Gets the number of frames in the opened sequence.

Returns

The frame count.

unsigned Rx::LFR::Net::SeqFileReader::GetFrameIndex ( )

inline

Gets the current frame index.

Returns

The frame index.

unsigned Rx::LFR::Net::SeqFileReader::GetFrameSize ( )

inline

Gets the size of a frame in bytes.

Returns

The frame size.

virtual System::Object ^ Rx::Net::NativeInterfaceWrapper< Rx::LFR::CSeqFileReader , Rx::LFR::Net::Interfaces::ESeqFileReader >::GetInterface ( Rx::LFR::Net::Interfaces::ESeqFileReader  eData )

inlinevirtualinherited

Gets the interface.

Returns

The interface.

unsigned Rx::LFR::Net::SeqFileReader::GetUsedFrameBufferCount ( )

inline

Gets the current number of used buffer slots.

Returns

The used frame buffer count.

bool Rx::LFR::Net::SeqFileReader::IsOpen ( )

inline

Queries if a file has been opened.

Returns

True if open, false if not.

void Rx::LFR::Net::SeqFileReader::MoveFrameIndex ( int  iDelta )

inline

Moves the current frame index by the given number forward or backward.

Parameters

iDelta

The number of frames to move the current index.

void Rx::LFR::Net::SeqFileReader::Open ( System::String^  sFilename, unsigned  uFrameBufferCount  )

inline

Opens the given ray sequence for reading.

Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate).

Parameters

sFilename	[in] The complete file path.
uFrameBufferCount	Number of frames to buffer. Must NOT be zero. Default is 2.

void Rx::LFR::Net::SeqFileReader::ReadFrame ( Rx::Net::Image^  xFrame )

inline

Reads the frame at the current frame index. Reads the frame from buffer if already buffered.

Parameters

xFrame

[out] The frame.

void Rx::LFR::Net::SeqFileReader::SetFrameIndex ( unsigned  uNewIdx )

inline

Sets the current frame index.

Parameters

uNewIdx

The new frame index.

void Rx::LFR::Net::SeqFileReader::StartReading ( RayImage^  xRayImg )

inline

Reads the first frame including the meta data and the calibration. This starts the background buffer thread.

Parameters

xRayImg

[out] The ray image.