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 java.lang.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 java.lang.String	crossTrackDimensionName
(package private) java.util.Map<java.lang.Integer,java.util.List<ucar.ma2.Range>>	granCutRanges
(package private) java.util.Map<java.lang.Integer,java.lang.Integer>	granCutScans
private int	granuleCount
private java.lang.String	inTrackDimensionName
private java.lang.String	inTrackGeoDimensionName
private boolean	isVIIRS
private static org.slf4j.Logger	logger
(package private) java.util.Map<java.lang.String,float[]>	lutMap
(package private) java.util.List<NetCDFFile>	ncdfal
(package private) java.util.List<ucar.nc2.NetcdfFile>	nclist
private java.lang.String	origName
private java.util.Set<java.lang.String>	products
(package private) java.util.Map<java.lang.String,QualityFlag>	qfMap
(package private) java.util.Map<java.lang.String,int[]>	varAggrDimLengths
(package private) java.util.List<java.util.Map<java.lang.String,java.lang.Class>>	varDataTypeList
(package private) java.util.List<java.util.Map<java.lang.String,java.lang.String[]>>	varDimNamesList
(package private) java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,java.lang.Integer>>	varGranInTrackLengths
(package private) java.util.List<java.util.Map<java.lang.String,ucar.nc2.Variable>>	varMapList
(package private) java.util.Map<java.lang.String,RangeProcessor>	varToRangeProcessor

Constructor Summary

Constructors

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

Method Summary

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

java.util.List<ucar.nc2.NetcdfFile> nclist

ncdfal

java.util.List<NetCDFFile> ncdfal

varMapList

java.util.List<java.util.Map<java.lang.String,ucar.nc2.Variable>> varMapList

varDimNamesList

java.util.List<java.util.Map<java.lang.String,java.lang.String[]>> varDimNamesList

varDataTypeList

java.util.List<java.util.Map<java.lang.String,java.lang.Class>> varDataTypeList

varGranInTrackLengths

java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,java.lang.Integer>> varGranInTrackLengths

varAggrDimLengths

java.util.Map<java.lang.String,int[]> varAggrDimLengths

granCutRanges

java.util.Map<java.lang.Integer,java.util.List<ucar.ma2.Range>> granCutRanges

granCutScans

java.util.Map<java.lang.Integer,java.lang.Integer> granCutScans

qfMap

java.util.Map<java.lang.String,QualityFlag> qfMap

lutMap

java.util.Map<java.lang.String,float[]> lutMap

varToRangeProcessor

java.util.Map<java.lang.String,RangeProcessor> varToRangeProcessor

granuleCount

private int granuleCount

inTrackDimensionName

private java.lang.String inTrackDimensionName

inTrackGeoDimensionName

private java.lang.String inTrackGeoDimensionName

crossTrackDimensionName

private java.lang.String crossTrackDimensionName

products

private java.util.Set<java.lang.String> products

origName

private java.lang.String origName

isVIIRS

private boolean isVIIRS

Constructor Detail

GranuleAggregation

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

Throws:

java.lang.Exception

GranuleAggregation

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

Throws:

java.lang.Exception

GranuleAggregation

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

Throws:

java.lang.Exception

GranuleAggregation

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

Throws:

java.lang.Exception

Method Detail

getArrayType

public java.lang.Class getArrayType(java.lang.String array_name)

Specified by:

getArrayType in interface MultiDimensionReader

getDimensionNames

public java.lang.String[] getDimensionNames(java.lang.String array_name)

Specified by:

getDimensionNames in interface MultiDimensionReader

getDimensionLengths

public int[] getDimensionLengths(java.lang.String array_name)

Specified by:

getDimensionLengths in interface MultiDimensionReader

mapNameIfQualityFlag

private java.lang.String mapNameIfQualityFlag(java.lang.String array_name)

mapNameIfLUTVar

private java.lang.String mapNameIfLUTVar(java.lang.String array_name)

getFloatArray

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

Specified by:

getFloatArray in interface MultiDimensionReader

Throws:

java.lang.Exception

getIntArray

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

Specified by:

getIntArray in interface MultiDimensionReader

Throws:

java.lang.Exception

getDoubleArray

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

Specified by:

getDoubleArray in interface MultiDimensionReader

Throws:

java.lang.Exception

getShortArray

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

Specified by:

getShortArray in interface MultiDimensionReader

Throws:

java.lang.Exception

getByteArray

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

Specified by:

getByteArray in interface MultiDimensionReader

Throws:

java.lang.Exception

getArray

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

Specified by:

getArray in interface MultiDimensionReader

Throws:

java.lang.Exception

getGlobalAttribute

public HDFArray getGlobalAttribute(java.lang.String attr_name)
                            throws java.lang.Exception

Specified by:

getGlobalAttribute in interface MultiDimensionReader

Throws:

java.lang.Exception

getArrayAttribute

public HDFArray getArrayAttribute(java.lang.String array_name,
                                  java.lang.String attr_name)
                           throws java.lang.Exception

Specified by:

getArrayAttribute in interface MultiDimensionReader

Throws:

java.lang.Exception

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface MultiDimensionReader

Throws:

java.lang.Exception

init

private void init(java.util.List<NetCDFFile> ncdfal)
           throws java.lang.Exception

Throws:

java.lang.Exception

getInTrackIndex

private int getInTrackIndex(ucar.nc2.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 java.lang.Object readArray(java.lang.String array_name,
                                   int[] start,
                                   int[] count,
                                   int[] stride)
                            throws java.lang.Exception

Throws:

java.lang.Exception

setQfMap

public void setQfMap(java.util.Map<java.lang.String,QualityFlag> qfMap)

Parameters:

qfMap - the qfMap to set

setLUTMap

public void setLUTMap(java.util.Map<java.lang.String,float[]> lutMap)

Parameters:

lutMap - the lutMap to set

getVarMap

public java.util.Map<java.lang.String,ucar.nc2.Variable> getVarMap()

getReaders

public java.util.List<NetCDFFile> getReaders()

processArray

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

addRangeProcessor

public void addRangeProcessor(java.lang.String arrayName,
                              RangeProcessor rangeProcessor)