Photon Engine 2.0.0-beta
A physically based renderer.
Loading...
Searching...
No Matches
ph::IesFile Class Referencefinal

#include <IesFile.h>

Public Types

enum class  EIesFileType { Unknown = 0 , LM_63_1986 , LM_63_1991 , LM_63_1995 }
 
enum class  EPhotometricWebType { A , B , C }
 

Public Member Functions

 IesFile (const Path &iesFilePath)
 
bool load ()
 
std::string getFilename () const
 
EIesFileType getIesFileType () const
 Gets the type of this IES file.
 
std::string getTestInfo () const
 Gets the test report number and laboratory for the IES file.
 
std::string getLuminaireManufacturer () const
 
std::string getLuminaireCatalogNumber () const
 
std::string getLuminaireDescription () const
 
std::string getLampCatalogNumber () const
 
std::string getLampDescription () const
 
std::string getUncategorizedInfo () const
 Gets descriptions that are not categorized by the parser.
 
uint32 getNumLamps () const
 
real getLumensPerLamp () const
 
real getCandelaMultiplier () const
 
uint32 getNumVerticalAngles () const
 
uint32 getNumHorizontalAngles () const
 
EPhotometricWebType getPhotometricWebType () const
 
std::vector< real > getVerticalAngles () const
 
std::vector< real > getHorizontalAngles () const
 
std::vector< std::vector< real > > getCandelaValues () const
 

Detailed Description

A low-level class that parses an IES photometric data file and provides convenient methods for file content accessing.

Reference: http://lumen.iee.put.poznan.pl/kw/iesna.txt

Member Enumeration Documentation

◆ EIesFileType

enum class ph::IesFile::EIesFileType
strong
Enumerator
Unknown 
LM_63_1986 
LM_63_1991 
LM_63_1995 

◆ EPhotometricWebType

Enumerator

Type A photometry is normally used for automotive headlights and signal lights. The polar axis of the luminaire coincides with the major axis (length) of the luminaire, and the 0-180 degree photometric plane coinicides with the luminaire's vertical axis.

Type B photometry is normally used for adjustable outdoor area and sports lighting luminaires. The polar axis of the luminaire coincides with the minor axis (width) of the luminaire, and the 0-180 degree photometric plane coinicides with the luminaire's vertical axis.

Type C photometry is normally used for architectural and roadway luminaires. The polar axis of the photometric web coincides with the vertical axis of the luminaire, and the 0-180 degree photometric plane coincides with the luminaire's major axis (length).

Constructor & Destructor Documentation

◆ IesFile()

ph::IesFile::IesFile ( const Path & iesFilePath)
explicit

Member Function Documentation

◆ getCandelaMultiplier()

real ph::IesFile::getCandelaMultiplier ( ) const

◆ getCandelaValues()

std::vector< std::vector< real > > ph::IesFile::getCandelaValues ( ) const
Returns
Candela values stored as data[horizontal_index][vertical_index].

◆ getFilename()

std::string ph::IesFile::getFilename ( ) const

◆ getHorizontalAngles()

std::vector< real > ph::IesFile::getHorizontalAngles ( ) const

◆ getIesFileType()

IesFile::EIesFileType ph::IesFile::getIesFileType ( ) const

Gets the type of this IES file.

◆ getLampCatalogNumber()

std::string ph::IesFile::getLampCatalogNumber ( ) const

◆ getLampDescription()

std::string ph::IesFile::getLampDescription ( ) const

◆ getLumensPerLamp()

real ph::IesFile::getLumensPerLamp ( ) const

◆ getLuminaireCatalogNumber()

std::string ph::IesFile::getLuminaireCatalogNumber ( ) const

◆ getLuminaireDescription()

std::string ph::IesFile::getLuminaireDescription ( ) const

◆ getLuminaireManufacturer()

std::string ph::IesFile::getLuminaireManufacturer ( ) const

◆ getNumHorizontalAngles()

uint32 ph::IesFile::getNumHorizontalAngles ( ) const

◆ getNumLamps()

uint32 ph::IesFile::getNumLamps ( ) const

◆ getNumVerticalAngles()

uint32 ph::IesFile::getNumVerticalAngles ( ) const

◆ getPhotometricWebType()

IesFile::EPhotometricWebType ph::IesFile::getPhotometricWebType ( ) const

◆ getTestInfo()

std::string ph::IesFile::getTestInfo ( ) const

Gets the test report number and laboratory for the IES file.

◆ getUncategorizedInfo()

std::string ph::IesFile::getUncategorizedInfo ( ) const

Gets descriptions that are not categorized by the parser.

◆ getVerticalAngles()

std::vector< real > ph::IesFile::getVerticalAngles ( ) const

◆ load()

bool ph::IesFile::load ( )

The documentation for this class was generated from the following files: