Map of the percentage of simulations in which a Cell burned in each intensity category.
More...
#include <ProbabilityMap.h>
|
ProbabilityMap * | copyEmpty () const |
| Create a copy of this that is empty.
|
|
vector< MathSize > | getSizes () const |
| List of sizes of IntensityMaps that have been added.
|
|
util::Statistics | getStatistics () const |
| Generate Statistics on sizes of IntensityMaps that have been added.
|
|
size_t | numSizes () const noexcept |
| Number of sizes that have been added.
|
|
void | saveSizes (const string &base_name) const |
| Save list of sizes.
|
|
void | saveTotal (const string &base_name, const ProcessingStatus processing_status) const |
| Save map representing all intensities.
|
|
void | saveTotalCount (const string &base_name) const |
| Save map representing all intensities occurrence.
|
|
bool | record_if_interim (const char *filename) const |
| Make note of any interim files for later deletion.
|
|
template<class R > |
string | saveToProbabilityFile (const data::GridMap< size_t > &grid, const string &dir, const string &base_name, const R divisor) const |
| Save probability file and record filename if interim.
|
|
|
const string | dir_out_ |
| Directory to write outputs to.
|
|
data::GridMap< size_t > | all_ |
| Map representing all intensities.
|
|
vector< MathSize > | sizes_ {} |
| List of sizes for perimeters that have been added.
|
|
const DurationSize | time_ |
| Time in simulation this ProbabilityMap represents.
|
|
const DurationSize | start_time_ |
| Start time of simulation.
|
|
mutex | mutex_ |
| Mutex for parallel access.
|
|
const topo::Perimeter * | perimeter_ |
| Initial ignition grid to apply to outputs.
|
|
Map of the percentage of simulations in which a Cell burned in each intensity category.
◆ ProbabilityMap()
fs::sim::ProbabilityMap::ProbabilityMap |
( |
const string | dir_out, |
|
|
DurationSize | time, |
|
|
DurationSize | start_time, |
|
|
const data::GridBase & | grid_info ) |
Constructor.
- Parameters
-
dir_out | Directory to save outputs to |
time | Time in simulation this ProbabilityMap represents |
start_time | Start time of simulation |
min_value | Lower bound of 'low' intensity range |
low_max | Upper bound of 'low' intensity range |
med_max | Upper bound of 'moderate' intensity range |
max_value | Upper bound of 'high' intensity range |
grid_info | GridBase to use for extent of this |
◆ addProbabilities()
void fs::sim::ProbabilityMap::addProbabilities |
( |
const ProbabilityMap & | rhs | ) |
|
◆ addProbability()
void fs::sim::ProbabilityMap::addProbability |
( |
const IntensityMap & | for_time | ) |
|
Add in an IntensityMap to the appropriate probability grid based on each cell burn intensity.
- Parameters
-
◆ copyEmpty()
Create a copy of this that is empty.
- Returns
- New empty Probability with same range bounds and times
◆ deleteInterim()
void fs::sim::ProbabilityMap::deleteInterim |
( |
| ) |
|
|
static |
Delete interim output files
◆ getSizes()
vector< MathSize > fs::sim::ProbabilityMap::getSizes |
( |
| ) |
const |
|
nodiscardprivate |
List of sizes of IntensityMaps that have been added.
- Returns
- List of sizes of IntensityMaps that have been added
◆ getStatistics()
Generate Statistics on sizes of IntensityMaps that have been added.
- Returns
- Generate Statistics on sizes of IntensityMaps that have been added
◆ numSizes()
size_t fs::sim::ProbabilityMap::numSizes |
( |
| ) |
const |
|
nodiscardprivatenoexcept |
Number of sizes that have been added.
- Returns
- Number of sizes that have been added
◆ saveAll()
void fs::sim::ProbabilityMap::saveAll |
( |
const tm & | start_time, |
|
|
DurationSize | time, |
|
|
const ProcessingStatus | processing_status ) const |
Save total, low, moderate, and high maps, and output information to log.
- Parameters
-
start_time | Start time of simulation |
time | Time for these maps |
processing_status | Stage in processing for simulations |
◆ saveSizes()
void fs::sim::ProbabilityMap::saveSizes |
( |
const string & | base_name | ) |
const |
|
private |
Save list of sizes.
- Parameters
-
base_name | Base name of file to save into |
◆ saveToProbabilityFile()
template<class R >
string fs::sim::ProbabilityMap::saveToProbabilityFile |
( |
const data::GridMap< size_t > & | grid, |
|
|
const string & | dir, |
|
|
const string & | base_name, |
|
|
const R | divisor ) const |
|
inlineprivate |
Save probability file and record filename if interim.
- Returns
- Path for file that was written
◆ saveTotal()
void fs::sim::ProbabilityMap::saveTotal |
( |
const string & | base_name, |
|
|
const ProcessingStatus | processing_status ) const |
|
private |
Save map representing all intensities.
- Parameters
-
base_name | Base file name to save to |
processing_status | Stage in processing for simulations |
◆ saveTotalCount()
void fs::sim::ProbabilityMap::saveTotalCount |
( |
const string & | base_name | ) |
const |
|
private |
Save map representing all intensities occurrence.
- Parameters
-
base_name | Base file name to save to |
◆ setPerimeter()
void fs::sim::ProbabilityMap::setPerimeter |
( |
const topo::Perimeter *const | perimeter | ) |
|
Assign perimeter to use for marking cells as initial perimeter.
- Parameters
-
perimeter | Ignition grid to store for marking in outputs |
The documentation for this class was generated from the following files: