carta::RegionStatistics Class Reference

#include <RegionStatistics.h>

Collaboration diagram for carta::RegionStatistics:

Public Member Functions
	RegionStatistics ()=default
	Default constructor.
	RegionStatistics (int region_id, int file_id, const std::vector< CARTA::SetStatsRequirements_StatsConfig > &configs)
	Constructor which sets stats configurations.
void	SetConfigurations (int file_id, const std::vector< CARTA::SetStatsRequirements_StatsConfig > &configs)
	Set statistics configurations.
bool	GetConfigurations (int file_id, std::vector< CARTA::SetStatsRequirements_StatsConfig > &configs)
	Get statistics configurations for file id.
std::vector< int >	GetConfigFileIds (int file_id)
	Get file ids in configurations which match file id.
bool	GetRegionStatsData (int file_id, std::shared_ptr< Frame > frame, const CARTA::SetStatsRequirements_StatsConfig &config, StokesRegion &stokes_region, CARTA::RegionStatsData &stats_data_message)
	Add cached or calculated statistics to message.
void	ClearCache ()
	Clear cache when region changes.
void	ClearFileConfigsCache (int file_id)
	Clear configurations and cache for file id.

Private Member Functions
bool	AddCachedStatistics (CacheId &cache_id, const CARTA::SetStatsRequirements_StatsConfig &config, CARTA::RegionStatsData &stats_data_message)
	Add statistics from cache if it exists.

Private Attributes
int	_region_id
	Region id for this object, for config and cache ids.
std::unordered_map< ConfigId, RegionStatsConfig, ConfigIdHash >	_configs
	Requirements map.
std::unordered_map< CacheId, StatsCache, CacheIdHash >	_cache
	Cache to hold calculations.

Constructor & Destructor Documentation

RegionStatistics() [1/2]

carta::RegionStatistics::RegionStatistics ( )

default

Default constructor.

RegionStatistics() [2/2]

RegionStatistics::RegionStatistics	(	int	region_id,
		int	file_id,
		const std::vector< CARTA::SetStatsRequirements_StatsConfig > &	configs
	)

Constructor which sets stats configurations.

Parameters

region_id	Region id for statistics
file_id	File id for image frame
configs	Stats configurations

Here is the call graph for this function:

Member Function Documentation

AddCachedStatistics()

bool carta::RegionStatistics::AddCachedStatistics ( CacheId &  cache_id, const CARTA::SetStatsRequirements_StatsConfig &  config, CARTA::RegionStatsData &  stats_data_message  )

private

Add statistics from cache if it exists.

Parameters

[in]	cache_id	CacheId struct
[in]	config	Stats configuration
[in,out]	stats_data_message	Region stats data message

Returns

Whether cached stats was added

ClearCache()

void RegionStatistics::ClearCache

(

)

Clear cache when region changes.

ClearFileConfigsCache()

void RegionStatistics::ClearFileConfigsCache

(

int

file_id

)

Clear configurations and cache for file id.

GetConfigFileIds()

std::vector< int > RegionStatistics::GetConfigFileIds

(

int

file_id

)

Get file ids in configurations which match file id.

Parameters

file_id

File id for image frame

Returns

File ids

GetConfigurations()

bool RegionStatistics::GetConfigurations	(	int	file_id,
		std::vector< CARTA::SetStatsRequirements_StatsConfig > &	configs
	)

Get statistics configurations for file id.

Parameters

[in]	file_id	File id for image frame
[out]	configs	Statistics configurations

Returns

Whether configs exist for file id

GetRegionStatsData()

bool RegionStatistics::GetRegionStatsData	(	int	file_id,
		std::shared_ptr< Frame >	frame,
		const CARTA::SetStatsRequirements_StatsConfig &	config,
		StokesRegion &	stokes_region,
		CARTA::RegionStatsData &	stats_data_message
	)

Add cached or calculated statistics to message.

Parameters

[in]	file_id	File id for image frame
[in]	frame	Image frame
[in]	config	Statistics configuration
[in]	stokes_region	Struct holding image region and struct describing stokes and z range
[in,out]	stats_data_message	Region stats data message

Returns

Whether statistics were added

Here is the call graph for this function:

SetConfigurations()

void RegionStatistics::SetConfigurations	(	int	file_id,
		const std::vector< CARTA::SetStatsRequirements_StatsConfig > &	configs
	)

Set statistics configurations.

Parameters

file_id	File id for image frame
configs	Stats configurations

Here is the caller graph for this function:

Member Data Documentation

_cache

std::unordered_map<CacheId, StatsCache, CacheIdHash> carta::RegionStatistics::_cache

private

Cache to hold calculations.

_configs

std::unordered_map<ConfigId, RegionStatsConfig, ConfigIdHash> carta::RegionStatistics::_configs

private

Requirements map.

_region_id

int carta::RegionStatistics::_region_id

private

Region id for this object, for config and cache ids.

---

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

• RegionStatistics.h
• RegionStatistics.cc