Class TiffRasterStatistics
java.lang.Object
org.apache.commons.imaging.formats.tiff.TiffRasterStatistics
Collects and stores a set of simple statistics from the input raster.
-
Method Summary
Modifier and TypeMethodDescriptionint
Gets the count of the number of null samples in the collection.int
Gets the count of the number of non-null and non-excluded samples in the collection.float
Gets the value that was set for exclusion, or a Float.NaN if not was set.float
Gets the maximum value found in the source datafloat
Gets the mean value for all sample values in the raster.float
Gets the minimum value found in the source databoolean
Indicates if a sample value was set to be deliberately excluded from the statistics.
-
Method Details
-
getCountOfNulls
Gets the count of the number of null samples in the collection.- Returns:
- the a positive number, potentially zero
-
getCountOfSamples
Gets the count of the number of non-null and non-excluded samples in the collection.- Returns:
- the a positive number, potentially zero
-
getExcludedValue
Gets the value that was set for exclusion, or a Float.NaN if not was set.- Returns:
- the excluded value (if any).
-
getMaxValue
Gets the maximum value found in the source data- Returns:
- the maximum value found in the source data
-
getMeanValue
Gets 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
-
getMinValue
Gets the minimum value found in the source data- Returns:
- the minimum value found in the source data
-
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
-