SensorEOIRBand#

class ansys.stk.core.stkobjects.SensorEOIRBand#: Class defining an EOIR band.

Overview#

Properties

`band_name`	Get or set the name of the band.
`render_band`	Band render flag.
`calculating_parameters`	Flag to set if input parameters are currently being calculated and entered into the object model.
`horizontal_half_angle`	Half the horizontal angular extent of the rectangular EOIR sensor bands field-of-view.
`vertical_half_angle`	Half the vertical angular extent of the rectangular EOIR sensor bands field-of-view.
`horizontal_pixels`	Get or set the number of pixels or samples distributed evenly across the horizontal dimension of the rectangular EOIR sensor bands focal plane.
`number_of_vertical_pixels`	Get or set the number of pixels or samples distributed evenly across the vertical dimension of the rectangular EOIR sensor bands focal plane.
`horizontal_pixel_spacing`	Get or set the spacing between pixels or samples along the horizontal dimension of the rectangular EOIR sensor bands focal plane.
`vertical_pixel_spacing`	Get or set the spacing between pixels or samples along the vertical dimension of the rectangular EOIR sensor bands focal plane.
`horizontal_individual_field_of_view`	Get the horizontal angular extent of a single individual pixels field-of-view for this sensor band.
`vertical_extent_of_individual_pixel_field_of_view`	Get the vertical angular extent of a single individual pixels field-of-view for this sensor band.
`low_band_edge_wavelength`	Get or set the cut-on spectral wavelength of the current sensor band at least one nanometer less than the cut-off value.
`high_band_edge_wavelength`	Get or set the cut-off spectral wavelength of the current sensor band at least one nanometer greater than the cut-on value.
`number_of_intervals`	Get or set the number of oversampled spectral intervals to discretely simulate for this sensor band.
`f_number`	Get or set the F-Number ratio of the system, the effective focal length divided by the clear aperture diameter for this sensor band.
`long_d_focus`	Get or set the amount of defocus along the optical axis between the ideal image focal plane and the actual detector focal plane for the current sensor band.
`effective_focal_length`	Get or set the effective focal length of the current sensor band.
`image_quality`	Discrete level of optical image quality. Aberrations are modeled based on a RMS wavefront error.
`entrance_prescription_diameter`	Diameter of the single lens equivalent optical prescription.
`wavelength`	Get or set the wavelength in the sensors spectral band to use for diffraction modeling calculations.
`wavelength_type`	Get or set the relative position within the sensors spectral band to use as the reference wavelength for diffraction modeling calculations.
`integration_time`	Get or set the time interval over which radiant signal is collected before generating an image.
`saturation_mode`	Get or set the radiant energy units for saturation and sensitivity, Irradiance better suited for observing point sources or Radiance better suited for resolved images.
`dynamic_range`	Get the ratio of the brightest signal to the noise floor.
`dynamic_range_mode`	Unlimited allowing pixels to measure any amount of radiant signal without limit or Simulate Saturation where pixels can only measure up to the specified saturation level of radiant signal.
`noise_equivalent_irradiance`	Noise equivalent irradiance or radiance for the current sensor band.
`saturation_equivalent_irradiance`	Saturation equivalent irradiance or radiance for the current sensor band.
`sensitivities`	Get the collection of Sensitivity time-value pairs.
`saturations`	Get the collection of Saturation time-value pairs.
`spatial_input_mode`	Spatial parameter input mode.
`spectral_shape`	Overall system spectral shape designation.
`system_relative_spectral_response_filename`	System relative spectral response file.
`rsr_units`	System custom RSR units.
`optical_input_mode`	Optical parameter input mode.
`root_mean_squared_wavefront_error`	Get or set the RMS wavefront error of the optical system.
`optical_quality_data_filename`	Optical quality describing data file.
`optical_transmission_mode`	Optical transmission input mode.
`optical_transmission`	Band effective optical transmission.
`optical_transmission_spectral_response_filename`	Optical spectral transmission data file.
`optical_quality_data_file_spatial_sampling`	Optical quality data file spatial sampling.
`optical_quality_data_file_frequency_sampling`	Optical quality data file frequency sampling.
`radiometric_parameter_level`	Radiometric parameter input level.
`simulate_quantization`	Simulate quantization effects of the sensor.
`quantum_efficiency_mode`	Quantum efficiency input mode.
`quantization_mode`	Quantization input mode.
`quantum_efficiency_value`	Band effective detector quantum efficiency.
`detector_fill_factor`	Get or set the effective fill factor of photosensitive surface area to the total detector surface area.
`read_noise`	Get or set the read noise from the detectors in electrons.
`dark_current`	Get or set the dark current noise rate from the detectors in electrons-per-second-per-detector.
`detector_full_well_capacity`	Get or set the full-well capacity of the detectors in electrons-per-detector.
`bit_depth`	Get or set the number of bits to encode the digital signal with.
`quantization_step_size`	Get or set the quantization step size of the digital output signal.
`quantum_efficiency_filename`	Spectral quantum efficiency data file for the detectors.
`spatial_auto_rebalance`	Spatial parameter auto rebalance.
`optical_automatic_rebalance`	Spatial parameter auto rebalance.

