refactor: sensor

doc/changelog.d/691.miscellaneous.md

@@ -0,0 +1 @@
+Sensor

doc/source/cheat_sheet/cheat_sheet_script.qmd

@@ -212,13 +212,18 @@ from ansys.speos.core.sensor import SensorRadiance
 r_sensor = project.create_sensor(name='Radiance.1', feature_type=SensorRadiance)
 # define size
 dim = r_sensor.set_dimensions()
-dim.set_x_start(-5).set_x_end(5).set_x_sampling(10)
-dim.set_y_start(-5).set_y_end(5).set_y_sampling(10)
+dim.x_start = -5
+dim.x_end = 5
+dim.x_sampling = 10
+dim.y_start = -5
+dim.y_end = 5
+dim.y_sampling = 10
 # define type and Wavelength range
 col = r_sensor.set_type_colorimetric()
 wl = col.set_wavelengths_range()
-wl.set_start(380).set_end(780)
-wl.set_sampling(50)
+wl.start = 380
+wl.end = 780
+wl.sampling = 50
 # define Layer separation
 r_sensor.set_layer_type_source()
 r_sensor.commit()
@@ -246,12 +251,10 @@ c_sensor.set_distortion_file_uri(
     'distortion_file_path')
 # Choose photometric mode
 photo_cam = c_sensor.set_mode_photometric()
-photo_cam.set_transmittance_file_uri(
-    'transmittance_file_path')
+photo_cam.transmittance_file_uri = 'transmittance_file_path'
 # Choose color mode
 c_mode = photo_cam.set_mode_color()
