openstudio::radiance::AnnualIlluminanceMap Class Reference

#include <AnnualIlluminanceMap.hpp>

Public Member Functions
	AnnualIlluminanceMap ()
	default constructor More...
	AnnualIlluminanceMap (const openstudio::path &path)
	constructor with path More...
openstudio::DateTimeVector	dateTimes () const
	get the dates and times for which illuminance maps are available More...
openstudio::Matrix	illuminanceMap (const openstudio::DateTime &dateTime) const
	get the illuminance map in lux corresponding to date and time More...
openstudio::Vector	xVector () const
	get the x points corresponding to illuminance matrix columns in meters More...
openstudio::Vector	yVector () const
	get the y points corresponding to illuminance matrix rows in meters More...
virtual	~AnnualIlluminanceMap ()=default
	virtual destructor More...

Detailed Description

AnnualIlluminanceMap represents illuminance map for an entire year.

We assume that the output files is from SPOT, with length in meters and illuminance values in footcandles. All illuminance values are converted to lux.

Constructor & Destructor Documentation

openstudio::radiance::AnnualIlluminanceMap::AnnualIlluminanceMap

(

)

default constructor

openstudio::radiance::AnnualIlluminanceMap::AnnualIlluminanceMap

(

const openstudio::path &

path

)

constructor with path

virtual openstudio::radiance::AnnualIlluminanceMap::~AnnualIlluminanceMap ( )

virtualdefault

virtual destructor

Member Function Documentation

openstudio::DateTimeVector openstudio::radiance::AnnualIlluminanceMap::dateTimes ( ) const

inline

get the dates and times for which illuminance maps are available

openstudio::Matrix openstudio::radiance::AnnualIlluminanceMap::illuminanceMap

(

const openstudio::DateTime &

dateTime

)

const

get the illuminance map in lux corresponding to date and time

openstudio::Vector openstudio::radiance::AnnualIlluminanceMap::xVector ( ) const

inline

get the x points corresponding to illuminance matrix columns in meters

openstudio::Vector openstudio::radiance::AnnualIlluminanceMap::yVector ( ) const

inline

get the y points corresponding to illuminance matrix rows in meters