pyhelios.validation.plugins Namespace Reference

Functions
	validate_wavelength_range (float wavelength_min, float wavelength_max, str param_name_min="wavelength_min", str param_name_max="wavelength_max", str function_name=None)
	Validate wavelength range for radiation modeling.
	validate_flux_value (float flux, str param_name="flux", str function_name=None)
	Validate radiation flux value.
	validate_ray_count (int count, str param_name="ray_count", str function_name=None)
	Validate ray count for radiation simulations.
	validate_direction_vector (Any direction, str param_name="direction", str function_name=None)
	Validate direction vector for radiation sources.
	validate_band_label (str label, str param_name="band_label", str function_name=None)
	Validate radiation band label.
	validate_source_id (int source_id, str param_name="source_id", str function_name=None)
	Validate radiation source ID.
	validate_source_id_list (List[int] source_ids, str param_name="source_ids", str function_name=None)
	Validate list of radiation source IDs.
	validate_wpt_parameters (float scale_factor=1.0, int recursion_level=5, int segment_resolution=10, str param_prefix="WPT")
	Validate WeberPennTree generation parameters.
	validate_time_value (Any time_val, str param_name="time", str function_name=None)
	Validate time values for energy balance calculations.
	validate_physical_quantity (Any value, str quantity_name, str expected_units=None, float min_val=None, float max_val=None, str param_name=None, str function_name=None)
	Validate physical quantity values with optional range checking.
	validate_tree_id (Any tree_id, str param_name="tree_id", str function_name=None)
	Validate WeberPennTree tree ID.
	validate_segment_resolution (Any resolution, int min_val=3, int max_val=100, str param_name="resolution", str function_name=None)
	Validate segment resolution parameters for tree generation.
	validate_angle_degrees (Any angle, str param_name="angle", str function_name=None)
	Validate angle values in degrees.
	validate_scaling_factor (Any scale, float min_val=0.001, float max_val=1000.0, str param_name="scaling_factor", str function_name=None)
	Validate scaling factor parameters.
	validate_filename (Any filename, str param_name="filename", str function_name=None, List[str] allowed_extensions=None)
	Validate filename parameters for file operations.
	validate_uuid_list (Any uuids, str param_name="uuids", str function_name=None, bool allow_empty=False)
	Validate UUID list parameters.
	validate_positive_integer_range (Any value, int min_val=1, int max_val=50, str param_name="value", str function_name=None)
	Validate positive integer within a specified range.
	validate_recursion_level (Any level, str param_name="recursion_level", str function_name=None)
	Validate recursion level for tree generation.
	validate_subdivision_count (Any count, str param_name="subdivision_count", str function_name=None)
	Validate subdivision count parameters.
	validate_species_name (Any species, str param_name="species", str function_name=None)
	Validate species name for photosynthesis library.
	validate_temperature (Any temperature, str param_name="temperature", str function_name=None)
	Validate temperature values for photosynthesis calculations.
	validate_co2_concentration (Any co2, str param_name="co2_concentration", str function_name=None)
	Validate CO2 concentration values for photosynthesis calculations.
	validate_photosynthetic_rate (Any rate, str param_name="photosynthetic_rate", str function_name=None)
	Validate photosynthetic rate values.
	validate_conductance (Any conductance, str param_name="conductance", str function_name=None)
	Validate conductance values for photosynthesis calculations.
	validate_par_flux (Any par_flux, str param_name="PAR_flux", str function_name=None)
	Validate PAR flux values for photosynthesis calculations.
	validate_empirical_coefficients (Any coefficients, str param_name="coefficients", str function_name=None)
	Validate empirical model coefficients array or dataclass.
	validate_farquhar_coefficients (Any coefficients, str param_name="coefficients", str function_name=None)
	Validate Farquhar model coefficients array or dataclass.
	validate_vcmax (Any vcmax, str param_name="Vcmax", str function_name=None)
	Validate maximum carboxylation rate (Vcmax) parameter.
	validate_jmax (Any jmax, str param_name="Jmax", str function_name=None)
	Validate maximum electron transport rate (Jmax) parameter.
	validate_quantum_efficiency (Any alpha, str param_name="alpha", str function_name=None)
	Validate quantum efficiency (alpha) parameter.
	validate_dark_respiration (Any rd, str param_name="Rd", str function_name=None)
	Validate dark respiration rate (Rd) parameter.
	validate_oxygen_concentration (Any o2, str param_name="oxygen", str function_name=None)
	Validate oxygen concentration for photosynthesis calculations.
	validate_temperature_response_params (Any value_at_25c, Any dha=None, Any topt=None, Any dhd=None, str param_prefix="", str function_name=None)
	Validate temperature response parameters for photosynthetic processes.
str	validate_camera_label (str label, str param_name="camera_label", str function_name=None)
	Validate camera label for radiation camera operations.
