0.1.8
Loading...
Searching...
No Matches
pyhelios.validation.plugin_decorators Namespace Reference

Functions

Callable validate_radiation_band_params (Callable func)
 Validate parameters for radiation band operations.
 
Callable validate_collimated_source_params (Callable func)
 Validate parameters for collimated radiation source creation.
 
Callable validate_sphere_source_params (Callable func)
 Validate parameters for sphere radiation source creation.
 
Callable validate_sun_sphere_params (Callable func)
 Validate parameters for sun sphere radiation source.
 
Callable validate_source_flux_multiple_params (Callable func)
 Validate parameters for setting multiple source flux.
 
Callable validate_get_source_flux_params (Callable func)
 Validate parameters for getting source flux.
 
Callable validate_update_geometry_params (Callable func)
 Validate parameters for geometry updates.
 
Callable validate_run_band_params (Callable func)
 Validate parameters for running radiation bands.
 
Callable validate_scattering_depth_params (Callable func)
 Validate parameters for scattering depth.
 
Callable validate_min_scatter_energy_params (Callable func)
 Validate parameters for minimum scatter energy.
 
Callable validate_tree_uuid_params (Callable func)
 Validate tree ID parameters for WeberPennTree methods.
 
Callable validate_recursion_params (Callable func)
 Validate recursion level parameters.
 
Callable validate_trunk_segment_params (Callable func)
 Validate trunk segment resolution parameters.
 
Callable validate_branch_segment_params (Callable func)
 Validate branch segment resolution parameters.
 
Callable validate_leaf_subdivisions_params (Callable func)
 Validate leaf subdivision parameters.
 
Callable validate_energy_run_params (Callable func)
 Validate parameters for energy balance run method.
 
Callable validate_energy_band_params (Callable func)
 Validate parameters for energy balance band operations.
 
Callable validate_air_energy_params (Callable func)
 Validate parameters for air energy balance.
 
Callable validate_evaluate_air_energy_params (Callable func)
 Validate parameters for evaluating air energy balance.
 
Callable validate_output_data_params (Callable func)
 Validate parameters for optional output data.
 
Callable validate_print_report_params (Callable func)
 Validate parameters for print report methods.
 
Callable validate_build_geometry_params (Callable func)
 Validate parameters for building visualizer geometry.
 
Callable validate_print_window_params (Callable func)
 Validate parameters for printing window to file.
 
Callable validate_photosynthesis_species_params (Callable func)
 Validate photosynthesis species parameters.
 
Callable validate_photosynthesis_temperature_params (Callable func)
 Validate temperature parameters for photosynthesis.
 
Callable validate_photosynthesis_co2_params (Callable func)
 Validate CO2 concentration parameters.
 
Callable validate_photosynthesis_par_params (Callable func)
 Validate PAR flux parameters.
 
Callable validate_photosynthesis_conductance_params (Callable func)
 Validate conductance parameters.
 
Callable validate_empirical_model_params (Callable func)
 Validate empirical model coefficient parameters.
 
Callable validate_farquhar_model_params (Callable func)
 Validate Farquhar model coefficient parameters.
 
Callable validate_vcmax_params (Callable func)
 Validate Vcmax parameters for Farquhar model.
 
Callable validate_jmax_params (Callable func)
 Validate Jmax parameters for Farquhar model.
 
Callable validate_quantum_efficiency_params (Callable func)
 Validate quantum efficiency parameters.
 
Callable validate_dark_respiration_params (Callable func)
 Validate dark respiration parameters.
 
Callable validate_oxygen_concentration_params (Callable func)
 Validate oxygen concentration parameters.
 
Callable validate_temperature_response_params (Callable func)
 Validate temperature response parameters.
 
Callable validate_photosynthesis_rate_params (Callable func)
 Validate photosynthetic rate parameters.
 
Callable validate_photosynthesis_uuid_params (Callable func)
 Validate UUID parameters for photosynthesis methods.
 
Callable validate_radiation_camera_params (Callable func)
 Validate parameters for addRadiationCamera method.
 

Function Documentation

◆ validate_air_energy_params()

Callable pyhelios.validation.plugin_decorators.validate_air_energy_params ( Callable func)

Validate parameters for air energy balance.

Definition at line 285 of file plugin_decorators.py.

◆ validate_branch_segment_params()

Callable pyhelios.validation.plugin_decorators.validate_branch_segment_params ( Callable func)

Validate branch segment resolution parameters.

