The `parameters.py` module#

Summary#

Classes

`WavelengthsRangeParameters`	Wavelength Parameters.
`DimensionsParameters`	Dimension Parameters.
`IntensitySensorDimensionsConoscopicParameters`	Dataclass for Intensity Sensor dimension in case of conoscopic.
`IntensitySensorDimensionsXAsMeridianParameters`	Dataclass for Intensity Sensor dimension in case of x_as_meridian.
`IntensitySensorDimensionsXAsParallelParameters`	Dataclass for Intensity Sensor dimension in case of x_as_parallel.
`LayerBySequenceParameters`	Layer separation type Parameters for Sequence separation.
`GeometryLayerParameters`	Geometry Layer Parameters.
`LayerByFaceParameters`	Layer separation type Parameters for Face separation.
`LayerByIncidenceAngleParameters`	Layer separation type Parameters for Incidence angle separation.
`BalanceModeUserWhiteParameters`	Parameters for Balance mode: User White.
`BalanceModeDisplayPrimariesParameters`	Parameters for Balance mode: Display primaries.
`ColorParameters`	Camera Color Mode Parameters.
`MonoChromaticParameters`	Monochromatic Camera Parameters.
`PhotometricCameraParameters`	Photometric Parameters for Camera.
`CameraSensorParameters`	Camera Sensor Parameters.
`ColorimetricParameters`	Colorimetric settings of the Sensor.
`SpectralParameters`	Colorimetric settings of the Sensor.
`MeasuresParameters`	Measurements for 3d Irradiance Sensor.
`IrradianceSensorParameters`	Irradiance Sensor Parameters.
`RadianceSensorParameters`	Radiance Sensor Constants.
`Irradiance3DSensorParameters`	Parameters class for 3D Irradiance Sensor.
`NearfieldParameters`	Parameters data class for Nearfield.
`IntensityXMPSensorParameters`	Intensity Sensor Parameters Dataclass.
`LuminousFluxParameters`	Luminous Flux Parameters.
`RadiantFluxParameters`	Radiant Flux Parameters.
`FluxFromFileParameters`	Flux from intensity file.
`SpectrumSampledParameters`	Spectrum Sampled Parameters.
`SpectrumLibraryParameters`	Spectrum Library Parameters.
`SpectrumBlackBodyParameters`	Spectrum Black Body Parameters.
`LuminaireSourceParameters`	Parameters class for Luminaire Source.
`SpectrumMonochromaticParameters`	Spectrum Monochromatic Parameters.
`RayFileSourceParameters`	Parameters class for Ray File Source.
`IntensityFluxParameters`	Luminous Flux Parameters.
`IntensityLambertianParameters`	Intensity Lambertian Parameters.
`IntensityCosParameters`	Intensity Cos Parameters.
`IntensitySymmetricGaussianParameters`	Intensity Symmetric Gaussian Parameters.
`IntensitAsymmetricGaussianParameters`	Intensity Asymmetric Gaussian Parameters.
`IntensityOrientationAxisSystemParameters`	Intensity Orientation Axis System Parameters.
`IntensityLibraryParameters`	Intensity Library Parameters.
`VariableExitanceParameters`	Spectrum Exit Parameters.
`ConstantExitanceParameters`	Spectrum Exit Parameters.
`SurfaceSourceParameters`	Parameters class for Surface Source.
`AutomaticSunParameters`	Automatic Sun Parameters.
`ManualSunParameters`	Spectrum Exit Parameters.
`AmbientNaturalLightParameters`	Ambient Natural Light Parameters.
`UserDefinedWhitePointParameters`	User defined White Point Parameters.
`UserDefinedColorSpaceParameters`	User defined Color Space Parameters.
`DisplayParameters`	Parameters class for Display Source.
`AmbientUniformParameters`	Ambient Uniform Parameters.
`AmbientEnvironmentParameters`	Ambient Environment Parameters.
`DirectSimulationParameters`	Direct Simulation Parameters.
`InverseSimulationParameters`	Inverse Simulation Parameters.
`InteractiveSimulationParameters`	Interactive Simulation Parameters.
`SensorSamplingUnionParameters`	Sensor Sampling Union Parameters used in virtual BSDF Simulation Parameters.
`VirtualBSDFSimulationParameters`	Virtual BSDF Simulation Parameters.
`SopMirrorParameters`	SOP Mirror Parameters Dataclass.
`SopLibraryParameters`	SOP Library Parameters Dataclass.
`MeshData`	Store named data on meshed Geometry.
`CommonUVMappingParameters`	Store all information needed to create a UV mapping.
`UVMappingPlanarParameters`	Planar uv mapping parameters.
`UVMappingCubicParameters`	Planar uv mapping parameters.
`UVMappingSphericalParameters`	Spherical uv mapping parameters.
`UVMappingCylindricalParameters`	Cylindrical uv mapping parameters.
`UVMappingByData`	Store mapping data when using custom mapping.
`ImageTextureParameters`	Parameters of an image based texture.
`NormalMapParameters`	Parameters of a normal map based texture.
`TextureLayerParameters`	Texture Layer Parameters Dataclass.
`VopLibraryParameters`	VOP Parameters Dataclass.
`VopOpticParameters`	Optics Material Parameters.
`OptPropParameters`	Store default values for optical properties.

Enums

`LayerTypes`	Layer Separation Types.
`SCAFilteringTypes`	Surface contribution analyser filtering types.
`SequenceTypes`	Sequence types to separate the sequence data.
`PngBits`	Bit resolution of create PNG image.
`ColorBalanceModeTypes`	Color Balance Mode Types.
`IntegrationTypes`	Integration Types.
`RayfileTypes`	Rayfile Types.
`SensorTypes`	Sensor Types.
`IntensitySensorOrientationTypes`	Intensity sensor orientation types.
`IntensitySensorViewingTypes`	Intensity sensor viewing types.
`SpectrumType`	Spectrum Types.
`IntensityOrientationType`	Intensity Orientation Types.
`WhitePointType`	White Point Types.
`ColorSpaceType`	Color Space Types.
`ColorimetricStandardTypes`	Colorimetric Standard Types.
`SopTypes`	Allowed mapping types.
`NormalMapTypes`	Normal Map Types.
`TextureTypes`	Different texture types.
`TextureNormalizationTypes`	Texture normalization types.
`VopTypes`	Allowed mapping types.

Description#

Collection of all parameter dataclasses used in PySpeos.