Particle Statistics

Heat maps

Heatmaps built on the fly with no particle tracks recorded. Options for both time and aged based gridded heatmaps

• class: particle_statistics.gridded_statistics.GriddedStats2D_timeBased

• class: particle_statistics.gridded_statistics.GriddedStats2D_agedBased

along with counts of particles inside polygons

• class: particle_statistics.polygon_statistics.PolygonStats2D_timeBased

• class: particle_statistics.polygon_statistics.PolygonStats2D_ageBased

json parameters

../../../demos/demo_param_files/demo03_heatmaps.json

{
    "output_file_base": "demo03_heatmaps",
    "add_date_to_run_output_dir": false,
    "NUMBA_cache_code": false,
    "time_step": 900,
    "debug": true,
    "reader": {
        "input_dir": "F:\\H_Local_drive\\ParticleTracking\\oceantracker\\demos\\demo_hindcast",
        "file_mask": "Random_order_*.nc",
        "time_buffer_size": 15
    },
    "user_note": "test of notes",
    "dispersion": {
        "A_H": 0.1
    },
    "tracks_writer": {
        "turn_on_write_particle_properties_list": [
            "n_cell"
        ],
        "write_dry_cell_flag": true
    },
    "release_groups": [
        {
            "name": "myP1",
            "points": [
                [
                    1596000,
                    5486000
                ]
            ],
            "pulse_size": 2000,
            "release_interval": 7200,
            "release_radius": 100.0
        },
        {
            "name": "myP2",
            "points": [
                [
                    1596000,
                    5490000
                ]
            ],
            "pulse_size": 2000,
            "release_interval": 7200
        }
    ],
    "particle_properties": [
        {
            "name": "Oxygen",
            "class_name": "AgeDecay",
            "decay_time_scale": 86400.0,
            "initial_value": 20.0
        },
        {
            "name": "distance_travelled",
            "class_name": "DistanceTravelled"
        },
        {
            "name": "age_decay",
            "class_name": "AgeDecay",
            "decay_time_scale": 86400.0
        },
        {
            "name": "my_constant_prop",
            "class_name": "ParticleLoad",
            "initial_value": 100
        }
    ],
    "particle_statistics": [
        {
            "name": "gridstats1",
            "class_name": "oceantracker.particle_statistics.gridded_statistics2D.GriddedStats2D_timeBased",
            "update_interval": 1800,
            "particle_property_list": [
                "water_depth"
            ],
            "grid_span": [
                10000,
                10000
            ],
            "grid_size": [
                220,
                221
            ]
        },
        {
            "name": "polystats1",
            "class_name": "oceantracker.particle_statistics.polygon_statistics.PolygonStats2D_timeBased",
            "update_interval": 1800,
            "particle_property_list": [
                "water_depth"
            ],
            "polygon_list": [
                {
                    "points": [
                        [
                            1597682.1237,
                            5489972.7479
                        ],
                        [
                            1598604.1667,
                            5490275.5488
                        ],
                        [
                            1598886.4247,
                            5489464.0424
                        ],
                        [
                            1597917.3387,
                            5489000
                        ],
                        [
                            1597300,
                            5489000
                        ],
                        [
                            1597682.1237,
                            5489972.7479
                        ]
                    ]
                }
            ]
        }
    ],
    "particle_buffer_initial_size": 20000,
    "write_tracks": false,
    "max_run_duration": 259200,
    "root_output_dir": "output"
}

yaml parameters

../../../demos/demo_param_files/demo03_heatmaps.yaml

NUMBA_cache_code: false
add_date_to_run_output_dir: false
debug: true
dispersion:
  A_H: 0.1
max_run_duration: 259200
output_file_base: demo03_heatmaps
particle_buffer_initial_size: 20000
particle_properties:
- class_name: AgeDecay
  decay_time_scale: 86400.0
  initial_value: 20.0
  name: Oxygen
- class_name: DistanceTravelled
  name: distance_travelled
- class_name: AgeDecay
  decay_time_scale: 86400.0
  name: age_decay
- class_name: ParticleLoad
  initial_value: 100
  name: my_constant_prop
particle_statistics:
- class_name: oceantracker.particle_statistics.gridded_statistics2D.GriddedStats2D_timeBased
  grid_size:
  - 220
  - 221
  grid_span:
  - 10000
  - 10000
  name: gridstats1
  particle_property_list:
  - water_depth
  update_interval: 1800
- class_name: oceantracker.particle_statistics.polygon_statistics.PolygonStats2D_timeBased
  name: polystats1
  particle_property_list:
  - water_depth
  polygon_list:
  - points:
    - - 1597682.1237
      - 5489972.7479
    - - 1598604.1667
      - 5490275.5488
    - - 1598886.4247
      - 5489464.0424
    - - 1597917.3387
      - 5489000
    - - 1597300
      - 5489000
    - - 1597682.1237
      - 5489972.7479
  update_interval: 1800
reader:
  file_mask: Random_order_*.nc
  input_dir: F:\H_Local_drive\ParticleTracking\oceantracker\demos\demo_hindcast
  time_buffer_size: 15
release_groups:
- name: myP1
  points:
  - - 1596000
    - 5486000
  pulse_size: 2000
  release_interval: 7200
  release_radius: 100.0
- name: myP2
  points:
  - - 1596000
    - 5490000
  pulse_size: 2000
  release_interval: 7200
root_output_dir: output
time_step: 900
tracks_writer:
  turn_on_write_particle_properties_list:
  - n_cell
  write_dry_cell_flag: true
user_note: test of notes
write_tracks: false