edu.wisc.ssec.mcidasv.data.hydra

Class GranuleAggregation

java.lang.Object

edu.wisc.ssec.mcidasv.data.hydra.GranuleAggregation

All Implemented Interfaces:

MultiDimensionReader

public class GranuleAggregation
extends Object
implements MultiDimensionReader

Provides a view and operations on a set of contiguous data granules as if they were a single granule. This file needs to implement the same signatures NetCDFFile does, but for aggregations of consecutive granules.

Author:

tommyj

Field Summary

Fields

Modifier and Type	Field and Description
private String	crossTrackDimensionName
(package private) Map<Integer,List<Range>>	granCutRanges
(package private) Map<Integer,Integer>	granCutScans
private int	granuleCount
private String	inTrackDimensionName
private String	inTrackGeoDimensionName
private boolean	isVIIRS
private static org.slf4j.Logger	logger
(package private) Map<String,float[]>	lutMap
(package private) List<NetCDFFile>	ncdfal
(package private) List<NetcdfFile>	nclist
private String	origName
private Set<String>	products
(package private) Map<String,QualityFlag>	qfMap
(package private) Map<String,int[]>	varAggrDimLengths
(package private) List<Map<String,Class>>	varDataTypeList
(package private) List<Map<String,String[]>>	varDimNamesList
(package private) Map<String,Map<Integer,Integer>>	varGranInTrackLengths
(package private) List<Map<String,Variable>>	varMapList
(package private) Map<String,RangeProcessor>	varToRangeProcessor

Constructor Summary

Constructors

Constructor and Description
GranuleAggregation(List<NetCDFFile> ncdfal, Set<String> products, String inTrackDimensionName, String crossTrackDimensionName)
GranuleAggregation(List<NetCDFFile> ncdfal, Set<String> products, String inTrackDimensionName, String crossTrackDimensionName, boolean isEDR)
GranuleAggregation(List<NetCDFFile> ncdfal, Set<String> products, String inTrackDimensionName, String inTrackGeoDimensionName, String crossTrackDimensionName)
GranuleAggregation(List<NetCDFFile> ncdfal, Set<String> products, String inTrackDimensionName, String inTrackGeoDimensionName, String crossTrackDimensionName, boolean isVIIRS)

Method Summary

Modifier and Type	Method and Description
void	addRangeProcessor(String arrayName, RangeProcessor rangeProcessor)
void	close()
Object	getArray(String array_name, int[] start, int[] count, int[] stride)
HDFArray	getArrayAttribute(String array_name, String attr_name)
Class	getArrayType(String array_name)
byte[]	getByteArray(String array_name, int[] start, int[] count, int[] stride)
int[]	getDimensionLengths(String array_name)
String[]	getDimensionNames(String array_name)
double[]	getDoubleArray(String array_name, int[] start, int[] count, int[] stride)
float[]	getFloatArray(String array_name, int[] start, int[] count, int[] stride)
HDFArray	getGlobalAttribute(String attr_name)
int[]	getIntArray(String array_name, int[] start, int[] count, int[] stride)
private int	getInTrackIndex(Variable v) Based on the names of the variable dimensions, determine the in-track index.
List<NetCDFFile>	getReaders()
short[]	getShortArray(String array_name, int[] start, int[] count, int[] stride)
Map<String,Variable>	getVarMap()
private void	init(List<NetCDFFile> ncdfal)
private String	mapNameIfLUTVar(String array_name)
private String	mapNameIfQualityFlag(String array_name)
private Object	processArray(String mapName, String array_name, Class arrayType, int granIdx, Object values, RangeProcessor rngProcessor, int[] start, int[] count)
private Object	readArray(String array_name, int[] start, int[] count, int[] stride)
void	setLUTMap(Map<String,float[]> lutMap)
void	setQfMap(Map<String,QualityFlag> qfMap)

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

nclist

List<NetcdfFile> nclist

ncdfal

List<NetCDFFile> ncdfal

varMapList

List<Map<String,Variable>> varMapList

varDimNamesList

List<Map<String,String[]>> varDimNamesList

varDataTypeList

List<Map<String,Class>> varDataTypeList

varGranInTrackLengths

Map<String,Map<Integer,Integer>> varGranInTrackLengths

varAggrDimLengths

Map<String,int[]> varAggrDimLengths

granCutRanges

Map<Integer,List<Range>> granCutRanges

granCutScans

Map<Integer,Integer> granCutScans

qfMap

Map<String,QualityFlag> qfMap

lutMap

Map<String,float[]> lutMap

varToRangeProcessor

Map<String,RangeProcessor> varToRangeProcessor

granuleCount

private int granuleCount

inTrackDimensionName

private String inTrackDimensionName

inTrackGeoDimensionName

private String inTrackGeoDimensionName

crossTrackDimensionName

private String crossTrackDimensionName

products

private Set<String> products

origName

private String origName

isVIIRS

private boolean isVIIRS

Constructor Detail

GranuleAggregation

public GranuleAggregation(List<NetCDFFile> ncdfal,
                          Set<String> products,
                          String inTrackDimensionName,
                          String inTrackGeoDimensionName,
                          String crossTrackDimensionName,
                          boolean isVIIRS)
                   throws Exception

Throws:

Exception

GranuleAggregation

public GranuleAggregation(List<NetCDFFile> ncdfal,
                          Set<String> products,
                          String inTrackDimensionName,
                          String inTrackGeoDimensionName,
                          String crossTrackDimensionName)
                   throws Exception

Throws:

Exception

GranuleAggregation

public GranuleAggregation(List<NetCDFFile> ncdfal,
                          Set<String> products,
                          String inTrackDimensionName,
                          String crossTrackDimensionName)
                   throws Exception

Throws:

Exception

GranuleAggregation

public GranuleAggregation(List<NetCDFFile> ncdfal,
                          Set<String> products,
                          String inTrackDimensionName,
                          String crossTrackDimensionName,
                          boolean isEDR)
                   throws Exception

Throws:

Exception

Method Detail

getArrayType

public Class getArrayType(String array_name)

Specified by:

getArrayType in interface MultiDimensionReader

getDimensionNames

public String[] getDimensionNames(String array_name)

Specified by:

getDimensionNames in interface MultiDimensionReader

getDimensionLengths

public int[] getDimensionLengths(String array_name)

Specified by:

getDimensionLengths in interface MultiDimensionReader

mapNameIfQualityFlag

private String mapNameIfQualityFlag(String array_name)

mapNameIfLUTVar

private String mapNameIfLUTVar(String array_name)

getFloatArray

public float[] getFloatArray(String array_name,
                             int[] start,
                             int[] count,
                             int[] stride)
                      throws Exception

Specified by:

getFloatArray in interface MultiDimensionReader

Throws:

Exception

getIntArray

public int[] getIntArray(String array_name,
                         int[] start,
                         int[] count,
                         int[] stride)
                  throws Exception

Specified by:

getIntArray in interface MultiDimensionReader

Throws:

Exception

getDoubleArray

public double[] getDoubleArray(String array_name,
                               int[] start,
                               int[] count,
                               int[] stride)
                        throws Exception

Specified by:

getDoubleArray in interface MultiDimensionReader

Throws:

Exception

getShortArray

public short[] getShortArray(String array_name,
                             int[] start,
                             int[] count,
                             int[] stride)
                      throws Exception

Specified by:

getShortArray in interface MultiDimensionReader

Throws:

Exception

getByteArray

public byte[] getByteArray(String array_name,
                           int[] start,
                           int[] count,
                           int[] stride)
                    throws Exception

Specified by:

getByteArray in interface MultiDimensionReader

Throws:

Exception

getArray

public Object getArray(String array_name,
                       int[] start,
                       int[] count,
                       int[] stride)
                throws Exception

Specified by:

getArray in interface MultiDimensionReader

Throws:

Exception

getGlobalAttribute

public HDFArray getGlobalAttribute(String attr_name)
                            throws Exception

Specified by:

getGlobalAttribute in interface MultiDimensionReader

Throws:

Exception

getArrayAttribute

public HDFArray getArrayAttribute(String array_name,
                                  String attr_name)
                           throws Exception

Specified by:

getArrayAttribute in interface MultiDimensionReader

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface MultiDimensionReader

Throws:

Exception

init

private void init(List<NetCDFFile> ncdfal)
           throws Exception

Throws:

Exception

getInTrackIndex

private int getInTrackIndex(Variable v)

Based on the names of the variable dimensions, determine the in-track index.

Parameters:

v - Variable that "contains" dimension names that allow for inference of the in-track index. null is allowed.

Returns:

correct index (0 or greater), or -1 if error.

readArray

private Object readArray(String array_name,
                         int[] start,
                         int[] count,
                         int[] stride)
                  throws Exception

Throws:

Exception

setQfMap

public void setQfMap(Map<String,QualityFlag> qfMap)

Parameters:

qfMap - the qfMap to set

setLUTMap

public void setLUTMap(Map<String,float[]> lutMap)

Parameters:

lutMap - the lutMap to set

getVarMap

public Map<String,Variable> getVarMap()

getReaders

public List<NetCDFFile> getReaders()

processArray

private Object processArray(String mapName,
                            String array_name,
                            Class arrayType,
                            int granIdx,
                            Object values,
                            RangeProcessor rngProcessor,
                            int[] start,
                            int[] count)

addRangeProcessor

public void addRangeProcessor(String arrayName,
                              RangeProcessor rangeProcessor)