Definition at line 202 of file plugin_decorators.py.

◆ validate_build_geometry_params()

Callable pyhelios.validation.plugin_decorators.validate_build_geometry_params ( Callable func)

Validate parameters for building visualizer geometry.

Definition at line 374 of file plugin_decorators.py.

◆ validate_collimated_source_params()

Callable pyhelios.validation.plugin_decorators.validate_collimated_source_params ( Callable func)

Validate parameters for collimated radiation source creation.

Definition at line 41 of file plugin_decorators.py.

◆ validate_dark_respiration_params()

Callable pyhelios.validation.plugin_decorators.validate_dark_respiration_params ( Callable func)

Validate dark respiration parameters.

Definition at line 506 of file plugin_decorators.py.

◆ validate_empirical_model_params()

Callable pyhelios.validation.plugin_decorators.validate_empirical_model_params ( Callable func)

Validate empirical model coefficient parameters.

Definition at line 461 of file plugin_decorators.py.

◆ validate_energy_band_params()

Callable pyhelios.validation.plugin_decorators.validate_energy_band_params ( Callable func)

Validate parameters for energy balance band operations.

Definition at line 234 of file plugin_decorators.py.

◆ validate_energy_run_params()

Callable pyhelios.validation.plugin_decorators.validate_energy_run_params ( Callable func)

Validate parameters for energy balance run method.

Definition at line 222 of file plugin_decorators.py.

◆ validate_evaluate_air_energy_params()

Callable pyhelios.validation.plugin_decorators.validate_evaluate_air_energy_params ( Callable func)

Validate parameters for evaluating air energy balance.

Definition at line 310 of file plugin_decorators.py.

◆ validate_farquhar_model_params()

Callable pyhelios.validation.plugin_decorators.validate_farquhar_model_params ( Callable func)

Validate Farquhar model coefficient parameters.

Definition at line 470 of file plugin_decorators.py.

◆ validate_get_source_flux_params()

Callable pyhelios.validation.plugin_decorators.validate_get_source_flux_params ( Callable func)

Validate parameters for getting source flux.

Definition at line 91 of file plugin_decorators.py.

◆ validate_jmax_params()

Callable pyhelios.validation.plugin_decorators.validate_jmax_params ( Callable func)

Validate Jmax parameters for Farquhar model.

Definition at line 488 of file plugin_decorators.py.

◆ validate_leaf_subdivisions_params()

Callable pyhelios.validation.plugin_decorators.validate_leaf_subdivisions_params ( Callable func)

Validate leaf subdivision parameters.

Definition at line 211 of file plugin_decorators.py.

◆ validate_min_scatter_energy_params()

Callable pyhelios.validation.plugin_decorators.validate_min_scatter_energy_params ( Callable func)

Validate parameters for minimum scatter energy.

Definition at line 164 of file plugin_decorators.py.

◆ validate_output_data_params()

Callable pyhelios.validation.plugin_decorators.validate_output_data_params ( Callable func)

Validate parameters for optional output data.

Definition at line 335 of file plugin_decorators.py.

◆ validate_oxygen_concentration_params()

Callable pyhelios.validation.plugin_decorators.validate_oxygen_concentration_params ( Callable func)

Validate oxygen concentration parameters.

Definition at line 515 of file plugin_decorators.py.

◆ validate_photosynthesis_co2_params()

Callable pyhelios.validation.plugin_decorators.validate_photosynthesis_co2_params ( Callable func)

Validate CO2 concentration parameters.

Definition at line 434 of file plugin_decorators.py.

◆ validate_photosynthesis_conductance_params()

Callable pyhelios.validation.plugin_decorators.validate_photosynthesis_conductance_params ( Callable func)

Validate conductance parameters.

Definition at line 452 of file plugin_decorators.py.

◆ validate_photosynthesis_par_params()

Callable pyhelios.validation.plugin_decorators.validate_photosynthesis_par_params ( Callable func)

Validate PAR flux parameters.

Definition at line 443 of file plugin_decorators.py.

◆ validate_photosynthesis_rate_params()

Callable pyhelios.validation.plugin_decorators.validate_photosynthesis_rate_params ( Callable func)

Validate photosynthetic rate parameters.

Definition at line 533 of file plugin_decorators.py.

◆ validate_photosynthesis_species_params()

Callable pyhelios.validation.plugin_decorators.validate_photosynthesis_species_params ( Callable func)

Validate photosynthesis species parameters.

Definition at line 416 of file plugin_decorators.py.

