Package org.anchoranalysis.mpp.feature.energy.scheme

Class EnergySchemeWithSharedFeatures

Object

EnergySchemeWithSharedFeatures

public class EnergySchemeWithSharedFeatures
extends Object

Combines an EnergyScheme with SharedFeatures for energy calculations.

Constructor Summary

Constructors

Constructor	Description
EnergySchemeWithSharedFeatures(EnergyScheme energyScheme, SharedFeatures sharedFeatures, Logger logger)	Creates a new EnergySchemeWithSharedFeatures.

Method Summary

Modifier and Type	Method	Description
AddCriteriaEnergyPair	createAddCriteria()	Creates an AddCriteriaEnergyPair based on the energy scheme.
EnergyScheme	getEnergyScheme()	The energy scheme used for calculations.
RegionMap	getRegionMap()	Gets the region map from the energy scheme.
SharedFeatures	getSharedFeatures()	Shared features used across calculations.
EnergyTotal	totalAll(EnergyMemoList pxlMarkMemoList, EnergyStackWithoutParameters raster)	Calculates the total energy for all marks in the list.
EnergyTotal	totalIndividual(VoxelizedMarkMemo pmm, EnergyStackWithoutParameters raster)	Calculates the total energy for an individual mark.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EnergySchemeWithSharedFeatures

public EnergySchemeWithSharedFeatures(EnergyScheme energyScheme,
 SharedFeatures sharedFeatures,
 Logger logger)

Creates a new EnergySchemeWithSharedFeatures.

Parameters:

energyScheme - the energy scheme to use

sharedFeatures - the shared features to use

logger - the logger for reporting messages

Method Details

totalAll

public EnergyTotal totalAll(EnergyMemoList pxlMarkMemoList,
 EnergyStackWithoutParameters raster)
                     throws NamedFeatureCalculateException

Calculates the total energy for all marks in the list.

Parameters:

pxlMarkMemoList - the list of energy memos

raster - the energy stack without parameters

Returns:

the total energy

Throws:

NamedFeatureCalculateException - if the calculation fails

totalIndividual

public EnergyTotal totalIndividual(VoxelizedMarkMemo pmm,
 EnergyStackWithoutParameters raster)
                            throws NamedFeatureCalculateException

Calculates the total energy for an individual mark.

Parameters:

pmm - the voxelized mark memo

raster - the energy stack without parameters

Returns:

the total energy

Throws:

NamedFeatureCalculateException - if the calculation fails

createAddCriteria

public AddCriteriaEnergyPair createAddCriteria()
                                        throws CreateException

Creates an AddCriteriaEnergyPair based on the energy scheme.

Returns:

the created AddCriteriaEnergyPair

Throws:

CreateException - if creation fails

getRegionMap

public RegionMap getRegionMap()

Gets the region map from the energy scheme.

Returns:

the region map

getEnergyScheme

public EnergyScheme getEnergyScheme()

The energy scheme used for calculations.

getSharedFeatures

public SharedFeatures getSharedFeatures()

Shared features used across calculations.