OpenDAFF C++ API  v1.7
Directional Audio File Format
Public Member Functions | List of all members
DAFFContentPS Class Referenceabstract

Phase spectrum content interface. More...

#include <DAFFContentPS.h>

Inheritance diagram for DAFFContentPS:
DAFFContent DAFFReaderImpl

Public Member Functions

virtual ~DAFFContentPS ()
 
virtual int getNumFrequencies () const =0
 Returns the number of support points (frequencies) More...
 
virtual const std::vector< float > & getFrequencies () const =0
 Retrieves the frequencies [in Hertz] at which values are defined. More...
 
virtual int getPhases (int iRecordIndex, int iChannel, float *pfDest) const =0
 Retrieves phase coefficients. More...
 
- Public Member Functions inherited from DAFFContent
virtual ~DAFFContent ()
 
virtual DAFFReadergetParent () const =0
 Returns the parent reader. More...
 
virtual const DAFFPropertiesgetProperties () const =0
 Returns the properties. More...
 
virtual const DAFFMetadatagetRecordMetadata (int iRecordIndex) const =0
 Returns the metadata of a record. More...
 
virtual int getRecordCoords (int iRecordIndex, int iView, float &fAngle1Deg, float &fAngle2Deg) const =0
 Determines the spherical coordinates of a record (grid point on spherical regular grid) More...
 
virtual void getNearestNeighbour (int iView, float fAngle1Deg, float fAngle2Deg, int &iRecordIndex) const =0
 Determine the nearest neighbour record and return its index. More...
 
virtual void getNearestNeighbour (int iView, float fAngle1Deg, float fAngle2Deg, int &iRecordIndex, bool &bOutOfBounds) const =0
 Determine the nearest neighbour record and return its index (with boundary validatsion) More...
 
virtual void getCell (int iView, float fAngle1Deg, float fAngle2Deg, DAFFQuad &qIndices) const =0
 Determines the cell of a given direction on the sphere grid and delivers its surrounding record indices. More...
 
virtual void transformAnglesD2O (float fAlphaDeg, float fBetaDeg, float &fAzimuthDeg, float &fElevationDeg) const =0
 Transforms data spherical coordinates into object spherical coordinates. More...
 
virtual void transformAnglesO2D (float fAzimuthDeg, float fElevationDeg, float &fAlphaDeg, float &fBetaDeg) const =0
 Transforms object spherical coordinates into data spherical coordinates. More...
 

Detailed Description

Phase spectrum content interface.

This purely abstract class defines the special interface for phase spectrum content (frequency-domain). Each record contains for each channel a fixed number of phase coefficients defined over a common support of frequencies.

The number and values of the support frequencies can be determined using the methods getNumFrequencies and getFrequencies. The phase coefficients can be retrieved using the method getPhases.

Definition at line 31 of file DAFFContentPS.h.

Constructor & Destructor Documentation

virtual DAFFContentPS::~DAFFContentPS ( )
inlinevirtual

Definition at line 34 of file DAFFContentPS.h.

Member Function Documentation

virtual const std::vector<float>& DAFFContentPS::getFrequencies ( ) const
pure virtual

Retrieves the frequencies [in Hertz] at which values are defined.

Implemented in DAFFReaderImpl.

virtual int DAFFContentPS::getNumFrequencies ( ) const
pure virtual

Returns the number of support points (frequencies)

Implemented in DAFFReaderImpl.

virtual int DAFFContentPS::getPhases ( int  iRecordIndex,
int  iChannel,
float *  pfDest 
) const
pure virtual

Retrieves phase coefficients.

This method retrives the phase coefficients for the given direction (record index) and channel and stores them in the supplied destination buffer. The method writes exactly as many coefficients as there are support frequencies. Their number can be determined using the method getNumFrequencies.

Parameters
[in]iRecordIndexRecord index (direction)
[in]iChannelChannel index
[out]pfDestDestination buffer (size >= number of frequencies)
Returns
DAFF_NO_ERROR on success, another DAFF_ERROR otherwise

Implemented in DAFFReaderImpl.


The documentation for this class was generated from the following file:
OpenDAFF is a project from the Institute of Technical Acoustics, RWTH Aachen University, Germany.