FireSTARR
Loading...
Searching...
No Matches
fs::ProbabilityMap Class Reference

Map of the percentage of simulations in which a Cell burned in each intensity category. More...

#include <ProbabilityMap.h>

Collaboration diagram for fs::ProbabilityMap:

Public Member Functions

 ProbabilityMap (const ProbabilityMap &rhs) noexcept=delete
 
 ProbabilityMap (ProbabilityMap &&rhs) noexcept=delete
 
ProbabilityMap & operator= (const ProbabilityMap &rhs) noexcept=delete
 
ProbabilityMap & operator= (ProbabilityMap &&rhs) noexcept=delete
 
 ProbabilityMap (const DurationSize time, const DurationSize start_time, const int min_value, const int low_max, const int med_max, const int max_value, const GridBase &grid_info, const shared_ptr< Perimeter > perimeter)
 Constructor.
 
void addProbabilities (const ProbabilityMap &rhs)
 Combine results from another ProbabilityMap into this one.
 
void addProbability (const IntensityMap &for_time)
 Add in an IntensityMap to the appropriate probability grid based on each cell burn intensity.
 
void show () const
 Output Statistics to log.
 
FileList saveAll (string_view output_directory, const tm &start_time, DurationSize time, const ProcessingStatus processing_status) const
 Save total, low, moderate, and high maps, and output information to log.
 
void reset ()
 Clear maps and return to initial state.
 

Static Public Member Functions

static void deleteInterim ()
 

Public Attributes

const DurationSize time
 Time in simulation this ProbabilityMap represents.
 
const DurationSize start_time
 Start time of simulation.
 

Private Member Functions

vector< MathSize > getSizes () const
 List of sizes of IntensityMaps that have been added.
 
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.
 
FileList saveSizes (const string_view output_directory, const string_view base_name, const ProcessingStatus processing_status) const
 Save list of sizes.
 
FileList saveTotal (const string_view output_directory, const string_view base_name, const ProcessingStatus processing_status) const
 Save map representing all intensities.
 
FileList saveTotalCount (const string_view output_directory, const string_view base_name, const ProcessingStatus processing_status) const
 Save map representing all intensities occurrence.
 
FileList saveHigh (const string_view output_directory, const string_view base_name, const ProcessingStatus processing_status) const
 Save map representing high intensities.
 
FileList saveModerate (const string_view output_directory, const string_view base_name, const ProcessingStatus processing_status) const
 Save map representing moderate intensities.
 
FileList saveLow (const string_view output_directory, const string_view base_name, const ProcessingStatus processing_status) const
 Save map representing low intensities.
 
FileList record_if_interim (FileList &&files, const ProcessingStatus processing_status) const
 Make note of any interim files for later deletion.
 
template<class R >
FileList saveToProbabilityFile (const GridMap< size_t > &grid, const string_view output_directory, const string_view base_name, const R divisor, const ProcessingStatus processing_status) const
 Save probability file and record filename if interim.
 

Private Attributes

GridMap< size_t > all_
 Map representing all intensities.
 
GridMap< size_t > high_
 Map representing high intensities.
 
GridMap< size_t > med_
 Map representing moderate intensities.
 
GridMap< size_t > low_
 Map representing low intensities.
 
vector< MathSize > sizes_ {}
 List of sizes for perimeters that have been added.
 
mutex mutex_
 Mutex for parallel access.
 
IntensitySize min_value_
 Lower bound of 'low' intensity range.
 
IntensitySize max_value_
 Upper bound of 'high' intensity range.
 
const IntensitySize low_max_
 Upper bound of 'low' intensity range.
 
const IntensitySize med_max_
 Upper bound of 'moderate' intensity range.
 
const shared_ptr< Perimeter > perimeter_
 Initial ignition grid to apply to outputs.
 

Detailed Description

Map of the percentage of simulations in which a Cell burned in each intensity category.

Constructor & Destructor Documentation

◆ ProbabilityMap()

fs::ProbabilityMap::ProbabilityMap ( const DurationSize time,
const DurationSize start_time,
const int min_value,
const int low_max,
const int med_max,
const int max_value,
const GridBase & grid_info,
const shared_ptr< Perimeter > perimeter )

Constructor.

