Raytrix Light Field SDK  4.0
Logo
Public Member Functions | Static Public Member Functions | List of all members
Rx::LFR::CRayFileWriter Class Reference

Detailed Description

Provides methods for writing a ray image to a ray file.

Inherits Rx::LFR::CPimpl< CRayFileWriter_Impl, Interfaces::ERayFileWriter::ID >.

Public Member Functions

CRayFileWriter_Impl & GetImpl ()
 Gets the non constant implementation. More...
 
const CRayFileWriter_Impl & GetImpl () const
 Gets the constant implementation. More...
 
const void * GetInterface (Interfaces::ERayFileWriter::ID eInterface) const
 Gets the interface defined by the given interface ID. More...
 
bool HasInterface (Interfaces::ERayFileWriter::ID eInterface)
 Queries if this object has the given interface. More...
 

Static Public Member Functions

static void * GetInterface (Interfaces::ERayFileWriter::ID eData)
 Gets the interface defined by ERayFileWriterInterface. More...
 
static void Write (const CRxString &sxFile, CRayImage &xImg)
 Writes the given ray image to the given file. More...
 
static void Write (const CRxString &sxFile, const CRayImage &xImg, CRxMetaData &xMeta)
 Writes the given ray image to the given file but overwrites the meta data by the given one. More...
 
static void Write (const CRxString &sxFile, const CRxImage &xImg, const CCalibration &xCalib)
 Writes the given ray image to the given file. More...
 
static void Write (const CRxString &sxFile, const CRxImage &xImg, const CCalibration &xCalib, CRxMetaData &xMeta)
 Writes the given ray image to the given file. More...
 
static void WriteGrayImage (const CRxString &sxFile, const CRxImage &xImg)
 Writes the given gray image to the given file. More...
 

Member Function Documentation

CRayFileWriter_Impl & Rx::LFR::CPimpl< CRayFileWriter_Impl , Interfaces::ERayFileWriter::ID >::GetImpl ( )
inlineinherited

Gets the non constant implementation.

Returns
The implementation.
const CRayFileWriter_Impl & Rx::LFR::CPimpl< CRayFileWriter_Impl , Interfaces::ERayFileWriter::ID >::GetImpl ( ) const
inlineinherited

Gets the constant implementation.

Returns
The implementation.
const void* Rx::LFR::CPimpl< CRayFileWriter_Impl , Interfaces::ERayFileWriter::ID >::GetInterface ( Interfaces::ERayFileWriter::ID  eInterface) const
inherited

Gets the interface defined by the given interface ID.

Parameters
eInterfaceThe interface ID.
Returns
Null if it fails, else the interface.
static void* Rx::LFR::CRayFileWriter::GetInterface ( Interfaces::ERayFileWriter::ID  eData)
static

Gets the interface defined by ERayFileWriterInterface.

Parameters
eDataThe interface type.
Returns
Null if it fails, else the interface.
bool Rx::LFR::CPimpl< CRayFileWriter_Impl , Interfaces::ERayFileWriter::ID >::HasInterface ( Interfaces::ERayFileWriter::ID  eInterface)
inlineinherited

Queries if this object has the given interface.

Parameters
eInterfaceThe interface to query.
Returns
True if this class has the given interface, false if not.
static void Rx::LFR::CRayFileWriter::Write ( const CRxString sxFile,
CRayImage xImg 
)
static

Writes the given ray image to the given file.

Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate) with the Rx::Dongle::ERuntimeFeature::Save feature.

Parameters
sxFileThe file.
xImg[in,out] The ray image. The meta data gets updated while writing.
static void Rx::LFR::CRayFileWriter::Write ( const CRxString sxFile,
const CRayImage xImg,
CRxMetaData xMeta 
)
static

Writes the given ray image to the given file but overwrites the meta data by the given one.

Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate) with the Rx::Dongle::ERuntimeFeature::Save feature.

Parameters
sxFileThe file.
xImgThe ray image.
xMeta[in,out] The meta data. This gets updated while writing.
static void Rx::LFR::CRayFileWriter::Write ( const CRxString sxFile,
const CRxImage xImg,
const CCalibration xCalib 
)
static

Writes the given ray image to the given file.

Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate) with the Rx::Dongle::ERuntimeFeature::Save feature.

Parameters
sxFileThe file.
xImgThe ray image.
xCalibThe calibration of the ray image.
static void Rx::LFR::CRayFileWriter::Write ( const CRxString sxFile,
const CRxImage xImg,
const CCalibration xCalib,
CRxMetaData xMeta 
)
static

Writes the given ray image to the given file.

Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate) with the Rx::Dongle::ERuntimeFeature::Save feature.

Parameters
sxFileThe file.
xImgThe ray image.
xCalibThe calibration of the ray image.
xMeta[in,out] The meta data. This gets updated while writing.
static void Rx::LFR::CRayFileWriter::WriteGrayImage ( const CRxString sxFile,
const CRxImage xImg 
)
static

Writes the given gray image to the given file.

Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate).

Parameters
sxFileThe file.
xImgThe gray image.