This type defines a single conspecific perception component. It is required for the the_neurobio::percept_conspecifics type that defines the whole conspecifics perception object (array of conspecifics). More...

Inheritance diagram for the_neurobio::conspec_percept_comp:

Collaboration diagram for the_neurobio::conspec_percept_comp:

Public Member Functions
procedure, public	create => consp_percept_comp_create
	Create a single conspecific perception component at an undefined position with default properties. See `the_neurobio::consp_percept_comp_create()`. More...

procedure, public	make => consp_percept_make
	Make a single conspecific perception component. This is a single conspecific located within the visual range of the agent. See `the_neurobio::consp_percept_make()`. More...

procedure, public	get_size => consp_percept_get_size
	Get the conspecific perception component body size. See `the_neurobio::consp_percept_get_size()`. More...

procedure, public	get_mass => consp_percept_get_mass
	Get the conspecific perception component body mass. See `the_neurobio::consp_percept_get_mass()`. More...

procedure, public	get_dist => consp_percept_get_dist
	Get the conspecific perception component distance. See `the_neurobio::consp_percept_get_dist()`. More...

procedure, public	is_male => consp_percept_sex_is_male_get
	Get the conspecific perception component sex flag (male). See `the_neurobio::consp_percept_sex_is_male_get()`. More...

procedure, public	is_female => consp_percept_sex_is_female_get
	Get the conspecific perception component sex flag (female). See `the_neurobio::consp_percept_sex_is_female_get()`. More...

Public Member Functions inherited from the_neurobio::spatial_percept_component
procedure, public	get_cid => spatial_percept_get_cid
	Get the unique id of the food item object. See `the_neurobio::spatial_percept_get_cid()`. More...

procedure, public	set_cid => spatial_percept_set_cid
	Set unique id for the conspecific perception component. See `the_neurobio::spatial_percept_set_cid()`. More...

Public Member Functions inherited from the_environment::spatial
procedure, public	create => spatial_create_empty
	Create an empty spatial object. More...

procedure, public	position => spatial_fix_position_3d_o
	Place spatial object into a 3D space, define the object's current coordinates. Object-based procedure. See `the_environment::spatial_fix_position_3d_o()` More...

procedure, public	position_v => spatial_fix_position_3d_s
	Place spatial object into a 3D space, define the object's current coordinates. Vector-based procedure. See `the_environment::spatial_fix_position_3d_s()` More...

procedure, public	missing => spatial_make_missing
	Assign all `MISSING` coordinates to the `SPATIAL` object. See `the_environment::spatial_make_missing()` More...

procedure, public	distance => spatial_distance_3d
	Calculate the Euclidean distance between two spatial objects. See `the_environment::spatial_distance_3d()` More...

procedure, public	distance_segment2d => geo_poly2d_dist_point_to_section
	Calculates the minimum distance from a the_environment::spatial class object to a line segment delimited by two the_environment::spatial endpoints in the 2D XY plane (the depth coordinate is ignored). See `the_environment::geo_poly2d_dist_point_to_section()`. More...

procedure, public	distance_segment => geo_poly3d_dist_point_to_section
	Calculates the minimum distance from a the_environment::spatial class object to a line segment delimited by two the_environment::spatial class endpoints in the 3D XY space. See `the_environment::geo_poly3d_dist_point_to_section()`. More...

procedure, public	way => spatial_self_distance_3d
	Calculate the Euclidean distance between the current and previous position of a single spatial object. See `the_environment::spatial_self_distance_3d()` More...

procedure, public	is_within => spatial_check_located_within_3d
	Function to check if this spatial object is located within an area set by an environmental object See `the_environment::spatial_check_located_within_3d()` More...

procedure, public	find_environment => spatial_get_environment_in_pos
	Identify in which environment from the input list this spatial agent is currently in. See `the_environment::spatial_get_environment_in_pos()`. More...

procedure, public	is_below => spatial_check_located_below
	Logical function to check if the argument spatial object(s) is(are) located below this spatial object. See `the_environment::spatial_check_located_below()` More...

procedure, public	is_above => spatial_check_located_above
	Logical function to check if the argument spatial object(s) is(are) located above this spatial object. See `the_environment::spatial_check_located_above()` More...

procedure, public	nearest => spatial_get_nearest_object
	Determine the nearest spatial object to this spatial object among an array of other spatial objects. See `the_environment::spatial_get_nearest_object()` More...

procedure, public	nearest_num => spatial_get_nearest_id
	Determine the nearest spatial object to this spatial object among an array of other spatial objects. See `the_environment::spatial_get_nearest_id()` More...

procedure, public	neighbours => spatial_neighbours_distances
	Calculate the distances between this spatial object and an array of its neighbours. Optionally output the distances, sorting index vector and rankings vector for each of these neighbours. Optionally do only partial indexing, up to the order `rank_max` for computational speed. See `the_environment::spatial_neighbours_distances()` More...

procedure, public	now_o => spatial_get_current_pos_3d_o
	Get the current spatial position of a `SPATIAL` object. Object-based. See `the_environment::spatial_get_current_pos_3d_o()` More...

procedure, public	now_v => spatial_get_current_pos_3d_v
	Get the current spatial position of a `SPATIAL` object. Vector-based. See `the_environment::spatial_get_current_pos_3d_v()` More...

