public abstract class AbstractFireHistoryReader extends java.lang.Object implements IFHAESReader
Modifier and Type | Field and Description |
---|---|
private static org.slf4j.Logger |
log |
private boolean |
needToPopulateSeriesList |
protected java.util.ArrayList<FHSeries> |
seriesList |
Constructor and Description |
---|
AbstractFireHistoryReader() |
Modifier and Type | Method and Description |
---|---|
java.util.ArrayList<java.lang.Integer> |
getCompositeFireYears(EventTypeToProcess eventsToProcess,
FireFilterType filterType,
double filterValue,
int minNumberOfSamples)
Returns an ArrayList of years which fulfill the composite filter options specified.
|
double[] |
getPercentScarred(EventTypeToProcess eventTypeToProcess)
Returns an array of doubles with size equal to the number of years in the file.
|
int[] |
getRecordingDepths()
Returns an array of ints with size equal to the number of years in the file.
|
int[] |
getSampleDepths()
Returns an array of ints with size equal to the number of years in the file.
|
java.util.ArrayList<FHSeries> |
getSeriesList()
Get an ArrayList of FHSeries classes, each representing a single series in the data file.
|
protected abstract void |
populateSeriesList()
Construct a list of FHSeries, one for each series in the file.
|
void |
replaceSeriesList(java.util.ArrayList<FHSeries> inSeriesList)
Replaces the existing series list with the input list.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getBadDataLineNumbers, getBarkIndexPerTree, getCalosperSample2d, getCalosYearperSample2d, getCapsperSample2d, getCapsYearperSample2d, getData, getEventDataArrays, getFile, getFileFormat, getFilterArrays, getFireEventsArray, getFiresAndInjuriesArray, getFirstFireYear, getFirstIndicatorYear, getFirstInjuryYear, getFirstYear, getInnerMostperTree, getInnerMostYearPerTree, getLastYear, getLastYearIndexPerSample, getLastYearPerSample, getLengthOfSeriesName, getName, getNumberOfSeries, getOtherInjuriesArray, getOuterMostYearPerTree, getOutterMostperTree, getPithIndexPerSample, getRawRowData, getRecorderYears2DArray, getSeriesNameArray, getStartYearIndexPerSample, getStartYearPerSample, getTotalRecorderYearsPerSample, getTotals, getYearArray, hasFireEvents, hasFireEventsOrInjuries, hasInjuryEvents, makeDecompSyb2d, passesBasicSyntaxCheck
private static final org.slf4j.Logger log
protected java.util.ArrayList<FHSeries> seriesList
private boolean needToPopulateSeriesList
protected abstract void populateSeriesList()
public void replaceSeriesList(java.util.ArrayList<FHSeries> inSeriesList)
seriesList
- public java.util.ArrayList<FHSeries> getSeriesList()
public int[] getSampleDepths()
public int[] getRecordingDepths()
public double[] getPercentScarred(EventTypeToProcess eventTypeToProcess)
eventTypeToProcess
- - whether to calculate the percentage based on fire events, injury events, or both.public java.util.ArrayList<java.lang.Integer> getCompositeFireYears(EventTypeToProcess eventsToProcess, FireFilterType filterType, double filterValue, int minNumberOfSamples)
eventsToProcess
- - whether to calculate the composite based on fire events, injury events, or bothfilterType
- - whether to filter on absolute numbers of fires, or percentage of recording treesfilterValue
- - either the number of samples or percentage of samples that must be scared before the year is included in the
compositeminNumberOfSamples
- - The minimum number of samples that must be in recording status for the year to be considered for
inclusion in the composite, regardless of filterValue.