List[str]	validate_band_labels_list (List[str] band_labels, str param_name="band_labels", str function_name=None)
	Validate list of band labels for camera operations.
int	validate_antialiasing_samples (int samples, str param_name="antialiasing_samples", str function_name=None)
	Validate antialiasing samples count.

Function Documentation

validate_angle_degrees()

pyhelios.validation.plugins.validate_angle_degrees	(	Any	angle,
		str	param_name = "angle",
		str	function_name = None )

Validate angle values in degrees.

Definition at line 387 of file plugins.py.

validate_antialiasing_samples()

int pyhelios.validation.plugins.validate_antialiasing_samples	(	int	samples,
		str	param_name = "antialiasing_samples",
		str	function_name = None )

Validate antialiasing samples count.

Definition at line 939 of file plugins.py.

validate_band_label()

pyhelios.validation.plugins.validate_band_label	(	str	label,
		str	param_name = "band_label",
		str	function_name = None )

Validate radiation band label.

Definition at line 137 of file plugins.py.

validate_band_labels_list()

List[str] pyhelios.validation.plugins.validate_band_labels_list	(	List[str]	band_labels,
		str	param_name = "band_labels",
		str	function_name = None )

Validate list of band labels for camera operations.

Definition at line 890 of file plugins.py.

validate_camera_label()

str pyhelios.validation.plugins.validate_camera_label	(	str	label,
		str	param_name = "camera_label",
		str	function_name = None )

Validate camera label for radiation camera operations.

Definition at line 865 of file plugins.py.

validate_co2_concentration()

pyhelios.validation.plugins.validate_co2_concentration	(	Any	co2,
		str	param_name = "co2_concentration",
		str	function_name = None )

Validate CO2 concentration values for photosynthesis calculations.

Definition at line 609 of file plugins.py.

validate_conductance()

pyhelios.validation.plugins.validate_conductance	(	Any	conductance,
		str	param_name = "conductance",
		str	function_name = None )

Validate conductance values for photosynthesis calculations.

Definition at line 635 of file plugins.py.

validate_dark_respiration()

pyhelios.validation.plugins.validate_dark_respiration	(	Any	rd,
		str	param_name = "Rd",
		str	function_name = None )

Validate dark respiration rate (Rd) parameter.

Definition at line 788 of file plugins.py.

validate_direction_vector()

pyhelios.validation.plugins.validate_direction_vector	(	Any	direction,
		str	param_name = "direction",
		str	function_name = None )

Validate direction vector for radiation sources.

Definition at line 119 of file plugins.py.

validate_empirical_coefficients()

pyhelios.validation.plugins.validate_empirical_coefficients	(	Any	coefficients,
		str	param_name = "coefficients",
		str	function_name = None )

Validate empirical model coefficients array or dataclass.

Definition at line 661 of file plugins.py.

validate_farquhar_coefficients()

pyhelios.validation.plugins.validate_farquhar_coefficients	(	Any	coefficients,
		str	param_name = "coefficients",
		str	function_name = None )

Validate Farquhar model coefficients array or dataclass.

Definition at line 699 of file plugins.py.

validate_filename()

pyhelios.validation.plugins.validate_filename	(	Any	filename,
		str	param_name = "filename",
		str	function_name = None,
		List[str]	allowed_extensions = None )

Validate filename parameters for file operations.

Definition at line 437 of file plugins.py.

validate_flux_value()

pyhelios.validation.plugins.validate_flux_value	(	float	flux,
		str	param_name = "flux",
		str	function_name = None )

Validate radiation flux value.

Definition at line 63 of file plugins.py.

validate_jmax()

pyhelios.validation.plugins.validate_jmax	(	Any	jmax,
		str	param_name = "Jmax",
		str	function_name = None )

Validate maximum electron transport rate (Jmax) parameter.

Definition at line 754 of file plugins.py.

validate_oxygen_concentration()

pyhelios.validation.plugins.validate_oxygen_concentration	(	Any	o2,
		str	param_name = "oxygen",
		str	function_name = None )

Validate oxygen concentration for photosynthesis calculations.

Definition at line 805 of file plugins.py.

validate_par_flux()

pyhelios.validation.plugins.validate_par_flux	(	Any	par_flux,
		str	param_name = "PAR_flux",
		str	function_name = None )

Validate PAR flux values for photosynthesis calculations.

Definition at line 648 of file plugins.py.

validate_photosynthetic_rate()

pyhelios.validation.plugins.validate_photosynthetic_rate	(	Any	rate,
		str	param_name = "photosynthetic_rate",
		str	function_name = None )

Validate photosynthetic rate values.

Definition at line 622 of file plugins.py.

validate_physical_quantity()

pyhelios.validation.plugins.validate_physical_quantity	(	Any	value,
		str	quantity_name,
		str	expected_units = None,
		float	min_val = None,
		float	max_val = None,
		str	param_name = None,
		str	function_name = None )

Validate physical quantity values with optional range checking.

Definition at line 299 of file plugins.py.