generic, public	location => now_o, now_v
	Get the current spatial position of a `SPATIAL` object. Generic interface/alias. More...

generic, public	now => now_o, now_v
	Get the current spatial position of a `SPATIAL` object. Generic interface/alias. More...

procedure, public	xpos => spatial_get_current_pos_x_3d
	Get the current `X` position of a `SPATIAL` object. See `the_environment::spatial_get_current_pos_x_3d()` More...

procedure, public	ypos => spatial_get_current_pos_y_3d
	Get the current `Y` position of a `SPATIAL` object. See `the_environment::spatial_get_current_pos_y_3d()` More...

procedure, public	dpos => spatial_get_current_pos_d_3d
	Get the current `Z` (depth) position of a `SPATIAL` object. See `the_environment::spatial_get_current_pos_d_3d()` More...

procedure, public	illumination => spatial_calc_irradiance_at_depth
	Calculate the illumination (background irradiance) at the depth of the spatial object at an arbitrary time step of the model. See `the_environment::spatial_calc_irradiance_at_depth()` More...

procedure, public	visibility => spatial_visibility_visual_range_cm
	Calculate the visibility range of a spatial object. Wrapper to the `visual_range` function. This function calculates the distance from which this object can be seen by a visual object (e.g. predator or prey). See `the_environment::spatial_visibility_visual_range_cm()`. More...

Public Attributes
real(srp)	consp_body_size
	Body size. The body size of the perception conspecific. More...

real(srp)	consp_body_mass
	Body mass. The body mass of the perception conspecific. More...

real(srp)	consp_distance

logical	sex_is_male
	The sex of the conspecific in the perception object. More...

Public Attributes inherited from the_neurobio::spatial_percept_component
integer	cid
	Spatial perception component adds an unique component id (`cid`) number to the basic `the_environment::spatial` so that individual objects within the whole perception object array can be identified. As a consequence, spatial perception component adds only two type-bound procedures that do the %cid. More...

Public Attributes inherited from the_environment::spatial
real(srp)	x
	We define three-dimensional environment: x, y and depth. More...

real(srp)	y

real(srp)	depth

Detailed Description

This type defines a single conspecific perception component. It is required for the the_neurobio::percept_conspecifics type that defines the whole conspecifics perception object (array of conspecifics).

Definition at line 141 of file m_neuro.f90.

Member Function/Subroutine Documentation

◆ create()

procedure, public the_neurobio::conspec_percept_comp::create

Create a single conspecific perception component at an undefined position with default properties. See the_neurobio::consp_percept_comp_create().

Definition at line 160 of file m_neuro.f90.

◆ make()

procedure, public the_neurobio::conspec_percept_comp::make

Make a single conspecific perception component. This is a single conspecific located within the visual range of the agent. See the_neurobio::consp_percept_make().

Definition at line 164 of file m_neuro.f90.

◆ get_size()

procedure, public the_neurobio::conspec_percept_comp::get_size

Get the conspecific perception component body size. See the_neurobio::consp_percept_get_size().

Definition at line 167 of file m_neuro.f90.

◆ get_mass()

procedure, public the_neurobio::conspec_percept_comp::get_mass

Get the conspecific perception component body mass. See the_neurobio::consp_percept_get_mass().

Definition at line 170 of file m_neuro.f90.

◆ get_dist()

procedure, public the_neurobio::conspec_percept_comp::get_dist

Get the conspecific perception component distance. See the_neurobio::consp_percept_get_dist().

Definition at line 173 of file m_neuro.f90.

◆ is_male()

procedure, public the_neurobio::conspec_percept_comp::is_male

Get the conspecific perception component sex flag (male). See the_neurobio::consp_percept_sex_is_male_get().

Definition at line 176 of file m_neuro.f90.

◆ is_female()

procedure, public the_neurobio::conspec_percept_comp::is_female

Get the conspecific perception component sex flag (female). See the_neurobio::consp_percept_sex_is_female_get().

Definition at line 179 of file m_neuro.f90.

Member Data Documentation

◆ consp_body_size

real(srp) the_neurobio::conspec_percept_comp::consp_body_size

Body size. The body size of the perception conspecific.

Note: We may need body size of the conspecifics as the decision making rules may depend on the conspecific size (e.g. approach big and repulse from small, also may affect mating, e.g. mate with the biggest, etc.).

Definition at line 147 of file m_neuro.f90.

◆ consp_body_mass

real(srp) the_neurobio::conspec_percept_comp::consp_body_mass

Body mass. The body mass of the perception conspecific.

Definition at line 149 of file m_neuro.f90.

◆ consp_distance

real(srp) the_neurobio::conspec_percept_comp::consp_distance

Note: Any other characteristics of the perception conspecifics may be added, e.g. sex etc. What is crucial for the decision making. The distance towards this conspecific in the visual field.

Definition at line 153 of file m_neuro.f90.

◆ sex_is_male

logical the_neurobio::conspec_percept_comp::sex_is_male

The sex of the conspecific in the perception object.

Definition at line 155 of file m_neuro.f90.

The documentation for this type was generated from the following file:

m_neuro.f90

Public Member Functions

Public Attributes