Class EnergySchemeWithSharedFeatures
Object
org.anchoranalysis.mpp.feature.energy.scheme.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 newEnergySchemeWithSharedFeatures. -
Method Summary
Modifier and Type Method Description AddCriteriaEnergyPaircreateAddCriteria()Creates anAddCriteriaEnergyPairbased on the energy scheme.EnergySchemegetEnergyScheme()The energy scheme used for calculations.RegionMapgetRegionMap()Gets the region map from the energy scheme.SharedFeaturesgetSharedFeatures()Shared features used across calculations.EnergyTotaltotalAll(EnergyMemoList pxlMarkMemoList, EnergyStackWithoutParameters raster)Calculates the total energy for all marks in the list.EnergyTotaltotalIndividual(VoxelizedMarkMemo pmm, EnergyStackWithoutParameters raster)Calculates the total energy for an individual mark.
-
Constructor Details
-
EnergySchemeWithSharedFeatures
public EnergySchemeWithSharedFeatures(EnergyScheme energyScheme, SharedFeatures sharedFeatures, Logger logger)Creates a newEnergySchemeWithSharedFeatures.- Parameters:
energyScheme- the energy scheme to usesharedFeatures- the shared features to uselogger- the logger for reporting messages
-
-
Method Details
-
totalAll
public EnergyTotal totalAll(EnergyMemoList pxlMarkMemoList, EnergyStackWithoutParameters raster) throws NamedFeatureCalculateExceptionCalculates the total energy for all marks in the list.- Parameters:
pxlMarkMemoList- the list of energy memosraster- the energy stack without parameters- Returns:
- the total energy
- Throws:
NamedFeatureCalculateException- if the calculation fails
-
totalIndividual
public EnergyTotal totalIndividual(VoxelizedMarkMemo pmm, EnergyStackWithoutParameters raster) throws NamedFeatureCalculateExceptionCalculates the total energy for an individual mark.- Parameters:
pmm- the voxelized mark memoraster- the energy stack without parameters- Returns:
- the total energy
- Throws:
NamedFeatureCalculateException- if the calculation fails
-
createAddCriteria
Creates anAddCriteriaEnergyPairbased on the energy scheme.- Returns:
- the created AddCriteriaEnergyPair
- Throws:
CreateException- if creation fails
-
getRegionMap
Gets the region map from the energy scheme.- Returns:
- the region map
-
getEnergyScheme
The energy scheme used for calculations. -
getSharedFeatures
Shared features used across calculations.
-