Import detail#

from ansys.stk.core.stkobjects import SensorEOIRBand

Property detail#

property SensorEOIRBand.band_name: str#: Get or set the name of the band.

property SensorEOIRBand.render_band: bool#: Band render flag.

property SensorEOIRBand.calculating_parameters: bool#: Flag to set if input parameters are currently being calculated and entered into the object model.

property SensorEOIRBand.horizontal_half_angle: Any#: Half the horizontal angular extent of the rectangular EOIR sensor bands field-of-view.

property SensorEOIRBand.vertical_half_angle: Any#: Half the vertical angular extent of the rectangular EOIR sensor bands field-of-view.

property SensorEOIRBand.horizontal_pixels: float#: Get or set the number of pixels or samples distributed evenly across the horizontal dimension of the rectangular EOIR sensor bands focal plane.

property SensorEOIRBand.number_of_vertical_pixels: float#: Get or set the number of pixels or samples distributed evenly across the vertical dimension of the rectangular EOIR sensor bands focal plane.

property SensorEOIRBand.horizontal_pixel_spacing: float#: Get or set the spacing between pixels or samples along the horizontal dimension of the rectangular EOIR sensor bands focal plane.

property SensorEOIRBand.vertical_pixel_spacing: float#: Get or set the spacing between pixels or samples along the vertical dimension of the rectangular EOIR sensor bands focal plane.

property SensorEOIRBand.horizontal_individual_field_of_view: float#: Get the horizontal angular extent of a single individual pixels field-of-view for this sensor band.

property SensorEOIRBand.vertical_extent_of_individual_pixel_field_of_view: float#: Get the vertical angular extent of a single individual pixels field-of-view for this sensor band.

property SensorEOIRBand.low_band_edge_wavelength: float#: Get or set the cut-on spectral wavelength of the current sensor band at least one nanometer less than the cut-off value.

property SensorEOIRBand.high_band_edge_wavelength: float#: Get or set the cut-off spectral wavelength of the current sensor band at least one nanometer greater than the cut-on value.

property SensorEOIRBand.number_of_intervals: int#: Get or set the number of oversampled spectral intervals to discretely simulate for this sensor band.

property SensorEOIRBand.f_number: float#: Get or set the F-Number ratio of the system, the effective focal length divided by the clear aperture diameter for this sensor band.

property SensorEOIRBand.long_d_focus: float#: Get or set the amount of defocus along the optical axis between the ideal image focal plane and the actual detector focal plane for the current sensor band.

property SensorEOIRBand.effective_focal_length: float#: Get or set the effective focal length of the current sensor band.

property SensorEOIRBand.image_quality: SensorEOIRBandImageQuality#: Discrete level of optical image quality. Aberrations are modeled based on a RMS wavefront error.

property SensorEOIRBand.entrance_prescription_diameter: float#: Diameter of the single lens equivalent optical prescription.

property SensorEOIRBand.wavelength: float#: Get or set the wavelength in the sensors spectral band to use for diffraction modeling calculations.

property SensorEOIRBand.wavelength_type: SensorEOIRBandWavelengthType#: Get or set the relative position within the sensors spectral band to use as the reference wavelength for diffraction modeling calculations.

