org.jaitools.media.jai.classifiedstats
Class ClassifiedStats

java.lang.Object
  org.jaitools.media.jai.classifiedstats.ClassifiedStats

public class ClassifiedStats
extends Object

Holds the results of the ClassifiedStats operator. An instance of this class is stored as a property of the destination image.

Since:

1.2

Author:

Daniele Romagnoli, GeoSolutions S.A.S.

See Also:

Result, ClassifiedStatsDescriptor

Method Summary

ClassifiedStats	band(int b) Get the subset of results for the given band.
ClassifiedStats	group(int g) Get the subset of results for the given group.
ClassifiedStats	ranges(List<Range<Double>> ranges) Get the subset of results for the given Ranges.
List<Map<org.apache.commons.collections.keyvalue.MultiKey,List<Result>>>	results() Returns the Result objects as a List>> The keys are multiKey setup on top of the classifier pixel values.
ClassifiedStats	statistic(Statistic s) Get the subset of results for the given Statistic.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

band

public ClassifiedStats band(int b)

Get the subset of results for the given band. See the example of chaining this method in the class docs.

Parameters:

b - band index

Returns:

a new ClassifiedStats object containing results for the band (data are shared with the source object rather than copied)

group

public ClassifiedStats group(int g)

Get the subset of results for the given group. See the example of chaining this method in the class docs.

Parameters:

g - group (pivot) index

Returns:

a new ClassifiedStats object containing results for the group (data are shared with the source object rather than copied)

statistic

public ClassifiedStats statistic(Statistic s)

Get the subset of results for the given Statistic. See the example of chaining this method in the class docs.

Parameters:

s - the statistic

Returns:

a new ClassifiedStats object containing results for the statistic (data are shared with the source object rather than copied)

ranges

public ClassifiedStats ranges(List<Range<Double>> ranges)

Get the subset of results for the given Ranges.

Parameters:

ranges - the Ranges

Returns:

a new ClassifiedStats object containing results for the ranges (data are shared with the source object rather than copied)

results

public List<Map<org.apache.commons.collections.keyvalue.MultiKey,List<Result>>> results()

Returns the Result objects as a List>> The keys are multiKey setup on top of the classifier pixel values. For each of them, a List of Results is provided. In case of classified stats against local ranges, the list will contain the Result for each range. The outer list allows to group results by pivot. In case no pivot classifiers have been specified, the list will be a singleton and user should always get element 0.

Returns:

the results

See Also:

Result