Class TiffRasterStatistics
- java.lang.Object
-
- org.apache.commons.imaging.formats.tiff.TiffRasterStatistics
-
public class TiffRasterStatistics extends Object
Collects and stores a set of simple statistics from the input raster.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetCountOfNulls()Get the count of the number of null samples in the collection.intgetCountOfSamples()Get the count of the number of non-null and non-excluded samples in the collection.floatgetExcludedValue()Get the value that was set for exclusion, or a Float.NaN if not was set.floatgetMaxValue()Get the maximum value found in the source datafloatgetMeanValue()Get the mean value for all sample values in the raster.floatgetMinValue()Get the minimum value found in the source databooleanisAnExcludedValueSet()Indicates if a sample value was set to be deliberately excluded from the statistics.
-
-
-
Method Detail
-
getCountOfSamples
public int getCountOfSamples()
Get the count of the number of non-null and non-excluded samples in the collection.- Returns:
- the a positive number, potentially zero
-
getCountOfNulls
public int getCountOfNulls()
Get the count of the number of null samples in the collection.- Returns:
- the a positive number, potentially zero
-
getMinValue
public float getMinValue()
Get the minimum value found in the source data- Returns:
- the minimum value found in the source data
-
getMaxValue
public float getMaxValue()
Get the maximum value found in the source data- Returns:
- the maximum value found in the source data
-
getMeanValue
public float getMeanValue()
Get the mean value for all sample values in the raster. Null-data values and excluded values are not considered.- Returns:
- the mean value of the samples
-
isAnExcludedValueSet
public boolean isAnExcludedValueSet()
Indicates if a sample value was set to be deliberately excluded from the statistics.- Returns:
- true if a value was set for exclusion; otherwise, false
-
getExcludedValue
public float getExcludedValue()
Get the value that was set for exclusion, or a Float.NaN if not was set.- Returns:
- the excluded value (if any).
-
-