ResidentInPolygon¶
Description:
class_name: oceantracker.particle_statistics.resident_in_polygon.ResidentInPolygon
File: oceantracker/particle_statistics/resident_in_polygon.py
Inheritance: _BaseParticleLocationStats> ResidentInPolygon
Parameters:¶
class_name<class 'str'><optional>Description: Class name as string A.B.C, used to import this class from python path
default:
None
count_end_dateiso8601date<optional>Description: Stop particle counting from this date
default:
None
count_start_dateiso8601date<optional>Description: Start particle counting from this date
default:
None
max_water_depth<class 'float'><optional>Description: Count only those particles in water depths less than this value
default:
None
max_z<class 'float'><optional>Description: Count only those particles with vertical position <= to this value
default:
None
min_water_depth<class 'float'><optional>Description: Count only those particles in water depths greater than this value
default:
None
min_z<class 'float'><optional>Description: Count only those particles with vertical position >= to this value
default:
None
name_of_polygon_release_group<class 'str'><isrequired>Description: “name” parameter of polygon release group to count paticles for residence time , (release group “name” must be set by user). Particles inside this release groups polygon are conted to be used to calculate its residence time
default:
None
particle_property_list: <optional>Description: - Create statistics for these named particle properties, list = [“water_depth”], for statics on water depth at particle locations inside the counted regions
a list containing type:
[<class 'str'>]default list :
[]can_be_empty_list:
Truemake_list_unique:
True
role_output_file_tag<class 'str'><optional>
default:
residence
status_max[<class 'str'>]<optional>Description: Count only those particles with status <= to this value
default:
movingpossible_values:
['unknown', 'bad_cord', 'cell_search_failed', 'notReleased', 'dead', 'outside_open_boundary', 'frozen', 'stranded_by_tide', 'on_bottom', 'moving']
status_min[<class 'str'>]<optional>Description: Count only those particles with status >= to thsi value
default:
frozenpossible_values:
['unknown', 'bad_cord', 'cell_search_failed', 'notReleased', 'dead', 'outside_open_boundary', 'frozen', 'stranded_by_tide', 'on_bottom', 'moving']
update_interval<class 'float'><optional>Description: Time in seconds between calculating statistics
default:
3600.0units:
sec
user_note<class 'str'><optional>
default:
None
write<class 'bool'><optional>Description: Write statistcs to disk
default:
Truepossible_values:
[True, False]
z_range: <optional>Description: - z range = [zmin, zmax] count particles in this z range in 3D
a list containing type:
[<class 'float'>, <class 'int'>]default list :
[]can_be_empty_list:
Truemin_length:
2