InsidePolygonsNonOverlapping2D

Doc: particle property giving ID of 2D polygon which particle is inside. -1 if in no polygon assumes non-overlapping polygons, ie so only inside one at a time, ie the first it is found inside, does not check if polygons overlap

short class_name: InsidePolygonsNonOverlapping2D

full class_name : oceantracker.particle_properties.inside_polygons.InsidePolygonsNonOverlapping2D

Warning

Class is under development may not yet work in all cases, if errors contact developer

Inheritance: > ParameterBaseClass> _BaseParticleProperty> ManuallyUpdatedParticleProperty> InsidePolygonsNonOverlapping2D

Parameters:

• class_name<class 'str'> <optional>

  Description: Class name as string A.B.C, used to import this class from python path

  • default: None

  • data_type: <class 'str'>

• description<class 'str'> <optional>

  • default: None

  • data_type: <class 'str'>

• dtype<class 'str'> <optional>

  • default: int32

  • data_type: <class 'str'>

• extra_dimensions: <optional>

  Description: - list of the names of dimensions for vectors, or those with prop_dim3 set. Partile is added automatically

  • a list containing type: []

  • default list : None

  • data_type: <class 'str'>

  • possible_types: []

  • make_list_unique: False

  • min_len: 0

• initial_value<class 'int'> <optional>

  • default: -1

  • data_type: <class 'int'>

• name<class 'str'> <isrequired>

  Description: Name used to refer to this particle property in code and output

  • default: None

  • data_type: <class 'str'>

• prop_dim3<class 'int'> <optional>

  Description: size of a 3d dimension of particle property

  • default: 1

  • data_type: <class 'int'>

  • min: 1

• time_varying<class 'bool'> <optional>

  • default: True

  • data_type: <class 'bool'>

  • possible_values: [True, False]

• units<class 'str'> <optional>

  • default: None

  • data_type: <class 'str'>

• update<class 'bool'> <optional>

  • default: True

  • data_type: <class 'bool'>

  • possible_values: [True, False]

• user_note<class 'str'> <optional>

  • default: None

  • data_type: <class 'str'>

• vector_dim<class 'int'> <optional>

  • default: 1

  • data_type: <class 'int'>

  • min: 1

• write<class 'bool'> <optional>

  Description: Write particle property to tracks or event files file

  • default: True

  • data_type: <class 'bool'>

  • possible_values: [True, False]

Expert Parameters: