sgspy.utils.raster.StratRasterBandMetadata

Public Member Functions
	__init__ (self, bool mapped, int strata_count, list[str] band_metadata=[], list[tuple[str, int]] mapped_band_metadata=[])
	print_info (self)
	get_num_strata (self)

Public Attributes
	mapped = mapped
	band_metadata = band_metadata
	mapped_band_metadata = mapped_band_metadata
	strata_count = strata_count

Detailed Description

The StratRasterBandMetadata class is meant to be used to store info on a particular
strat band. This includes: whether it is mapped or not, the number of strata,
metadata on bands, and metadata on mapped bands.

The metadata will be used later to print important info regarding a strat band. It
is also used to not require the user to put the number of strata for functions which
require it, if the input is a strat raster created by another sgspy stratification function.

Constructor & Destructor Documentation

__init__()

sgspy.utils.raster.StratRasterBandMetadata.__init__	(		self,
		bool	mapped,
		int	strata_count,
		list[str]	band_metadata = [],
		list[tuple[str, int]]	mapped_band_metadata = [] )

constructor for StratRasterBandMetdata. Sets the class members to the parameters.

Member Function Documentation

get_num_strata()

sgspy.utils.raster.StratRasterBandMetadata.get_num_strata

(

self

)

print_info()

sgspy.utils.raster.StratRasterBandMetadata.print_info

(

self

)

this function prints the metadata to the console, which is different 
depending on whether the band is a mapped band or not.

Member Data Documentation

band_metadata

sgspy.utils.raster.StratRasterBandMetadata.band_metadata = band_metadata

mapped

sgspy.utils.raster.StratRasterBandMetadata.mapped = mapped

mapped_band_metadata

sgspy.utils.raster.StratRasterBandMetadata.mapped_band_metadata = mapped_band_metadata

strata_count

sgspy.utils.raster.StratRasterBandMetadata.strata_count = strata_count

---

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

• sgspy/utils/raster.py