FireSTARR
Loading...
Searching...
No Matches
fs::BurnedMap Class Referencefinal

A map of locations which have burned in a Scenario. Use this class so that we can filter by fuel cells but not expose the members. More...

#include <Perimeter.h>

Inheritance diagram for fs::BurnedMap:
Collaboration diagram for fs::BurnedMap:

Public Member Functions

 BurnedMap (const Grid< unsigned char, unsigned char > &perim_grid, const Environment &env)
 Constructor.
 
size_t size_hectares () const
 
- Public Member Functions inherited from fs::GridMap< unsigned char >
bool contains (const XYIdx &location) const
 
unsigned char at (const XYIdx &location) const override
 
void set (const XYIdx &location, const unsigned char value) override
 Set value at Location.
 
 GridMap (const MathSize cell_size, const Idx width, const Idx height, unsigned char no_data, const int nodata, const MathSize xllcorner, const MathSize yllcorner, const MathSize xurcorner, const MathSize yurcorner, const string_view proj4)
 
 GridMap (const Grid< unsigned char, unsigned char > &grid)
 Construct empty GridMap with same extent as given Grid.
 
 GridMap (const GridBase &grid_info, unsigned char no_data)
 Construct empty GridMap with same extent as given Grid.
 
 GridMap (GridMap &&rhs) noexcept
 
 GridMap (const GridMap &rhs)
 
GridMap & operator= (GridMap &&rhs) noexcept
 
GridMap & operator= (const GridMap &rhs)
 
void clear () noexcept
 Clear data from GridMap.
 
FileList saveToProbabilityFile (const string_view dir, const string_view base_name, const R divisor) const
 Save GridMap contents to .asc file as probability.
 
MathSize fireSize () const noexcept
 Calculate area for cells that have a value (ha)
 
list< XYIdx > makeEdge () const
 Make a list of all Locations that are on the edge of cells with a value.
 
list< XYIdx > makeList () const
 Make a list of all Locations that have a value.
 
- Public Member Functions inherited from fs::GridData< unsigned char, unsigned char, map< XYIdx, unsigned char > >
 GridData (const MathSize cell_size, const Idx width, const Idx height, const unsigned char nodata_input, const unsigned char nodata_value, const MathSize xllcorner, const MathSize yllcorner, const MathSize xurcorner, const MathSize yurcorner, const string_view proj4, map< XYIdx, unsigned char > &&data)
 
 GridData (const GridData &rhs)
 
 GridData (GridData &&rhs) noexcept
 
GridData & operator= (const GridData &rhs) noexcept
 
GridData & operator= (GridData &&rhs) noexcept
 
size_t size () const
 Size of data structure storing values.
 
FileList saveToFileWithoutRetry (const string_view dir, const string_view base_name, std::function< R(unsigned char value)> convert, const R no_data) const
 Save GridMap contents to file based on settings.
 
FileList saveToFileWithRetry (const string_view dir, const string_view base_name, std::function< R(unsigned char value)> convert, const R no_data) const
 Save GridMap contents to file based on settings.
 
FileList saveToFile (const string_view dir, const string_view base_name, std::function< R(unsigned char value)> convert, const R no_data) const
 Save GridMap contents to file based on settings.
 
FileList saveToFile (const string_view dir, const string_view base_name, std::function< R(unsigned char value)> convert) const
 Save GridMap contents to file based on settings.
 
FileList saveToFile (const string_view dir, const string_view base_name) const
 Save GridMap contents to file based on settings.
 
- Public Member Functions inherited from fs::Grid< unsigned char, unsigned char >
constexpr Idx height () const noexcept
 
constexpr Idx width () const noexcept
 
constexpr unsigned char nodataInput () const noexcept
 Value used for grid locations that have no data.
 
constexpr unsigned char nodataValue () const noexcept
 Value representing no data.
 
- Public Member Functions inherited from fs::GridBase
 GridBase (GridBase &&rhs) noexcept=default
 
 GridBase (const GridBase &rhs)=default
 
GridBase & operator= (const GridBase &rhs)=default
 
GridBase & operator= (GridBase &&rhs) noexcept=default
 
constexpr MathSize cellSize () const noexcept
 Cell size used for GridBase.
 
constexpr FullIdx calculateHeight () const noexcept
 
constexpr FullIdx calculateWidth () const noexcept
 
constexpr MathSize xllcorner () const noexcept
 Lower left corner X coordinate in metres.
 
constexpr MathSize yllcorner () const noexcept
 Lower left corner Y coordinate in metres.
 
constexpr MathSize xurcorner () const noexcept
 Upper right corner X coordinate in metres.
 
constexpr MathSize yurcorner () const noexcept
 Upper right corner Y coordinate in metres.
 
constexpr const string & proj4 () const noexcept
 Proj4 string defining coordinate system for this grid. Must be a UTM projection.
 
 GridBase (MathSize cell_size, MathSize xllcorner, MathSize yllcorner, MathSize xurcorner, MathSize yurcorner, const string_view proj4) noexcept
 Constructor.
 
void createPrj (const string_view dir, const string_view base_name) const
 Create .prj file in directory with base name for file.
 
std::optional< Coordinates > findCoordinates (const Point &point, bool flipped) const
 Find Coordinates for Point.
 
std::optional< FullCoordinates > findFullCoordinates (const Point &point, bool flipped) const
 Find FullCoordinates for Point.
 
bool validate (const Point &point) const
 
string saveToTiffFileInt (const Idx width, const Idx height, const tuple< Idx, Idx, Idx, Idx > bounds, const string_view dir, const string_view base_name, const uint16_t bits_per_sample, const bool is_unsigned, std::function< int(const XYIdx &)> value_at, const int nodata_as_int) const
 
string saveToTiffFileFloat (const Idx width, const Idx height, const tuple< Idx, Idx, Idx, Idx > bounds, const string_view dir, const string_view base_name, std::function< double(const XYIdx &)> value_at, const int nodata_as_int) const
 

Private Attributes

size_t size_hectares_
 Size in hectares.
 

Additional Inherited Members

- Public Attributes inherited from fs::GridData< unsigned char, unsigned char, map< XYIdx, unsigned char > >
map< XYIdx, unsigned char > data
 Structure that holds data represented by this GridData.
 
- Protected Member Functions inherited from fs::GridMap< unsigned char >
tuple< Idx, Idx, Idx, Idx > dataBounds () const override
 
- Protected Member Functions inherited from fs::GridData< unsigned char, unsigned char, map< XYIdx, unsigned char > >
string saveToAsciiFile (const string_view dir, const string_view base_name, std::function< R(unsigned char value)> convert, const R no_data) const
 Save GridMap contents to .asc file.
 
string saveToTiffFile (const string_view dir, const string_view base_name, std::function< R(unsigned char value)> convert, const R no_data) const
 Save GridMap contents to .tif file.
 
string saveToTiffFile (const string_view dir, const string_view base_name, std::function< R(unsigned char value)> convert, const R no_data) const
 
- Protected Member Functions inherited from fs::Grid< unsigned char, unsigned char >
 Grid (const MathSize cell_size, const Idx width, const Idx height, const unsigned char nodata_input, const unsigned char nodata_value, const MathSize xllcorner, const MathSize yllcorner, const MathSize xurcorner, const MathSize yurcorner, const string_view proj4) noexcept
 
 Grid (const GridBase &grid_info, unsigned char no_data) noexcept
 Construct based on GridBase and no data value.
 

Detailed Description

A map of locations which have burned in a Scenario. Use this class so that we can filter by fuel cells but not expose the members.

Constructor & Destructor Documentation

◆ BurnedMap()

fs::BurnedMap::BurnedMap ( const Grid< unsigned char, unsigned char > & perim_grid,
const Environment & env )

Constructor.

Parameters
perim_gridGrid representing Perimeter to initialize from
envEnvironment to use as base
Here is the call graph for this function:

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