PolarIntensitySensorParameters#

class ansys.speos.core.generic.parameters.PolarIntensitySensorParameters#

Parameters for SensorPolarIntensity.

Parameters:
formatPolarIntensityFormatTypes, optional

Output file format. Accepted values: "iesna_a", "iesna_b", "iesna_c", "eulumdat". By default, PolarIntensityFormatTypes.iesna_c.

dimensionsUnion[PolarIntensityDimensionsParameters, str, Path], optional

Either explicit horizontal/vertical sampling (PolarIntensityDimensionsParameters) or a path to an adaptive-sampling file (str). By default, PolarIntensityDimensionsParameters().

near_fieldOptional[NearfieldParameters], optional

Near-field configuration. When None, the sensor is in far-field mode. By default, None.

integration_anglefloat, optional

Far-field integration angle in degrees. Used only when near_field is None. By default, 5.0.

axis_systemlist[float], optional

Position of the sensor [Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz]. By default, [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1].

Overview#

format

Output file format.

dimensions

Sampling definition: explicit dimensions or adaptive-sampling file URI.

near_field

Near-field parameters. None means far-field mode.

integration_angle

Far-field integration angle in degrees.

axis_system

Position of the sensor.

Import detail#

from ansys.speos.core.generic.parameters import PolarIntensitySensorParameters

Attribute detail#

PolarIntensitySensorParameters.format: PolarIntensityFormatTypes#

Output file format.

PolarIntensitySensorParameters.dimensions: PolarIntensityDimensionsParameters | str | pathlib.Path#

Sampling definition: explicit dimensions or adaptive-sampling file URI.

PolarIntensitySensorParameters.near_field: NearfieldParameters | None = None#

Near-field parameters. None means far-field mode.

PolarIntensitySensorParameters.integration_angle: float = 1.0#

Far-field integration angle in degrees.

PolarIntensitySensorParameters.axis_system: list[float] = [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1]#

Position of the sensor.