edu.wisc.ssec.mcidasv.data.hydra

Class RangeProcessor

java.lang.Object

edu.wisc.ssec.mcidasv.data.hydra.RangeProcessor

Direct Known Subclasses:

AggregationRangeProcessor, CloudSat_2B_GEOPROF_RangeProcessor, CrIS_RangeProcessor, IASI_RangeProcessor, RadianceToBTbyLUT, ReflSolzenCorr

public class RangeProcessor
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	hasMultiDimensionScale
private static org.slf4j.Logger	logger
(package private) Map<String,Object>	metadata
(package private) double[]	missing
(package private) int	multiScaleDimensionIndex
(package private) String	multiScaleDimName
(package private) float[]	offset
(package private) boolean	rangeCheckBeforeScaling
(package private) MultiDimensionReader	reader
(package private) float[]	scale
(package private) int	scaleOffsetLen
(package private) int	soIndex
(package private) boolean	unpack
(package private) boolean	unsigned
(package private) double	valid_high
(package private) double	valid_low
(package private) double[]	valid_range

Constructor Summary

Constructors

Constructor and Description
RangeProcessor()
RangeProcessor(float scale, float offset, float valid_low, float valid_high, float missing)
RangeProcessor(MultiDimensionReader reader, Map<String,Object> metadata)
RangeProcessor(MultiDimensionReader reader, Map<String,Object> metadata, String multiScaleDimName)

Method Summary

Modifier and Type	Method and Description
(package private) static RangeProcessor	createRangeProcessor(MultiDimensionReader reader, Map<String,Object> metadata)
double[]	getAttributeAsDoubleArray(String arrayName, String attrName)
float[]	getAttributeAsFloatArray(String arrayName, String attrName)
int	getMultiScaleDimensionIndex()
boolean	hasMultiDimensionScale()
float[]	processRange(byte[] values, Map<String,double[]> subset) Process a range of data from an array of byte values.
double[]	processRange(double[] values, Map<String,double[]> subset) Process a range of data from an array of double value.
float[]	processRange(float[] values, Map<String,double[]> subset) Process a range of data from an array of float values.
float[]	processRange(short[] values, Map<String,double[]> subset) Process a range of data from an array of short values.
Object	processRangeApplyLUT(short[] values, float[] lut) Should be generalized.
float[]	processRangeQualityFlag(byte[] values, Map subset, QualityFlag qf) Process a range of data from an array of byte values where bytes are packed bit or multi-bit fields of quality flags.
void	setHasMultiDimensionScale(boolean yesno)
void	setMultiScaleDimName(String multiScaleDimName)
void	setMultiScaleIndex(int idx)

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

reader

MultiDimensionReader reader

metadata

Map<String,Object> metadata

scale

float[] scale

offset

float[] offset

missing

double[] missing

valid_range

double[] valid_range

valid_low

double valid_low

valid_high

double valid_high

unpack

boolean unpack

unsigned

boolean unsigned

rangeCheckBeforeScaling

boolean rangeCheckBeforeScaling

scaleOffsetLen

int scaleOffsetLen

multiScaleDimName

String multiScaleDimName

hasMultiDimensionScale

boolean hasMultiDimensionScale

multiScaleDimensionIndex

int multiScaleDimensionIndex

soIndex

int soIndex

Constructor Detail

RangeProcessor

public RangeProcessor()

RangeProcessor

public RangeProcessor(float scale,
                      float offset,
                      float valid_low,
                      float valid_high,
                      float missing)

RangeProcessor

public RangeProcessor(MultiDimensionReader reader,
                      Map<String,Object> metadata,
                      String multiScaleDimName)
               throws Exception

Throws:

Exception

RangeProcessor

public RangeProcessor(MultiDimensionReader reader,
                      Map<String,Object> metadata)
               throws Exception

Throws:

Exception

Method Detail

createRangeProcessor

static RangeProcessor createRangeProcessor(MultiDimensionReader reader,
                                           Map<String,Object> metadata)
                                    throws Exception

Throws:

Exception

getAttributeAsFloatArray

public float[] getAttributeAsFloatArray(String arrayName,
                                        String attrName)
                                 throws Exception

Throws:

Exception

getAttributeAsDoubleArray

public double[] getAttributeAsDoubleArray(String arrayName,
                                          String attrName)
                                   throws Exception

Throws:

Exception

processRangeQualityFlag

public float[] processRangeQualityFlag(byte[] values,
                                       Map subset,
                                       QualityFlag qf)

Process a range of data from an array of byte values where bytes are packed bit or multi-bit fields of quality flags. Based on info in a QualityFlag object passed in, we extract and return values for that flag.

Parameters:

values - Input byte values. Cannot be null.

subset - Optional subset.

qf - Quality flag.

Returns:

Processed range.

processRange

public float[] processRange(byte[] values,
                            Map<String,double[]> subset)

Process a range of data from an array of byte values.

Parameters:

values - Input byte values. Cannot be null.

subset - Optional subset.

Returns:

Processed range.

processRange

public float[] processRange(short[] values,
                            Map<String,double[]> subset)

Process a range of data from an array of short values.

Parameters:

values - Input short values. Cannot be null.

subset - Optional subset.

Returns:

Processed range.

processRange

public float[] processRange(float[] values,
                            Map<String,double[]> subset)

Process a range of data from an array of float values.

Parameters:

values - Input float values. Cannot be null.

subset - Optional subset.

Returns:

Processed array.

processRange

public double[] processRange(double[] values,
                             Map<String,double[]> subset)

Process a range of data from an array of double value.

Parameters:

values - Input double values. Cannot be null.

subset - Optional subset.

Returns:

Processed array.

setMultiScaleDimName

public void setMultiScaleDimName(String multiScaleDimName)

getMultiScaleDimensionIndex

public int getMultiScaleDimensionIndex()

hasMultiDimensionScale

public boolean hasMultiDimensionScale()

setHasMultiDimensionScale

public void setHasMultiDimensionScale(boolean yesno)

setMultiScaleIndex

public void setMultiScaleIndex(int idx)

processRangeApplyLUT

public Object processRangeApplyLUT(short[] values,
                                   float[] lut)

Should be generalized. For now works for short to float conversions

Parameters:

values - the set of input values to map

lut - the lookup table for direct mapping input to output values

Returns:

output array as primitive floats