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

The base class with information for a grid of data with geographic coordinates. More...

#include <Grid.h>

Inheritance diagram for fs::GridBase:
Collaboration diagram for fs::GridBase:

Public Member Functions

 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

string proj4_ {}
 Proj4 string defining projection.
 
MathSize cell_size_ {-1}
 Cell height and width in metres.
 
MathSize xllcorner_ {-1}
 Lower left corner X coordinate in metres.
 
MathSize yllcorner_ {-1}
 Lower left corner Y coordinate in metres.
 
MathSize xurcorner_ {-1}
 Upper right corner X coordinate in metres.
 
MathSize yurcorner_ {-1}
 Upper right corner Y coordinate in metres.
 

Detailed Description

The base class with information for a grid of data with geographic coordinates.

Constructor & Destructor Documentation

◆ GridBase()

fs::GridBase::GridBase ( MathSize cell_size,
MathSize xllcorner,
MathSize yllcorner,
MathSize xurcorner,
MathSize yurcorner,
const string_view proj4 )
noexcept

Constructor.

Parameters
cell_sizeCell width and height (m)
xllcornerLower left corner X coordinate (m)
yllcornerLower left corner Y coordinate (m)
xurcornerUpper right corner X coordinate (m)
yurcornerUpper right corner Y coordinate (m)
proj4Proj4 projection definition

Member Function Documentation

◆ cellSize()

MathSize fs::GridBase::cellSize ( ) const
inlinenodiscardconstexprnoexcept

Cell size used for GridBase.

Returns
Cell height and width in metres.
Here is the caller graph for this function:

◆ createPrj()

void fs::GridBase::createPrj ( const string_view dir,
const string_view base_name ) const

Create .prj file in directory with base name for file.

Parameters
dirDirectory to create in
base_namebase file name for .prj file
Here is the caller graph for this function:

◆ findCoordinates()

std::optional< Coordinates > fs::GridBase::findCoordinates ( const Point & point,
bool flipped ) const
nodiscard

Find Coordinates for Point.

Parameters
pointPoint to translate to Grid Coordinate
flippedWhether or not Grid data is flipped along x axis
Returns
Coordinates for Point translated to Grid
Here is the call graph for this function:
Here is the caller graph for this function:

◆ findFullCoordinates()

std::optional< FullCoordinates > fs::GridBase::findFullCoordinates ( const Point & point,
bool flipped ) const
nodiscard

Find FullCoordinates for Point.

Parameters
pointPoint to translate to Grid Coordinate
flippedWhether or not Grid data is flipped along x axis
Returns
Coordinates for Point translated to Grid
Here is the caller graph for this function:

◆ proj4()

const string & fs::GridBase::proj4 ( ) const
inlinenodiscardconstexprnoexcept

Proj4 string defining coordinate system for this grid. Must be a UTM projection.

Returns
Proj4 string defining coordinate system for this grid.
Here is the caller graph for this function:

◆ xllcorner()

MathSize fs::GridBase::xllcorner ( ) const
inlinenodiscardconstexprnoexcept

Lower left corner X coordinate in metres.

Returns
Lower left corner X coordinate in metres.
Here is the caller graph for this function:

◆ xurcorner()

MathSize fs::GridBase::xurcorner ( ) const
inlinenodiscardconstexprnoexcept

Upper right corner X coordinate in metres.

Returns
Upper right corner X coordinate in metres.
Here is the caller graph for this function:

◆ yllcorner()

MathSize fs::GridBase::yllcorner ( ) const
inlinenodiscardconstexprnoexcept

Lower left corner Y coordinate in metres.

Returns
Lower left corner Y coordinate in metres.
Here is the caller graph for this function:

◆ yurcorner()

MathSize fs::GridBase::yurcorner ( ) const
inlinenodiscardconstexprnoexcept

Upper right corner Y coordinate in metres.

Returns
Upper right corner Y coordinate in metres.
Here is the caller graph for this function:

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