◆ validate_photosynthesis_temperature_params()

Callable pyhelios.validation.plugin_decorators.validate_photosynthesis_temperature_params ( Callable func)

Validate temperature parameters for photosynthesis.

Definition at line 425 of file plugin_decorators.py.

◆ validate_photosynthesis_uuid_params()

Callable pyhelios.validation.plugin_decorators.validate_photosynthesis_uuid_params ( Callable func)

Validate UUID parameters for photosynthesis methods.

Definition at line 542 of file plugin_decorators.py.

◆ validate_print_report_params()

Callable pyhelios.validation.plugin_decorators.validate_print_report_params ( Callable func)

Validate parameters for print report methods.

Definition at line 363 of file plugin_decorators.py.

◆ validate_print_window_params()

Callable pyhelios.validation.plugin_decorators.validate_print_window_params ( Callable func)

Validate parameters for printing window to file.

Definition at line 405 of file plugin_decorators.py.

◆ validate_quantum_efficiency_params()

Callable pyhelios.validation.plugin_decorators.validate_quantum_efficiency_params ( Callable func)

Validate quantum efficiency parameters.

Definition at line 497 of file plugin_decorators.py.

◆ validate_radiation_band_params()

Callable pyhelios.validation.plugin_decorators.validate_radiation_band_params ( Callable func)

Validate parameters for radiation band operations.

Definition at line 31 of file plugin_decorators.py.

◆ validate_radiation_camera_params()

Callable pyhelios.validation.plugin_decorators.validate_radiation_camera_params ( Callable func)

Validate parameters for addRadiationCamera method.

Handles validation and type conversion for camera creation parameters:

  • camera_label: string validation
  • band_labels: list of strings validation
  • position: converts lists/tuples to vec3 if needed
  • lookat_or_direction: handles vec3 or SphericalCoord
  • antialiasing_samples: positive integer validation

Definition at line 574 of file plugin_decorators.py.

◆ validate_recursion_params()

Callable pyhelios.validation.plugin_decorators.validate_recursion_params ( Callable func)

Validate recursion level parameters.

Definition at line 184 of file plugin_decorators.py.

◆ validate_run_band_params()

Callable pyhelios.validation.plugin_decorators.validate_run_band_params ( Callable func)

Validate parameters for running radiation bands.

Definition at line 111 of file plugin_decorators.py.

◆ validate_scattering_depth_params()

Callable pyhelios.validation.plugin_decorators.validate_scattering_depth_params ( Callable func)

Validate parameters for scattering depth.

Definition at line 144 of file plugin_decorators.py.

◆ validate_source_flux_multiple_params()

Callable pyhelios.validation.plugin_decorators.validate_source_flux_multiple_params ( Callable func)

Validate parameters for setting multiple source flux.

Definition at line 80 of file plugin_decorators.py.

◆ validate_sphere_source_params()

Callable pyhelios.validation.plugin_decorators.validate_sphere_source_params ( Callable func)

Validate parameters for sphere radiation source creation.

Definition at line 54 of file plugin_decorators.py.

◆ validate_sun_sphere_params()

Callable pyhelios.validation.plugin_decorators.validate_sun_sphere_params ( Callable func)

Validate parameters for sun sphere radiation source.

Definition at line 64 of file plugin_decorators.py.

◆ validate_temperature_response_params()

Callable pyhelios.validation.plugin_decorators.validate_temperature_response_params ( Callable func)

Validate temperature response parameters.

Definition at line 524 of file plugin_decorators.py.

◆ validate_tree_uuid_params()

Callable pyhelios.validation.plugin_decorators.validate_tree_uuid_params ( Callable func)

Validate tree ID parameters for WeberPennTree methods.

Definition at line 175 of file plugin_decorators.py.

◆ validate_trunk_segment_params()

Callable pyhelios.validation.plugin_decorators.validate_trunk_segment_params ( Callable func)

Validate trunk segment resolution parameters.

Definition at line 193 of file plugin_decorators.py.

◆ validate_update_geometry_params()

Callable pyhelios.validation.plugin_decorators.validate_update_geometry_params ( Callable func)

Validate parameters for geometry updates.

Definition at line 101 of file plugin_decorators.py.

◆ validate_vcmax_params()

Callable pyhelios.validation.plugin_decorators.validate_vcmax_params ( Callable func)

Validate Vcmax parameters for Farquhar model.

Definition at line 479 of file plugin_decorators.py.