photonmap.Reader.ReadPO

Functions

setup_dataset_materials(w_start, w_end, po_dir)

Fills the materialsR (reflection), materialsS (specular) and materialsT (transmission) dictionaries with information from the provided data for the materials of

get_average_of_props_optic(→ float)

Calculate the average value of an optical property in a spectral range

Module Contents

photonmap.Reader.ReadPO.setup_dataset_materials(w_start: int, w_end: int, po_dir: str)[source]

Fills the materialsR (reflection), materialsS (specular) and materialsT (transmission) dictionaries with information from the provided data for the materials of the simulation.

Parameters

w_start: int

The first wavelength of band.

w_end: int

The last wavelength of band.

po_dir: str

The folder which contains all the optical properties of the room

Returns

materialsRdict

The reflections of all the materials

materialsSdict

The specularities of all the materials

materialsTdict

The transmission of all the materials

photonmap.Reader.ReadPO.get_average_of_props_optic(band: range, props: dict) float[source]

Calculate the average value of an optical property in a spectral range

Parameters

band: range

The spectral range which is considered

props: dict

A dictionary which contains the optical properties calculated for each wavelength in spectral range

Returns

result: float

the average optical property in a spectral range