Parameters
timeTime in simulation this ProbabilityMap represents
start_timeStart time of simulation
min_valueLower bound of 'low' intensity range
low_maxUpper bound of 'low' intensity range
med_maxUpper bound of 'moderate' intensity range
max_valueUpper bound of 'high' intensity range
grid_infoGridBase to use for extent of this

Member Function Documentation

◆ addProbabilities()

void fs::ProbabilityMap::addProbabilities ( const ProbabilityMap & rhs)

Combine results from another ProbabilityMap into this one.

Parameters
rhsProbabilityMap to combine from

◆ addProbability()

void fs::ProbabilityMap::addProbability ( const IntensityMap & for_time)

Add in an IntensityMap to the appropriate probability grid based on each cell burn intensity.

Parameters
for_timeIntensityMap to add results from
Here is the call graph for this function:

◆ deleteInterim()

void fs::ProbabilityMap::deleteInterim ( )
static

Delete interim output files

Here is the caller graph for this function:

◆ getSizes()

vector< MathSize > fs::ProbabilityMap::getSizes ( ) const
nodiscardprivate

List of sizes of IntensityMaps that have been added.

Returns
List of sizes of IntensityMaps that have been added

◆ getStatistics()

Statistics fs::ProbabilityMap::getStatistics ( ) const
nodiscardprivate

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::ProbabilityMap::numSizes ( ) const
nodiscardprivatenoexcept

Number of sizes that have been added.

Returns
Number of sizes that have been added

◆ saveAll()

FileList fs::ProbabilityMap::saveAll ( string_view output_directory,
const tm & start_time,
DurationSize time,
const ProcessingStatus processing_status ) const
nodiscard

Save total, low, moderate, and high maps, and output information to log.

Parameters
start_timeStart time of simulation
timeTime for these maps
processing_statusStage in processing for simulations

◆ saveHigh()

FileList fs::ProbabilityMap::saveHigh ( const string_view output_directory,
const string_view base_name,
const ProcessingStatus processing_status ) const
nodiscardprivate

Save map representing high intensities.

Parameters
output_directoryDirectory to save to
base_nameBase file name to save to
Returns
FileList of file names saved to

◆ saveLow()

FileList fs::ProbabilityMap::saveLow ( const string_view output_directory,
const string_view base_name,
const ProcessingStatus processing_status ) const
nodiscardprivate

Save map representing low intensities.

Parameters
output_directoryDirectory to save to
base_nameBase file name to save to
Returns
FileList of file names saved to

◆ saveModerate()

FileList fs::ProbabilityMap::saveModerate ( const string_view output_directory,
const string_view base_name,
const ProcessingStatus processing_status ) const
nodiscardprivate

Save map representing moderate intensities.

Parameters
output_directoryDirectory to save to
base_nameBase file name to save to
Returns
FileList of file names saved to

◆ saveSizes()

FileList fs::ProbabilityMap::saveSizes ( const string_view output_directory,
const string_view base_name,
const ProcessingStatus processing_status ) const
nodiscardprivate

Save list of sizes.

Parameters
output_directoryDirectory to save to
base_nameBase name of file to save into
Returns
FileList of file names saved to

◆ saveToProbabilityFile()

template<class R >
FileList fs::ProbabilityMap::saveToProbabilityFile ( const GridMap< size_t > & grid,
const string_view output_directory,
const string_view base_name,
const R divisor,
const ProcessingStatus processing_status ) const
inlinenodiscardprivate

Save probability file and record filename if interim.

Returns
Path for file that was written
Here is the call graph for this function:

◆ saveTotal()

FileList fs::ProbabilityMap::saveTotal ( const string_view output_directory,
const string_view base_name,
const ProcessingStatus processing_status ) const
nodiscardprivate

Save map representing all intensities.

Parameters
output_directoryDirectory to save to
base_nameBase file name to save to
Returns
FileList of file names saved to

◆ saveTotalCount()

FileList fs::ProbabilityMap::saveTotalCount ( const string_view output_directory,
const string_view base_name,
const ProcessingStatus processing_status ) const
nodiscardprivate

Save map representing all intensities occurrence.

Parameters
output_directoryDirectory to save to
base_nameBase file name to save to
Returns
FileList of file names saved to

The documentation for this class was generated from the following files: