fs::topo::BurnedMap Class Reference

A map of locations which have burned in a Scenario. More...

Inheritance diagram for fs::topo::BurnedMap:

Collaboration diagram for fs::topo::BurnedMap:

Public Member Functions
	BurnedMap (const Grid< unsigned char, unsigned char > &perim_grid, const Environment &env)
	Constructor.
Public Member Functions inherited from fs::data::GridMap< unsigned char >
bool	contains (const Location &location) const
	Determine if Location has a value.
bool	contains (const Position< P > &position) const
unsigned char	at (const Location &location) const override
	Retrieve value at Location.
unsigned char	at (const Position< P > &position) const
void	set (const Location &location, const unsigned char value) override
	Set value at Location.
void	set (const Position< P > &position, const unsigned char value)
	GridMap (const MathSize cell_size, const Idx rows, const Idx columns, unsigned char no_data, const int nodata, const MathSize xllcorner, const MathSize yllcorner, const MathSize xurcorner, const MathSize yurcorner, string &&proj4)
	Constructor.
	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
	Move constructor.
	GridMap (const GridMap &rhs)
	Copy constructor.
GridMap &	operator= (GridMap &&rhs) noexcept
	Move assignment.
GridMap &	operator= (const GridMap &rhs)
	Copy assignment.
void	clear () noexcept
	Clear data from GridMap.
string	saveToProbabilityFile (const string &dir, const string &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< Location >	makeEdge () const
	Make a list of all Locations that are on the edge of cells with a value.
list< Location >	makeList () const
	Make a list of all Locations that have a value.
Public Member Functions inherited from fs::data::GridData< unsigned char, unsigned char, map< Location, unsigned char > >
	GridData (const MathSize cell_size, const Idx rows, const Idx columns, const unsigned char nodata_input, const unsigned char nodata_value, const MathSize xllcorner, const MathSize yllcorner, const MathSize xurcorner, const MathSize yurcorner, string &&proj4, map< Location, unsigned char > &&data)
	Constructor.
	GridData (const GridData &rhs)
	Copy constructor.
	GridData (GridData &&rhs) noexcept
	Move constructor.
GridData &	operator= (const GridData &rhs) noexcept
	Copy assignment.
GridData &	operator= (GridData &&rhs) noexcept
	Move assignment.
size_t	size () const
	Size of data structure storing values.
string	saveToFileWithoutRetry (const string &dir, const string &base_name, std::function< R(unsigned char value)> convert, const R no_data) const
	Save GridMap contents to file based on settings.
string	saveToFileWithRetry (const string &dir, const string &base_name, std::function< R(unsigned char value)> convert, const R no_data) const
	Save GridMap contents to file based on settings.
string	saveToFile (const string &dir, const string &base_name, std::function< R(unsigned char value)> convert, const R no_data) const
	Save GridMap contents to file based on settings.
string	saveToFile (const string &dir, const string &base_name, std::function< R(unsigned char value)> convert) const
	Save GridMap contents to file based on settings.
string	saveToFile (const string &dir, const string &base_name) const
	Save GridMap contents to file based on settings.
Public Member Functions inherited from fs::data::Grid< unsigned char, unsigned char >
constexpr Idx	rows () const noexcept
	Number of rows in the GridBase.
constexpr Idx	columns () const noexcept
	Number of columns in the GridBase.
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.
unsigned char	at (const Position< P > &position) const
void	set (const Position< P > &position, const unsigned char value)
Public Member Functions inherited from fs::data::GridBase
	GridBase (GridBase &&rhs) noexcept=default
	Move constructor.
	GridBase (const GridBase &rhs)=default
	Copy constructor.
GridBase &	operator= (const GridBase &rhs)=default
	Copy assignment.
GridBase &	operator= (GridBase &&rhs) noexcept=default
	Move assignment.
constexpr MathSize	cellSize () const noexcept
	Cell size used for GridBase.
constexpr FullIdx	calculateRows () const noexcept
	Number of rows in the GridBase.
constexpr FullIdx	calculateColumns () const noexcept
	Number of columns in the GridBase.
constexpr MathSize	xllcorner () const noexcept
	Lower left corner X coordinate in meters.
constexpr MathSize	yllcorner () const noexcept
	Lower left corner Y coordinate in meters.
constexpr MathSize	xurcorner () const noexcept
	Upper right corner X coordinate in meters.
constexpr MathSize	yurcorner () const noexcept
	Upper right corner Y coordinate in meters.
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, string &&proj4) noexcept
	Constructor.
	GridBase () noexcept
	Default constructor.
void	createPrj (const string &dir, const string &base_name) const
	Create .prj file in directory with base name for file.
unique_ptr< Coordinates >	findCoordinates (const topo::Point &point, bool flipped) const
	Find Coordinates for Point.
unique_ptr< FullCoordinates >	findFullCoordinates (const topo::Point &point, bool flipped) const
	Find FullCoordinates for Point.

Additional Inherited Members
Public Attributes inherited from fs::data::GridData< unsigned char, unsigned char, map< Location, unsigned char > >
map< Location, unsigned char >	data
	Structure that holds data represented by this GridData.
Protected Member Functions inherited from fs::data::GridMap< unsigned char >
tuple< Idx, Idx, Idx, Idx >	dataBounds () const override
Protected Member Functions inherited from fs::data::GridData< unsigned char, unsigned char, map< Location, unsigned char > >
string	saveToAsciiFile (const string &dir, const string &base_name, std::function< R(unsigned char value)> convert, const R no_data) const
	Save GridMap contents to .asc file.
string	saveToTiffFile (const string &dir, const string &base_name, std::function< R(unsigned char value)> convert, const R no_data) const
	Save GridMap contents to .tif file.
Protected Member Functions inherited from fs::data::Grid< unsigned char, unsigned char >
	Grid (const MathSize cell_size, const Idx rows, const Idx columns, const unsigned char nodata_input, const unsigned char nodata_value, const MathSize xllcorner, const MathSize yllcorner, const MathSize xurcorner, const MathSize yurcorner, string &&proj4) noexcept
	Constructor.
	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.

Constructor & Destructor Documentation

BurnedMap()

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

inline

Constructor.

Parameters

perim_grid	Grid representing Perimeter to initialize from
env	Environment to use as base

Here is the call graph for this function:

---

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

• firestarr/src/cpp/Perimeter.cpp