te::rst::RasterSummaryManager Class Reference

A singleton for keeping raster summaries (most statistics). It stores an internal map of raster conn info str and their respective summaries. More...

#include <RasterSummaryManager.h>

Inheritance diagram for te::rst::RasterSummaryManager:
te::common::Singleton< RasterSummaryManager >

Public Member Functions

void add (const Raster *raster, RasterSummary *summary)
 Adds a new entry in the summary manager. More...
 
const RasterSummaryfind (const Raster *raster) const
 It searches for a raster summary. More...
 
const RasterSummaryget (const Raster *raster, const SummaryTypes st, bool readall=false)
 It searches for a raster summary. If not found it creates the summary and returns it. More...
 
void remove (const Raster *raster)
 Removes the summary from the specified raster. More...
 
 ~RasterSummaryManager ()
 Destructor. More...
 

Static Public Member Functions

static RasterSummaryManagergetInstance ()
 It returns a reference to the singleton instance. More...
 

Protected Member Functions

 RasterSummaryManager ()
 Constructor. More...
 

Private Attributes

std::map< std::string, RasterSummary * > m_rasterSummaries
 A map of rasters conn info and their respective summaries. More...
 

Friends

class te::common::Singleton< RasterSummaryManager >
 

Detailed Description

A singleton for keeping raster summaries (most statistics). It stores an internal map of raster conn info str and their respective summaries.

See also
RasterSummary, BandSummary.

Definition at line 56 of file RasterSummaryManager.h.

Constructor & Destructor Documentation

te::rst::RasterSummaryManager::~RasterSummaryManager ( )

Destructor.

te::rst::RasterSummaryManager::RasterSummaryManager ( )
protected

Constructor.

Member Function Documentation

void te::rst::RasterSummaryManager::add ( const Raster raster,
RasterSummary summary 
)

Adds a new entry in the summary manager.

Parameters
rasterThe raster to be added.
summaryThe raster summary of the respective raster. The manager will take its ownership.
Note
If the raster was already added, the summary will be replaced.
const RasterSummary* te::rst::RasterSummaryManager::find ( const Raster raster) const

It searches for a raster summary.

Parameters
rasterThe raster to be found.
Returns
The calculated raster summary, or a null summary otherwise.
const RasterSummary* te::rst::RasterSummaryManager::get ( const Raster raster,
const SummaryTypes  st,
bool  readall = false 
)

It searches for a raster summary. If not found it creates the summary and returns it.

Parameters
rasterThe raster to be found.
typesThe desired types of summary to be calculated (min, max, ...).
readallForce the reading the entire image (can be slow) for computing min and max values.
Returns
The calculated raster summary.
static RasterSummaryManager & te::common::Singleton< RasterSummaryManager >::getInstance ( )
staticinherited

It returns a reference to the singleton instance.

Returns
A reference to the singleton instance.
void te::rst::RasterSummaryManager::remove ( const Raster raster)

Removes the summary from the specified raster.

Parameters
rasterThe raster to remove the summary.

Friends And Related Function Documentation

Definition at line 58 of file RasterSummaryManager.h.

Member Data Documentation

std::map<std::string, RasterSummary*> te::rst::RasterSummaryManager::m_rasterSummaries
private

A map of rasters conn info and their respective summaries.

Definition at line 110 of file RasterSummaryManager.h.


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