property SensorEOIRBand.integration_time: float#: Get or set the time interval over which radiant signal is collected before generating an image.

property SensorEOIRBand.saturation_mode: SensorEOIRBandSaturationMode#: Get or set the radiant energy units for saturation and sensitivity, Irradiance better suited for observing point sources or Radiance better suited for resolved images.

property SensorEOIRBand.dynamic_range: float#: Get the ratio of the brightest signal to the noise floor.

property SensorEOIRBand.dynamic_range_mode: bool#: Unlimited allowing pixels to measure any amount of radiant signal without limit or Simulate Saturation where pixels can only measure up to the specified saturation level of radiant signal.

property SensorEOIRBand.noise_equivalent_irradiance: float#: Noise equivalent irradiance or radiance for the current sensor band.

property SensorEOIRBand.saturation_equivalent_irradiance: float#: Saturation equivalent irradiance or radiance for the current sensor band.

property SensorEOIRBand.sensitivities: SensorEOIRSensitivityCollection#: Get the collection of Sensitivity time-value pairs.

property SensorEOIRBand.saturations: SensorEOIRSaturationCollection#: Get the collection of Saturation time-value pairs.

property SensorEOIRBand.spatial_input_mode: SensorEOIRBandSpatialInputMode#: Spatial parameter input mode.

property SensorEOIRBand.spectral_shape: SensorEOIRBandSpectralShape#: Overall system spectral shape designation.

property SensorEOIRBand.system_relative_spectral_response_filename: str#: System relative spectral response file.

property SensorEOIRBand.rsr_units: SensorEOIRBandSpectralRelativeSystemResponseUnitsType#: System custom RSR units.

property SensorEOIRBand.optical_input_mode: SensorEOIRBandOpticalInputMode#: Optical parameter input mode.

property SensorEOIRBand.root_mean_squared_wavefront_error: float#: Get or set the RMS wavefront error of the optical system.

property SensorEOIRBand.optical_quality_data_filename: str#: Optical quality describing data file.

property SensorEOIRBand.optical_transmission_mode: SensorEOIRBandOpticalTransmissionMode#: Optical transmission input mode.

property SensorEOIRBand.optical_transmission: float#: Band effective optical transmission.

property SensorEOIRBand.optical_transmission_spectral_response_filename: str#: Optical spectral transmission data file.

property SensorEOIRBand.optical_quality_data_file_spatial_sampling: float#: Optical quality data file spatial sampling.

property SensorEOIRBand.optical_quality_data_file_frequency_sampling: float#: Optical quality data file frequency sampling.

property SensorEOIRBand.radiometric_parameter_level: SensorEOIRBandRadiometricParameterLevelType#: Radiometric parameter input level.

property SensorEOIRBand.simulate_quantization: bool#: Simulate quantization effects of the sensor.

property SensorEOIRBand.quantum_efficiency_mode: SensorEOIRBandQuantumEfficiencyMode#: Quantum efficiency input mode.

property SensorEOIRBand.quantization_mode: SensorEOIRBandQuantizationMode#: Quantization input mode.

property SensorEOIRBand.quantum_efficiency_value: float#: Band effective detector quantum efficiency.

property SensorEOIRBand.detector_fill_factor: float#: Get or set the effective fill factor of photosensitive surface area to the total detector surface area.

property SensorEOIRBand.read_noise: float#: Get or set the read noise from the detectors in electrons.

property SensorEOIRBand.dark_current: float#: Get or set the dark current noise rate from the detectors in electrons-per-second-per-detector.

property SensorEOIRBand.detector_full_well_capacity: float#: Get or set the full-well capacity of the detectors in electrons-per-detector.

property SensorEOIRBand.bit_depth: int#: Get or set the number of bits to encode the digital signal with.

property SensorEOIRBand.quantization_step_size: float#: Get or set the quantization step size of the digital output signal.

property SensorEOIRBand.quantum_efficiency_filename: str#: Spectral quantum efficiency data file for the detectors.

property SensorEOIRBand.spatial_auto_rebalance: bool#: Spatial parameter auto rebalance.

property SensorEOIRBand.optical_automatic_rebalance: bool#: Spatial parameter auto rebalance.