The ``parameters.py`` module
============================
.. py:module:: ansys.speos.core.generic.parameters
Summary
-------
.. py:currentmodule:: parameters
.. tab-set::
.. tab-item:: Classes
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~ansys.speos.core.generic.parameters.WavelengthsRangeParameters`
- Wavelength Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.DimensionsParameters`
- Dimension Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensitySensorDimensionsConoscopicParameters`
- Dataclass for Intensity Sensor dimension in case of conoscopic.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensitySensorDimensionsXAsMeridianParameters`
- Dataclass for Intensity Sensor dimension in case of x_as_meridian.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensitySensorDimensionsXAsParallelParameters`
- Dataclass for Intensity Sensor dimension in case of x_as_parallel.
* - :py:obj:`~ansys.speos.core.generic.parameters.LayerBySequenceParameters`
- Layer separation type Parameters for Sequence separation.
* - :py:obj:`~ansys.speos.core.generic.parameters.GeometryLayerParameters`
- Geometry Layer Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.LayerByFaceParameters`
- Layer separation type Parameters for Face separation.
* - :py:obj:`~ansys.speos.core.generic.parameters.LayerByIncidenceAngleParameters`
- Layer separation type Parameters for Incidence angle separation.
* - :py:obj:`~ansys.speos.core.generic.parameters.BalanceModeUserWhiteParameters`
- Parameters for Balance mode: User White.
* - :py:obj:`~ansys.speos.core.generic.parameters.BalanceModeDisplayPrimariesParameters`
- Parameters for Balance mode: Display primaries.
* - :py:obj:`~ansys.speos.core.generic.parameters.ColorParameters`
- Camera Color Mode Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.MonoChromaticParameters`
- Monochromatic Camera Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.PhotometricCameraParameters`
- Photometric Parameters for Camera.
* - :py:obj:`~ansys.speos.core.generic.parameters.CameraSensorParameters`
- Camera Sensor Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.ColorimetricParameters`
- Colorimetric settings of the Sensor.
* - :py:obj:`~ansys.speos.core.generic.parameters.SpectralParameters`
- Colorimetric settings of the Sensor.
* - :py:obj:`~ansys.speos.core.generic.parameters.MeasuresParameters`
- Measurements for 3d Irradiance Sensor.
* - :py:obj:`~ansys.speos.core.generic.parameters.IrradianceSensorParameters`
- Irradiance Sensor Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.RadianceSensorParameters`
- Radiance Sensor Constants.
* - :py:obj:`~ansys.speos.core.generic.parameters.Irradiance3DSensorParameters`
- Parameters class for 3D Irradiance Sensor.
* - :py:obj:`~ansys.speos.core.generic.parameters.NearfieldParameters`
- Parameters data class for Nearfield.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensityXMPSensorParameters`
- Intensity Sensor Parameters Dataclass.
* - :py:obj:`~ansys.speos.core.generic.parameters.LuminousFluxParameters`
- Luminous Flux Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.RadiantFluxParameters`
- Radiant Flux Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.FluxFromFileParameters`
- Flux from intensity file.
* - :py:obj:`~ansys.speos.core.generic.parameters.SpectrumSampledParameters`
- Spectrum Sampled Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.SpectrumLibraryParameters`
- Spectrum Library Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.SpectrumBlackBodyParameters`
- Spectrum Black Body Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.LuminaireSourceParameters`
- Parameters class for Luminaire Source.
* - :py:obj:`~ansys.speos.core.generic.parameters.SpectrumMonochromaticParameters`
- Spectrum Monochromatic Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.RayFileSourceParameters`
- Parameters class for Ray File Source.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensityFluxParameters`
- Luminous Flux Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensityLambertianParameters`
- Intensity Lambertian Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensityCosParameters`
- Intensity Cos Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensitySymmetricGaussianParameters`
- Intensity Symmetric Gaussian Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensitAsymmetricGaussianParameters`
- Intensity Asymmetric Gaussian Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensityOrientationAxisSystemParameters`
- Intensity Orientation Axis System Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensityLibraryParameters`
- Intensity Library Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.VariableExitanceParameters`
- Spectrum Exit Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.ConstantExitanceParameters`
- Spectrum Exit Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.SurfaceSourceParameters`
- Parameters class for Surface Source.
* - :py:obj:`~ansys.speos.core.generic.parameters.AutomaticSunParameters`
- Automatic Sun Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.ManualSunParameters`
- Spectrum Exit Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.AmbientNaturalLightParameters`
- Ambient Natural Light Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.UserDefinedWhitePointParameters`
- User defined White Point Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.UserDefinedColorSpaceParameters`
- User defined Color Space Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.DisplayParameters`
- Parameters class for Display Source.
* - :py:obj:`~ansys.speos.core.generic.parameters.AmbientUniformParameters`
- Ambient Uniform Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.AmbientEnvironmentParameters`
- Ambient Environment Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.DirectSimulationParameters`
- Direct Simulation Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.InverseSimulationParameters`
- Inverse Simulation Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.InteractiveSimulationParameters`
- Interactive Simulation Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.SensorSamplingUnionParameters`
- Sensor Sampling Union Parameters used in virtual BSDF Simulation Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.VirtualBSDFSimulationParameters`
- Virtual BSDF Simulation Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.SopMirrorParameters`
- SOP Mirror Parameters Dataclass.
* - :py:obj:`~ansys.speos.core.generic.parameters.SopLibraryParameters`
- SOP Library Parameters Dataclass.
* - :py:obj:`~ansys.speos.core.generic.parameters.MeshData`
- Store named data on meshed Geometry.
* - :py:obj:`~ansys.speos.core.generic.parameters.CommonUVMappingParameters`
- Store all information needed to create a UV mapping.
* - :py:obj:`~ansys.speos.core.generic.parameters.UVMappingPlanarParameters`
- Planar uv mapping parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.UVMappingCubicParameters`
- Planar uv mapping parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.UVMappingSphericalParameters`
- Spherical uv mapping parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.UVMappingCylindricalParameters`
- Cylindrical uv mapping parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.UVMappingByData`
- Store mapping data when using custom mapping.
* - :py:obj:`~ansys.speos.core.generic.parameters.ImageTextureParameters`
- Parameters of an image based texture.
* - :py:obj:`~ansys.speos.core.generic.parameters.NormalMapParameters`
- Parameters of a normal map based texture.
* - :py:obj:`~ansys.speos.core.generic.parameters.TextureLayerParameters`
- Texture Layer Parameters Dataclass.
* - :py:obj:`~ansys.speos.core.generic.parameters.VopLibraryParameters`
- VOP Parameters Dataclass.
* - :py:obj:`~ansys.speos.core.generic.parameters.VopOpticParameters`
- Optics Material Parameters.
* - :py:obj:`~ansys.speos.core.generic.parameters.OptPropParameters`
- Store default values for optical properties.
.. tab-item:: Enums
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~ansys.speos.core.generic.parameters.LayerTypes`
- Layer Separation Types.
* - :py:obj:`~ansys.speos.core.generic.parameters.SCAFilteringTypes`
- Surface contribution analyser filtering types.
* - :py:obj:`~ansys.speos.core.generic.parameters.SequenceTypes`
- Sequence types to separate the sequence data.
* - :py:obj:`~ansys.speos.core.generic.parameters.PngBits`
- Bit resolution of create PNG image.
* - :py:obj:`~ansys.speos.core.generic.parameters.ColorBalanceModeTypes`
- Color Balance Mode Types.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntegrationTypes`
- Integration Types.
* - :py:obj:`~ansys.speos.core.generic.parameters.RayfileTypes`
- Rayfile Types.
* - :py:obj:`~ansys.speos.core.generic.parameters.SensorTypes`
- Sensor Types.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensitySensorOrientationTypes`
- Intensity sensor orientation types.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensitySensorViewingTypes`
- Intensity sensor viewing types.
* - :py:obj:`~ansys.speos.core.generic.parameters.SpectrumType`
- Spectrum Types.
* - :py:obj:`~ansys.speos.core.generic.parameters.IntensityOrientationType`
- Intensity Orientation Types.
* - :py:obj:`~ansys.speos.core.generic.parameters.WhitePointType`
- White Point Types.
* - :py:obj:`~ansys.speos.core.generic.parameters.ColorSpaceType`
- Color Space Types.
* - :py:obj:`~ansys.speos.core.generic.parameters.ColorimetricStandardTypes`
- Colorimetric Standard Types.
* - :py:obj:`~ansys.speos.core.generic.parameters.SopTypes`
- Allowed mapping types.
* - :py:obj:`~ansys.speos.core.generic.parameters.NormalMapTypes`
- Normal Map Types.
* - :py:obj:`~ansys.speos.core.generic.parameters.TextureTypes`
- Different texture types.
* - :py:obj:`~ansys.speos.core.generic.parameters.TextureNormalizationTypes`
- Texture normalization types.
* - :py:obj:`~ansys.speos.core.generic.parameters.VopTypes`
- Allowed mapping types.
.. toctree::
:titlesonly:
:maxdepth: 1
:hidden:
WavelengthsRangeParameters
DimensionsParameters
IntensitySensorDimensionsConoscopicParameters
IntensitySensorDimensionsXAsMeridianParameters
IntensitySensorDimensionsXAsParallelParameters
LayerBySequenceParameters
GeometryLayerParameters
LayerByFaceParameters
LayerByIncidenceAngleParameters
BalanceModeUserWhiteParameters
BalanceModeDisplayPrimariesParameters
ColorParameters
MonoChromaticParameters
PhotometricCameraParameters
CameraSensorParameters
ColorimetricParameters
SpectralParameters
MeasuresParameters
IrradianceSensorParameters
RadianceSensorParameters
Irradiance3DSensorParameters
NearfieldParameters
IntensityXMPSensorParameters
LuminousFluxParameters
RadiantFluxParameters
FluxFromFileParameters
SpectrumSampledParameters
SpectrumLibraryParameters
SpectrumBlackBodyParameters
LuminaireSourceParameters
SpectrumMonochromaticParameters
RayFileSourceParameters
IntensityFluxParameters
IntensityLambertianParameters
IntensityCosParameters
IntensitySymmetricGaussianParameters
IntensitAsymmetricGaussianParameters
IntensityOrientationAxisSystemParameters
IntensityLibraryParameters
VariableExitanceParameters
ConstantExitanceParameters
SurfaceSourceParameters
AutomaticSunParameters
ManualSunParameters
AmbientNaturalLightParameters
UserDefinedWhitePointParameters
UserDefinedColorSpaceParameters
DisplayParameters
AmbientUniformParameters
AmbientEnvironmentParameters
DirectSimulationParameters
InverseSimulationParameters
InteractiveSimulationParameters
SensorSamplingUnionParameters
VirtualBSDFSimulationParameters
SopMirrorParameters
SopLibraryParameters
MeshData
CommonUVMappingParameters
UVMappingPlanarParameters
UVMappingCubicParameters
UVMappingSphericalParameters
UVMappingCylindricalParameters
UVMappingByData
ImageTextureParameters
NormalMapParameters
TextureLayerParameters
VopLibraryParameters
VopOpticParameters
OptPropParameters
.. toctree::
:titlesonly:
:maxdepth: 1
:hidden:
LayerTypes
SCAFilteringTypes
SequenceTypes
PngBits
ColorBalanceModeTypes
IntegrationTypes
RayfileTypes
SensorTypes
IntensitySensorOrientationTypes
IntensitySensorViewingTypes
SpectrumType
IntensityOrientationType
WhitePointType
ColorSpaceType
ColorimetricStandardTypes
SopTypes
NormalMapTypes
TextureTypes
TextureNormalizationTypes
VopTypes
Description
-----------
Collection of all parameter dataclasses used in PySpeos.
..
!! processed by numpydoc !!