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. 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	GetFrameSize ()
	Gets the size of a frame in bytes. More...

void	GetGrayImage (RayImage^ xRayImg)
	Gets gray image. More...

void	GetGrayImage (Rx::Net::Image^ xGrayImage)
	Gets gray image. More...

virtual System::Object ^	GetInterface (Rx::LFR::Net::Interfaces::ESeqFileReader eData)
	Gets the interface. More...

unsigned	GetLastFrameIndex ()
	Gets the frame index of the last read frame. More...

void	GetMetaData (RayImage^ xRayImg)
	Reads the hold meta data of the sequence file. More...

void	GetMetaData (Rx::Net::MetaData^ xMetaData)
	Reads the hold meta data of the sequence file. More...

unsigned	GetNextFrameIndex ()
	Gets the next frame index. 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)
	Opens the given ray sequence for reading. More...

void	ReadFrame (RayImage^ xRayImg)
	Reads the frame and its camera format at the current frame index. More...

void	ReadFrame (RayImage^ xRayImg, bool bUpdateCalibration)
	Reads the frame and its camera format at the current frame index. More...

void	ReadFrame (RayImage^ xRayImg, bool bUpdateCalibration, bool bMoveToNextFrame)
	Reads the frame and its camera format at the current frame index. More...

void	SetNextFrameIndex (unsigned uNewIdx)
	Sets the current frame index. More...

Constructor & Destructor Documentation

◆ SeqFileReader()

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

inline

Default constructor.

◆ ~SeqFileReader()

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

inline

Destructor. Closes the file if opened.

Member Function Documentation

◆ Close()

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

inline

Closes the opened sequence file.

◆ GetDoubleShotMode()

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.

◆ GetFileSize()

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

inline

Gets the file size in bytes.

Returns: The file size.

◆ GetFrameCount()

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

inline

Gets the number of frames in the opened sequence.

Returns: The frame count.

◆ GetFrameSize()

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

inline

Gets the size of a frame in bytes.

Returns: The frame size.

◆ GetGrayImage() [1/2]

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

inline

Gets gray image.

Parameters

xRayImg The ray image, in which the gray image should be updated.

◆ GetGrayImage() [2/2]

void Rx::LFR::Net::SeqFileReader::GetGrayImage ( Rx::Net::Image^ xGrayImage )

inline

Gets gray image.

Parameters

xGrayImage [in,out] If non-null, the gray image.

◆ GetInterface()

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.

◆ GetLastFrameIndex()

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

inline

Gets the frame index of the last read frame.

Returns: The last read frame index.

◆ GetMetaData() [1/2]

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

inline

Reads the hold meta data of the sequence file.

Parameters

xRayImg The ray image, in which the meta data should be updated.

◆ GetMetaData() [2/2]

void Rx::LFR::Net::SeqFileReader::GetMetaData ( Rx::Net::MetaData^ xMetaData )

inline

Reads the hold meta data of the sequence file.

Parameters

xMetaData [out] The meta data.

◆ GetNextFrameIndex()

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

inline

Gets the next frame index.

Returns: The frame index of the frame that is going to be read next.

◆ IsOpen()

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

inline

Queries if a file has been opened.

Returns: True if open, false if not.

◆ MoveFrameIndex()

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

inline

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

Parameters

iDelta [in] The number of frames to move the current index.

◆ Open()

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

inline

Opens the given ray sequence for reading.

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

Parameters

sFilename [in] The complete file path.

◆ ReadFrame() [1/3]

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

inline

Reads the frame and its camera format at the current frame index.

Before frames can be read, you need to call Open.

The calibration will be updated with the next frame The frame index will be moved to the next frame

Parameters

xRayImg [out] The frame.

◆ ReadFrame() [2/3]

void Rx::LFR::Net::SeqFileReader::ReadFrame	(	RayImage^	xRayImg,
		bool	bUpdateCalibration
	)

inline

Reads the frame and its camera format at the current frame index.

Before frames can be read, you need to call Open. The frame index will be moved to the next frame

Parameters

xRayImg	[out] The frame.
bUpdateCalibration	True to update calibration.

◆ ReadFrame() [3/3]

void Rx::LFR::Net::SeqFileReader::ReadFrame	(	RayImage^	xRayImg,
		bool	bUpdateCalibration,
		bool	bMoveToNextFrame
	)

inline

Reads the frame and its camera format at the current frame index.

Before frames can be read, you need to call Open.

Parameters

xRayImg	[out] The frame.
bUpdateCalibration	True to update calibration.

◆ SetNextFrameIndex()

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

inline

Sets the current frame index.

Parameters

uNewIdx [in] The new frame index.

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ SeqFileReader()

◆ ~SeqFileReader()

Member Function Documentation

◆ Close()

◆ GetDoubleShotMode()

◆ GetFileSize()

◆ GetFrameCount()

◆ GetFrameSize()

◆ GetGrayImage() [1/2]

◆ GetGrayImage() [2/2]

◆ GetInterface()

◆ GetLastFrameIndex()

◆ GetMetaData() [1/2]

◆ GetMetaData() [2/2]

◆ GetNextFrameIndex()

◆ IsOpen()

◆ MoveFrameIndex()

◆ Open()

◆ ReadFrame() [1/3]

◆ ReadFrame() [2/3]

◆ ReadFrame() [3/3]

◆ SetNextFrameIndex()