Package hec.hecmath

Class MassBalancedEvent

java.lang.Object

hec.hecmath.MassBalancedEvent

public class MassBalancedEvent
extends Object

This class performs computations on Balanced Hydrographs and Balanced Hyetographs, to preserve water mass

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MassBalancedEvent.AverageData
static enum	MassBalancedEvent.DataType

Constructor Summary

Constructors

Constructor	Description
MassBalancedEvent()
MassBalancedEvent(double[] values, long[] times, long dataDuration, double[] avgTargetValues, long[] avgTargetDurations, MassBalancedEvent.DataType dataType)
MassBalancedEvent(TimeSeriesContainer tsc, long dataDuration, double[] avgTargetValues, long[] avgTargetDurations, MassBalancedEvent.DataType dataType)

Method Summary

Modifier and Type	Method	Description
void	balanceEvent()
static double	computeMaximumAverageValue(int encompassedStartIndex, double[] values, int intervalsPerDuration, int[] startIndex, int[] endIndex, MassBalancedEvent.DataType dt)
void	computePeakDurationTimeWindowInformation()
void	findPeakAverageData(MassBalancedEvent.AverageData data, double[] values, long[] times, boolean isBasisFlow, MassBalancedEvent.AverageData encompassingData)
double[]	getBalancedValues()
Map<Long,Double>	getDurationMagnitudeMap()
NavigableMap<Long,long[]>	getTimeWindowMap()
boolean	isInst()
void	setBalanceEntireEvent(boolean b)
void	setData(double[] values, int[] times, long dataDuration, double[] avgTargetValues, long[] avgTargetDurations, MassBalancedEvent.DataType dataType)
void	setData(TimeSeriesContainer tsc, long dataDuration, double[] avgTargetValues, long[] avgTargetDurations, MassBalancedEvent.DataType dataType)
void	setDataType(MassBalancedEvent.DataType dt)
void	setForceCoincidentEvents(boolean b)
void	setPrimaryDuration(long duration)
void	setTimeWindowMap(NavigableMap<Long,long[]> twMap)

Methods inherited from class java.lang.Object

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

Constructor Details

MassBalancedEvent

public MassBalancedEvent()

MassBalancedEvent

public MassBalancedEvent(TimeSeriesContainer tsc,
 long dataDuration,
 double[] avgTargetValues,
 long[] avgTargetDurations,
 MassBalancedEvent.DataType dataType)

MassBalancedEvent

public MassBalancedEvent(double[] values,
 long[] times,
 long dataDuration,
 double[] avgTargetValues,
 long[] avgTargetDurations,
 MassBalancedEvent.DataType dataType)

Method Details

setData

public void setData(TimeSeriesContainer tsc,
 long dataDuration,
 double[] avgTargetValues,
 long[] avgTargetDurations,
 MassBalancedEvent.DataType dataType)

getDurationMagnitudeMap

public Map<Long,Double> getDurationMagnitudeMap()

setData

public void setData(double[] values,
 int[] times,
 long dataDuration,
 double[] avgTargetValues,
 long[] avgTargetDurations,
 MassBalancedEvent.DataType dataType)

setTimeWindowMap

public void setTimeWindowMap(NavigableMap<Long,long[]> twMap)

getTimeWindowMap

public NavigableMap<Long,long[]> getTimeWindowMap()

setPrimaryDuration

public void setPrimaryDuration(long duration)

computePeakDurationTimeWindowInformation

public void computePeakDurationTimeWindowInformation()
                                              throws ComputationException

Throws:

ComputationException

balanceEvent

public void balanceEvent()
                  throws ComputationException

Throws:

ComputationException

findPeakAverageData

public void findPeakAverageData(MassBalancedEvent.AverageData data,
 double[] values,
 long[] times,
 boolean isBasisFlow,
 MassBalancedEvent.AverageData encompassingData)

computeMaximumAverageValue

public static double computeMaximumAverageValue(int encompassedStartIndex,
 double[] values,
 int intervalsPerDuration,
 int[] startIndex,
 int[] endIndex,
 MassBalancedEvent.DataType dt)

setForceCoincidentEvents

public void setForceCoincidentEvents(boolean b)

getBalancedValues

public double[] getBalancedValues()

setBalanceEntireEvent

public void setBalanceEntireEvent(boolean b)

setDataType

public void setDataType(MassBalancedEvent.DataType dt)

isInst

public boolean isInst()