0.1.22
Loading...
Searching...
No Matches
pyhelios.RadiationModel.SIFCameraProperties Class Reference

Camera properties for a solar-induced chlorophyll fluorescence (SIF) camera. More...

Detailed Description

Camera properties for a solar-induced chlorophyll fluorescence (SIF) camera.

Extends :class:CameraProperties with two SIF-specific fields used by the Fluspect-B emission pipeline introduced in helios-core v1.3.72. Image geometry, resolution, exposure, and spectral-response handling are inherited from :class:CameraProperties unchanged.

       excitation bands. ``0`` (default) treats every leaf hit as fully
       absorbed. Set to ``>=1`` to include inter-leaf scattering at the
       cost of additional excitation-band ray traces.
Note
String fields inherited from :class:CameraProperties (model, lens_make, lens_model, lens_specification, exposure, white_balance) are currently NOT plumbed through to the C++ camera — the wrapper hard-codes "generic" / "auto" defaults. Set them on this dataclass for self-documentation only; they will not affect rendering. This matches the existing addRadiationCamera behaviour.

Definition at line 275 of file RadiationModel.py.

+ Inheritance diagram for pyhelios.RadiationModel.SIFCameraProperties:
+ Collaboration diagram for pyhelios.RadiationModel.SIFCameraProperties:

Public Member Functions

 __init__ (self, float excitation_bin_width_nm=10.0, int excitation_scattering_depth=0, **kwargs)
 
 __repr__ (self)
 
- Public Member Functions inherited from pyhelios.RadiationModel.CameraProperties
 __init__ (self, camera_resolution=None, focal_plane_distance=1.0, lens_diameter=0.05, HFOV=20.0, FOV_aspect_ratio=0.0, lens_focal_length=0.05, sensor_width_mm=35.0, manufacturer="", model="generic", lens_make="", lens_model="", lens_specification="", exposure="auto", shutter_speed=1.0/125.0, white_balance="auto", camera_zoom=1.0)
 Initialize camera properties with defaults matching C++ CameraProperties.
 
 to_array (self)
 Convert to array format expected by C++ interface.
 
 __repr__ (self)
 

Public Attributes

 excitation_bin_width_nm = float(excitation_bin_width_nm)
 Excitation wavelength bin width in nm.
 
 excitation_scattering_depth = int(excitation_scattering_depth)
 Scattering depth for the auto-generated.
 
- Public Attributes inherited from pyhelios.RadiationModel.CameraProperties
 focal_plane_distance = float(focal_plane_distance)
 
 lens_diameter = float(lens_diameter)
 
 HFOV = float(HFOV)
 
 FOV_aspect_ratio = float(FOV_aspect_ratio)
 
 lens_focal_length = float(lens_focal_length)
 
 sensor_width_mm = float(sensor_width_mm)
 
 shutter_speed = float(shutter_speed)
 
 camera_zoom = float(camera_zoom)
 
 manufacturer = str(manufacturer)
 
 model = str(model)
 
 lens_make = str(lens_make)
 
 lens_model = str(lens_model)
 
 lens_specification = str(lens_specification)
 
 exposure = str(exposure)
 
 white_balance = str(white_balance)
 

Constructor & Destructor Documentation

◆ __init__()

pyhelios.RadiationModel.SIFCameraProperties.__init__ ( self,
float excitation_bin_width_nm = 10.0,
int excitation_scattering_depth = 0,
** kwargs )

Definition at line 287 of file RadiationModel.py.

Member Function Documentation

◆ __repr__()

pyhelios.RadiationModel.SIFCameraProperties.__repr__ ( self)

Definition at line 298 of file RadiationModel.py.

Member Data Documentation

◆ excitation_bin_width_nm

pyhelios.RadiationModel.SIFCameraProperties.excitation_bin_width_nm = float(excitation_bin_width_nm)

Excitation wavelength bin width in nm.

Helios

Definition at line 295 of file RadiationModel.py.

◆ excitation_scattering_depth

pyhelios.RadiationModel.SIFCameraProperties.excitation_scattering_depth = int(excitation_scattering_depth)

Scattering depth for the auto-generated.

Definition at line 296 of file RadiationModel.py.


The documentation for this class was generated from the following file: