ResidentInPolygon¶
Doc:
short class_name: ResidentInPolygon
full class_name : oceantracker.particle_statistics.resident_in_polygon.ResidentInPolygon
Inheritance: > ParameterBaseClass> _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:
Nonedata_type:
<class 'str'>
coords_in_lat_lon_order<class 'bool'><optional>Description: Allows points to be given (lat,lon) and order will be swapped before use, only used if hydro-model coords are in degrees
default:
Falsedata_type:
<class 'bool'>possible_values:
[True, False]
duration<class 'float'><optional>Description: How long to do counting after start time, can be used instead of “end” parameter
default:
Nonedata_type:
<class 'float'>units:
secmin:
0.0
end['str', 'float', 'datetime64', 'int', 'float64', 'float32']<optional>Description: Stop particle counting from this iso date-time, default is end of model run
default:
Nonepossible_types:
[<class 'str'>, <class 'float'>, <class 'numpy.datetime64'>, <class 'int'>, <class 'numpy.float64'>, <class 'numpy.float32'>]units:
ISO8601 date as string eg. "2017-01-01T00:30:00",np.datetime64, or float of seconds since 1/1/1970
name<class 'str'><optional>Description: Name used to refer to class in code and output, = None for core claseses
default:
Nonedata_type:
<class 'str'>
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:
Nonedata_type:
<class 'str'>
particle_property_list: <optional>Description: - Create statistics for these named particle properties, list = [“water_depth”], for average of water depth at particle locations inside the counted regions
a list containing type:
[]default list :
Nonedata_type:
<class 'str'>possible_types:
[]make_list_unique:
Truemin_len:
0
role_output_file_tag<class 'str'><optional>
default:
residencedata_type:
<class 'str'>
start['str', 'float', 'datetime64', 'int', 'float64', 'float32']<optional>Description: Start particle counting from this date-time, default is start of model run
default:
Nonepossible_types:
[<class 'str'>, <class 'float'>, <class 'numpy.datetime64'>, <class 'int'>, <class 'numpy.float64'>, <class 'numpy.float32'>]units:
ISO8601 date as string eg. "2017-01-01T00:30:00",np.datetime64, or float of seconds since 1/1/1970
status_list: <optional>Description: - List of particle status types to count,eg [“on_bottom”,”moving”], other status types will be ignored in statistcs
a list containing type:
[]default list :
['stationary', 'stranded_by_tide', 'on_bottom', 'moving']data_type:
<class 'str'>possible_values:
['unknown', 'bad_coord', 'cell_search_failed', 'notReleased', 'dead', 'hit_dry_cell', 'outside_domain', 'outside_open_boundary', 'stationary', 'stranded_by_tide', 'on_bottom', 'moving']possible_types:
[]make_list_unique:
Falsemin_len:
0
update_interval<class 'float'><optional>Description: Time in seconds between calculating statistics, wil be rounded to be a multiple of the particle tracking time step
default:
3600.0data_type:
<class 'float'>units:
sec
user_note<class 'str'><optional>
default:
Nonedata_type:
<class 'str'>
water_depth_max<class 'float'><optional>Description: Count only those particles in water depths less than this value
default:
Nonedata_type:
<class 'float'>min:
0.0
water_depth_min<class 'float'><optional>Description: Count only those particles in water depths greater than this value
default:
Nonedata_type:
<class 'float'>min:
0.0
write<class 'bool'><optional>Description: Write statistcs to disk
default:
Truedata_type:
<class 'bool'>possible_values:
[True, False]
z_max<class 'float'><optional>Description: Count only those particles with vertical position <= to this value
default:
Nonedata_type:
<class 'float'>units:
meters above mean water level, so is < 0 at depth
z_min<class 'float'><optional>Description: Count only those particles with vertical position >= to this value
default:
Nonedata_type:
<class 'float'>units:
meters above mean water level, so is < 0 at depth