

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
java.lang.Object org.jaitools.media.jai.zonalstats.Result
public class Result
Holds the result for a a given combination of image band / zone / statistic.
See documentation for ZonalStats
for examples of how to access
results.
ZonalStats
Constructor Summary  

Result(int imageBand,
int zone,
Statistic stat,
List<Range> ranges,
Double value,
long numOffered,
long numAccepted,
long numNaN,
long numNoData)
Create a new Result object. 
Method Summary  

int 
getImageBand()
Get the index of the image band for which this result was calculated. 
long 
getNumAccepted()
Get the number of values that were accepted, ie. 
long 
getNumNaN()
Get the number of NaN values that were sampled from the image when calculating this result. 
long 
getNumNoData()
Get the number of NoData values that were sampled from the image when calculating this result. 
long 
getNumOffered()
Get the number of values that were offered, ie. 
Collection<Range> 
getRanges()
Get the ranges (if defined) that were used to filter data image values for inclusion in the calculation of this result. 
Statistic 
getStatistic()
Get the statistic that this result pertains to. 
Double 
getValue()
Get the calculated value of the statistic. 
int 
getZone()
Get the integer ID of the image zone for which this result was calculated. 
String 
toString()

Methods inherited from class java.lang.Object 

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait 
Constructor Detail 

public Result(int imageBand, int zone, Statistic stat, List<Range> ranges, Double value, long numOffered, long numAccepted, long numNaN, long numNoData)
Result
object. This is intended for use by the
ZonalStats
class rather than client code.
imageBand
 data image bandzone
 integer identifier of the zone in the zone image; 0 should be passed
when no zone image was usedstat
 the statistic to which this result pertainsranges
 list of ranges (if any) used to filter data image valuesvalue
 the calculated value of the statisticnumOffered
 number of data image values considered for inclusionnumAccepted
 number of data image values actually used for calculating
this resultnumNaN
 number of NaN values read from the data imagenumNoData
 number of NoData values read from the data imageMethod Detail 

public Collection<Range> getRanges()
public int getImageBand()
public int getZone()
public Statistic getStatistic()
public Double getValue()
public long getNumAccepted()
public long getNumOffered()
public long getNumNaN()
public long getNumNoData()
public String toString()
toString
in class Object


PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 