validate_positive_integer_range()

pyhelios.validation.plugins.validate_positive_integer_range	(	Any	value,
		int	min_val = 1,
		int	max_val = 50,
		str	param_name = "value",
		str	function_name = None )

Validate positive integer within a specified range.

Definition at line 531 of file plugins.py.

validate_quantum_efficiency()

pyhelios.validation.plugins.validate_quantum_efficiency	(	Any	alpha,
		str	param_name = "alpha",
		str	function_name = None )

Validate quantum efficiency (alpha) parameter.

Definition at line 771 of file plugins.py.

validate_ray_count()

pyhelios.validation.plugins.validate_ray_count	(	int	count,
		str	param_name = "ray_count",
		str	function_name = None )

Validate ray count for radiation simulations.

Definition at line 86 of file plugins.py.

validate_recursion_level()

pyhelios.validation.plugins.validate_recursion_level	(	Any	level,
		str	param_name = "recursion_level",
		str	function_name = None )

Validate recursion level for tree generation.

Definition at line 555 of file plugins.py.

validate_scaling_factor()

pyhelios.validation.plugins.validate_scaling_factor	(	Any	scale,
		float	min_val = 0.001,
		float	max_val = 1000.0,
		str	param_name = "scaling_factor",
		str	function_name = None )

Validate scaling factor parameters.

Definition at line 403 of file plugins.py.

validate_segment_resolution()

pyhelios.validation.plugins.validate_segment_resolution	(	Any	resolution,
		int	min_val = 3,
		int	max_val = 100,
		str	param_name = "resolution",
		str	function_name = None )

Validate segment resolution parameters for tree generation.

Definition at line 363 of file plugins.py.

validate_source_id()

pyhelios.validation.plugins.validate_source_id	(	int	source_id,
		str	param_name = "source_id",
		str	function_name = None )

Validate radiation source ID.

Definition at line 160 of file plugins.py.

validate_source_id_list()

pyhelios.validation.plugins.validate_source_id_list	(	List[int]	source_ids,
		str	param_name = "source_ids",
		str	function_name = None )

Validate list of radiation source IDs.

Definition at line 183 of file plugins.py.

validate_species_name()

pyhelios.validation.plugins.validate_species_name	(	Any	species,
		str	param_name = "species",
		str	function_name = None )

Validate species name for photosynthesis library.

Definition at line 569 of file plugins.py.

validate_subdivision_count()

pyhelios.validation.plugins.validate_subdivision_count	(	Any	count,
		str	param_name = "subdivision_count",
		str	function_name = None )

Validate subdivision count parameters.

Definition at line 560 of file plugins.py.

validate_temperature()

pyhelios.validation.plugins.validate_temperature	(	Any	temperature,
		str	param_name = "temperature",
		str	function_name = None )

Validate temperature values for photosynthesis calculations.

Definition at line 596 of file plugins.py.

validate_temperature_response_params()

pyhelios.validation.plugins.validate_temperature_response_params	(	Any	value_at_25c,
		Any	dha = None,
		Any	topt = None,
		Any	dhd = None,
		str	param_prefix = "",
		str	function_name = None )

Validate temperature response parameters for photosynthetic processes.

Definition at line 818 of file plugins.py.

validate_time_value()

pyhelios.validation.plugins.validate_time_value	(	Any	time_val,
		str	param_name = "time",
		str	function_name = None )

Validate time values for energy balance calculations.

Definition at line 276 of file plugins.py.

validate_tree_id()

pyhelios.validation.plugins.validate_tree_id	(	Any	tree_id,
		str	param_name = "tree_id",
		str	function_name = None )

Validate WeberPennTree tree ID.

Definition at line 340 of file plugins.py.

validate_uuid_list()

pyhelios.validation.plugins.validate_uuid_list	(	Any	uuids,
		str	param_name = "uuids",
		str	function_name = None,
		bool	allow_empty = False )

Validate UUID list parameters.

Definition at line 486 of file plugins.py.

validate_vcmax()

pyhelios.validation.plugins.validate_vcmax	(	Any	vcmax,
		str	param_name = "Vcmax",
		str	function_name = None )

Validate maximum carboxylation rate (Vcmax) parameter.

Definition at line 737 of file plugins.py.

validate_wavelength_range()

pyhelios.validation.plugins.validate_wavelength_range	(	float	wavelength_min,
		float	wavelength_max,
		str	param_name_min = "wavelength_min",
		str	param_name_max = "wavelength_max",
		str	function_name = None )

Validate wavelength range for radiation modeling.

Definition at line 15 of file plugins.py.

validate_wpt_parameters()

pyhelios.validation.plugins.validate_wpt_parameters	(	float	scale_factor = 1.0,
		int	recursion_level = 5,
		int	segment_resolution = 10,
		str	param_prefix = "WPT" )

Validate WeberPennTree generation parameters.

Definition at line 209 of file plugins.py.