-c_mode.set_blue_spectrum_file_uri(
-    'blue_spectrum_path')
+c_mode.blue_spectrum_file_uri = 'blue_spectrum_path'
 # same method for red and green spectrum
 c_sensor.commit()
 ```

examples/core/prism-example.py

@@ -93,14 +93,17 @@
 
 irr_features = p.find(name=".*", name_regex=True, feature_type=SensorIrradiance)
 irr = irr_features[0]
-irr.set_type_spectral().set_wavelengths_range().set_start(500).set_end(600).set_sampling(11)
+wl = irr.set_type_spectral().set_wavelengths_range()
+wl.start = 500
+wl.end = 600
+wl.sampling = 11
 irr.commit()
 
 # Create and add a new sensor, e.g. 3d irradiance sensor
 
 body = p.find(name="PrismBody", name_regex=True, feature_type=Body)[0]
 sensor_3d = p.create_sensor(name="3d_irradiance", feature_type=Sensor3DIrradiance)
-sensor_3d.set_geometries([body.geo_path])
+sensor_3d.geometries = [body.geo_path]
 sensor_3d.commit()
 sim.set_sensor_paths(["Irradiance.1:564", "3d_irradiance"])
 sim.commit()

examples/core/sensor.py

@@ -99,13 +99,14 @@ def create_face(body):
 red_spectrum_path = str(assets_data_path / FILES / "CameraSensitivityRed.spectrum")
 
 sensor1 = p.create_sensor(name="Camera.1", feature_type=SensorCamera)
-sensor1.set_distortion_file_uri(uri=distortion_file_path)
+sensor1.distortion_file_uri = distortion_file_path
 # Choose photometric mode
-sensor1.set_mode_photometric().set_transmittance_file_uri(uri=transmittance_file_path)
+sensor1.set_mode_photometric().transmittance_file_uri = transmittance_file_path
 # Choose color mode (will imply to give spectrum file for blue, green and red)
-sensor1.set_mode_photometric().set_mode_color().set_blue_spectrum_file_uri(uri=blue_spectrum_path)
-sensor1.set_mode_photometric().set_mode_color().set_green_spectrum_file_uri(uri=green_spectrum_path)
-sensor1.set_mode_photometric().set_mode_color().set_red_spectrum_file_uri(uri=red_spectrum_path)
+mode_color = sensor1.photometric.set_mode_color()
+mode_color.blue_spectrum_file_uri = blue_spectrum_path
+mode_color.green_spectrum_file_uri = green_spectrum_path
+mode_color.red_spectrum_file_uri = red_spectrum_path
 print(sensor1)
 # -
 
@@ -134,17 +135,19 @@ def create_face(body):
 red_spectrum_path = str(assets_data_path / FILES / "CameraSensitivityRed.spectrum")
 
 sensor2 = p.create_sensor(name="Camera.2", feature_type=SensorCamera)
-sensor2.set_distortion_file_uri(uri=distortion_file_path)
-sensor2.set_mode_photometric().set_transmittance_file_uri(uri=transmittance_file_path)
-sensor2.set_mode_photometric().set_layer_type_source()
-sensor2.set_mode_photometric().set_mode_color().set_blue_spectrum_file_uri(uri=blue_spectrum_path)
-sensor2.set_mode_photometric().set_mode_color().set_green_spectrum_file_uri(uri=green_spectrum_path)
-sensor2.set_mode_photometric().set_mode_color().set_red_spectrum_file_uri(uri=red_spectrum_path)
-sensor2.set_focal_length(5.5)
-sensor2.set_height(value=6).set_width(value=6)  # dimensions
-sensor2.set_axis_system(
-    [20, 10, 40, 1, 0, 0, 0, 1, 0, 0, 0, 1]
-)  # camera location [Origin, Xvector, Yvector, Zvector]
+sensor2.distortion_file_uri = distortion_file_path
+photometric = sensor2.set_mode_photometric()
+photometric.transmittance_file_uri = transmittance_file_path
+photometric.set_layer_type_source()
+color = photometric.set_mode_color()
+color.blue_spectrum_file_uri = blue_spectrum_path
+color.green_spectrum_file_uri = green_spectrum_path
+color.red_spectrum_file_uri = red_spectrum_path
+sensor2.focal_length = 5.5
+sensor2.height = 6
+sensor2.width = 6  # dimensions
+sensor2.axis_system = [20, 10, 40, 1, 0, 0, 0, 1, 0, 0, 0, 1]
+# camera location [Origin, Xvector, Yvector, Zvector]
 sensor2.commit()
 
 print(sensor2)
@@ -172,7 +175,8 @@ def create_face(body):
 # If you don't, you will still only watch what is committed on the server.
 
 # modify f number and axis system
-sensor1.set_f_number(value=11).set_axis_system([17, 10, 10, 1, 0, 0, 0, 1, 0, 0, 0, 1])
+sensor1.f_number = 11
+sensor1.axis_system = [17, 10, 10, 1, 0, 0, 0, 1, 0, 0, 0, 1]
 sensor1.commit()
 print(sensor1)
 
@@ -217,7 +221,8 @@ def create_face(body):
 sensor4.commit()
 print(sensor4)
 
-sensor4.set_focal(value=200).set_type_spectral()
+sensor4.focal = 200
+sensor4.set_type_spectral()
 sensor4.set_layer_type_source()
 sensor4.commit()
 print(sensor4)
@@ -229,7 +234,7 @@ def create_face(body):
 
 create_helper_geometries(p)
 sensor5 = p.create_sensor(name="3D_Irradiance.2", feature_type=Sensor3DIrradiance)
-sensor5.set_geometries([GeoRef.from_native_link("TheBodyB/TheFaceF")])
+sensor5.geometries = [GeoRef.from_native_link("TheBodyB/TheFaceF")]
 sensor5.commit()
 print(sensor5)
 

examples/workflow/combine-speos.py

@@ -113,18 +113,24 @@
 # ### Create a sensor
 
 ssr = p.create_sensor(name="Camera.1", feature_type=SensorCamera)
-ssr.set_distortion_file_uri(
-    uri=str(assets_data_path / "CameraInputFiles" / "CameraDistortion_190deg.OPTDistortion")
-).set_mode_photometric().set_transmittance_file_uri(
-    uri=str(assets_data_path / "CameraInputFiles" / "CameraTransmittance.spectrum")
-).set_mode_color().set_red_spectrum_file_uri(
-    uri=str(assets_data_path / "CameraInputFiles" / "CameraSensitivityRed.spectrum")
-).set_blue_spectrum_file_uri(
-    uri=str(assets_data_path / "CameraInputFiles" / "CameraSensitivityBlue.spectrum")
-).set_green_spectrum_file_uri(
-    uri=str(assets_data_path / "CameraInputFiles" / "CameraSensitivityGreen.spectrum")
+ssr.distortion_file_uri = str(
+    assets_data_path / "CameraInputFiles" / "CameraDistortion_190deg.OPTDistortion"
 )
-ssr.set_axis_system([-2000, 1500, 11000, -1, 0, 0, 0, 1, 0, 0, 0, -1])
+ssr.set_mode_photometric().transmittance_file_uri = str(
+    assets_data_path / "CameraInputFiles" / "CameraTransmittance.spectrum"
+)
+color_mode = ssr.set_mode_photometric().set_mode_color()
+color_mode.red_spectrum_file_uri = str(
+    assets_data_path / "CameraInputFiles" / "CameraSensitivityRed.spectrum"
+)
+color_mode.blue_spectrum_file_uri = str(
+    assets_data_path / "CameraInputFiles" / "CameraSensitivityBlue.spectrum"
+)
+color_mode.green_spectrum_file_uri = str(
+    assets_data_path / "CameraInputFiles" / "CameraSensitivityGreen.spectrum"
+)
+
+ssr.axis_system = [-2000, 1500, 11000, -1, 0, 0, 0, 1, 0, 0, 0, -1]
 ssr.commit()
 
 # ### Create a source
@@ -195,7 +201,7 @@
 # Modify the camera, e.g. focal length to 10
 
 cam1 = p.find(name="Camera.1", feature_type=SensorCamera)[0]
-cam1.set_focal_length(value=10)
+cam1.focal_length = 10
 cam1.commit()
 
 # Re-run the simulation and review result

src/ansys/speos/core/generic/constants.py

@@ -22,6 +22,7 @@
 
 """Collection of all constants used in pySpeos."""
 
+from dataclasses import dataclass
 import os
 
 DEFAULT_HOST: str = "localhost"
@@ -38,3 +39,93 @@
 """Maximum message Size accepted by grpc channel,
 By default, 4194304.
 """
+
+ORIGIN = [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1]
+"""Global Origin"""
+
+
+@dataclass(frozen=True)
+class WavelengthsRange:
+    """Wavelength constants."""
+
+    START = 400
+    """Wavelength start value."""
+    END = 700
+    """Wavelength end value."""
+    SAMPLING = 13
+    """Wavelength sampling."""
+
+
+@dataclass(frozen=True)
+class Dimensions:
+    """Dimension Constants."""
+
+    X_START = -50
+    """Lower bound x axis."""
+    X_END = 50
+    """Upper bound x axis."""
+    X_SAMPLING = 100
+    """Sampling x axis."""
+    Y_START = -50
+    """Lower bound y axis."""
+    Y_END = 50
+    """Upper bound y axis."""
+    Y_SAMPLING = 100
+    """Sampling y axis."""
+
+
+@dataclass(frozen=True)
+class LayerTypes:
+    """Layer Separation constants."""
+
+    MAXIMUM_NB_OF_SEQUENCE = 10
+    """Number of sequences stored in sensor."""
+    INCIDENCE_SAMPLING = 9
+    """Number of incidence sampling stored in sensor."""
+
+
+@dataclass(frozen=True)
+class CameraSensor:
+    """Camera Sensor Constants."""
+
+    GAIN = 1
+    """Default gain value of the Camera Sensor."""
+    ACQUISITION_INTEGRATION = 0.01
+    """Default integration Time value for the Camera Sensor."""
+    ACQUISITION_LAG_TIME = 0
+    """Default acquisition lag time for the Camera Sensor."""
+    GAMMA_CORRECTION = 2.2
+    """Default gamma correction Value for the Camera Sensor."""
+    FOCAL_LENGTH = 5
+    """Default focal length of the Camera Sensor."""
+    IMAGER_DISTANCE = 10
+    """Default imager distance of the camera sensor."""
+    F_NUMBER = 20
+    """Default f number of the camera sensor."""
+    HORZ_PIXEL = 640
+    """Default pixel number in horizontal direction."""
+    VERT_PIXEL = 480
+    """Default pixel number in vertical direction."""
+    WIDTH = 5.0
+    """Default width of the camera chip."""
+    HEIGHT = 5.0
+    """Default height of the camera chip."""
+
+
+@dataclass(frozen=True)
+class RadianceSensor:
+    """Radiance Sensor Constants."""
+
+    FOCAL_LENGTH = 250
+    INTEGRATION_ANGLE = 5
+
+
+@dataclass(frozen=True)
+class SENSOR:
+    """Constant class for Sensors."""
+
+    WAVELENGTHSRANGE = WavelengthsRange()
+    DIMENSIONS = Dimensions()
+    LAYERTYPES = LayerTypes()
+    CAMERASENSOR = CameraSensor()
+    RADIANCESENSOR = RadianceSensor()