BxdfDatapoint

class ansys.speos.core.bsdf.BxdfDatapoint(is_brdf, incident_angle, theta_values, phi_values, bxdf, tis=1, anisotropy=0, wavelength=555)

Class to store a BxDF data point.

Parameters:

is_brdfbool

true for transmittive date, False for reflective

incident_anglefloat

incident angle in radian

theta_valuesCollection[float]

List of theta values for the bxdf data matrix, in radian

phi_valuesCollection[float]

List of phi values for the bxdf data matrix, in radian

bxdfCollection[float]

nested list of bxdf values in 1/sr

anisotropyfloat

Anisotropy angle in radian

wavelengthfloat

Wavelength in nm

Parameters:

• is_brdf (bool)

• incident_angle (float)

• theta_values (collections.abc.Collection[float])

• phi_values (collections.abc.Collection[float])

• bxdf (collections.abc.Collection[float])

• tis (float)

• anisotropy (float)

• wavelength (float)

Overview

Methods

get	Retrieve any information from the BxdfDatapoint object.
set_incident_angle	Allow to set an incident value in degree.

Properties

is_brdf	Type of bxdf data point eitehr reflective or transmittive.
incident_angle	Incident angle of the Datapoint in radian.
anisotropy	Property of Anisotropy angels of Datapoint.
theta_values	Property of bxdf phi values.
phi_values	Property of bxdf phi values.
bxdf	BxDF data as np matrix in 1/sr.

Attributes

tis
wavelength

Special methods

__str__

Create string representation of a RayPath.

Import detail

from ansys.speos.core.bsdf import BxdfDatapoint

Property detail

property BxdfDatapoint.is_brdf

Type of bxdf data point eitehr reflective or transmittive.

Parameters:

valuebool

true if reflective false if transmittive.

Returns:

bool

true if reflective false if transmittive.

property BxdfDatapoint.incident_angle: float

Incident angle of the Datapoint in radian.

Parameters:

valuefloat

Incidence angle in radian

Returns:

float

Incidence angle in radian

property BxdfDatapoint.anisotropy: float

Property of Anisotropy angels of Datapoint.

Parameters:

valuefloat

Anisotropy angle in radian.

Returns:

float

Anisotropy angle.

property BxdfDatapoint.theta_values: List[float]

Property of bxdf phi values.

Parameters:

valueList[float]

List of bxdf theta values.

Returns:

List[float]

List of bxdf theta values.

property BxdfDatapoint.phi_values: List[float]

Property of bxdf phi values.

Parameters:

valueList[float]

List of bxdf phi values.

Returns:

List[float]

List of bxdf phi values.

property BxdfDatapoint.bxdf: numpy.array

BxDF data as np matrix in 1/sr.

Parameters:

valueUnion[Collection[float], np.array]

bxdf data in shape theta_values, phi_values

Returns:

np.array

bxdf data in shape theta_values, phi_values

Attribute detail

BxdfDatapoint.tis = 1

BxdfDatapoint.wavelength = 555

Method detail

BxdfDatapoint.get(key='')

Retrieve any information from the BxdfDatapoint object.

Parameters:

keystr

Name of the property.

Returns:

property

Values/content of the associated property.

BxdfDatapoint.__str__()

Create string representation of a RayPath.

BxdfDatapoint.set_incident_angle(value, is_deg=True)

Allow to set an incident value in degree.

Parameters:

valuefloat

value to be set

is_degbool

Allows to define if value is radian or degree

Returns:

None