Raytrix Light Field SDK  5.0
Rx::FileIO::CTrixBaseReader Class Reference

Detailed Description

TRIX File Base Reader.

Inherits Rx::FileIO::CTrixBase.

Public Member Functions

 CTrixBaseReader ()
 Default constructor. More...
 
 ~CTrixBaseReader ()
 Destructor. More...
 
void Close ()
 Closes this CTrixBaseReader and the file. More...
 
size_t GetFrameCount () const
 Gets the frame count. More...
 
void Open (const CRxString &sxFilename)
 Opens a new file for read. More...
 
void ReadD3DRange (float &fxMin, float &fxMax, float &fyMin, float &fyMax, float &fzMin, float &fZMax, size_t nFrameIdx)
 Reads xyz - range of the depth3D map at index nFrameIdx. More...
 
void ReadDepthRange (float &fMin, float &fMax, size_t nFrameIdx)
 Reads depth range of the depth map at index nFrameIdx. More...
 
void ReadFrame (CRxImage &xFocusImg, CRxImage &xDepthImg, CRxImage &xDepth3DImg, size_t nFrameIdx)
 Reads a frame pair. More...
 

Static Public Member Functions

static const CRxStringGetGuid ()
 Gets the unique identifier of this type. More...
 
static unsigned GetVersion ()
 Gets the version. More...
 

Constructor & Destructor Documentation

◆ CTrixBaseReader()

Rx::FileIO::CTrixBaseReader::CTrixBaseReader ( )

Default constructor.

◆ ~CTrixBaseReader()

Rx::FileIO::CTrixBaseReader::~CTrixBaseReader ( )

Destructor.

Member Function Documentation

◆ Close()

void Rx::FileIO::CTrixBaseReader::Close ( )

Closes this CTrixBaseReader and the file.

◆ GetFrameCount()

size_t Rx::FileIO::CTrixBaseReader::GetFrameCount ( ) const

Gets the frame count.

Returns
The frame count.

◆ GetGuid()

static const CRxString& Rx::FileIO::CTrixBase::GetGuid ( )
staticinherited

Gets the unique identifier of this type.

Returns
The unique identifier.

◆ GetVersion()

static unsigned Rx::FileIO::CTrixBase::GetVersion ( )
staticinherited

Gets the version.

Returns
The version.

◆ Open()

void Rx::FileIO::CTrixBaseReader::Open ( const CRxString sxFilename)

Opens a new file for read.

Parameters
sxFilenameThe filename.

◆ ReadD3DRange()

void Rx::FileIO::CTrixBaseReader::ReadD3DRange ( float &  fxMin,
float &  fxMax,
float &  fyMin,
float &  fyMax,
float &  fzMin,
float &  fZMax,
size_t  nFrameIdx 
)

Reads xyz - range of the depth3D map at index nFrameIdx.

Parameters
fxMin[in,out] The X minimum.
fxMax[in,out] The X maximum.
fyMin[in,out] The Y minimum.
fyMax[in,out] The Y maximum.
fzMin[in,out] The Z minimum.
fZMax[in,out] The Z maximum.
nFrameIdxZero-based index of the frame.

◆ ReadDepthRange()

void Rx::FileIO::CTrixBaseReader::ReadDepthRange ( float &  fMin,
float &  fMax,
size_t  nFrameIdx 
)

Reads depth range of the depth map at index nFrameIdx.

Parameters
fMin[in,out] The minimum.
fMax[in,out] The maximum.
nFrameIdxZero-based index of the frame.

◆ ReadFrame()

void Rx::FileIO::CTrixBaseReader::ReadFrame ( CRxImage xFocusImg,
CRxImage xDepthImg,
CRxImage xDepth3DImg,
size_t  nFrameIdx 
)

Reads a frame pair.

Parameters
xFocusImg[out] The focus image.
xDepthImg[out] The depth image.
xDepth3DImg[in,out] If non-null, the in pixels depth 3D image.
nFrameIdxThe frame index.