org.jaitools.media.jai.kernelstats
Class KernelStatsDescriptor

java.lang.Object
  extended by javax.media.jai.OperationDescriptorImpl
      extended by org.jaitools.media.jai.kernelstats.KernelStatsDescriptor
All Implemented Interfaces:
Serializable, javax.media.jai.OperationDescriptor, javax.media.jai.RegistryElementDescriptor

public class KernelStatsDescriptor
extends javax.media.jai.OperationDescriptorImpl

An OperationDescriptor for the "KernelStats" operation.

For each pixel in the input image, a range of summary statistics can be calculated for the values in the pixel's neighbourhood, which is defined using a KernelJAI object.

Two masking options are provided:

The two options may be used together.

Summary of parameters:

Name Class Default Description
stats Array of Statistic No default The statistics to calculate
kernel KernelJAI No default Kernel defining the neighbourhood
band Integer 0 Source image band to process
roi ROI null An optional ROI defining the area to process
maskSource Boolean false If true, only neighbourhood pixels within the ROI are used in calculations
maskDest Boolean false if true, NaN is returned for any pixels not within the ROI
ignoreNaN Boolean true if true, any Float or Double NaN values in the source image are ignored; if false, nilValue is returned when there are any NaN values in a neighbourhood
nilValue Number 0 value to return for no result

Since:
1.0
Version:
$Id$
Author:
Michael Bedward
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.media.jai.OperationDescriptorImpl
resources, sourceNames, supportedModes
 
Fields inherited from interface javax.media.jai.OperationDescriptor
NO_PARAMETER_DEFAULT
 
Constructor Summary
KernelStatsDescriptor()
          Constructor.
 
Method Summary
 boolean validateArguments(String modeName, ParameterBlock pb, StringBuffer msg)
          Validates supplied parameters.
 
Methods inherited from class javax.media.jai.OperationDescriptorImpl
arePropertiesSupported, getDefaultSourceClass, getDestClass, getDestClass, getInvalidRegion, getName, getNumParameters, getNumSources, getParamClasses, getParamDefaults, getParamDefaultValue, getParameterListDescriptor, getParamMaxValue, getParamMinValue, getParamNames, getPropertyGenerators, getPropertyGenerators, getRenderableDestClass, getRenderableSourceClasses, getResourceBundle, getResources, getSourceClasses, getSourceClasses, getSourceNames, getSupportedModes, isImmediate, isModeSupported, isRenderableSupported, isRenderedSupported, makeDefaultSourceClassList, validateArguments, validateParameters, validateParameters, validateRenderableArguments, validateRenderableSources, validateSources, validateSources
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KernelStatsDescriptor

public KernelStatsDescriptor()
Constructor.

Method Detail

validateArguments

public boolean validateArguments(String modeName,
                                 ParameterBlock pb,
                                 StringBuffer msg)
Validates supplied parameters.

Specified by:
validateArguments in interface javax.media.jai.OperationDescriptor
Overrides:
validateArguments in class javax.media.jai.OperationDescriptorImpl
Parameters:
modeName - the rendering mode
pb - the parameter block
msg - a StringBuffer to receive error messages
Returns:
true if parameters are valid; false otherwise


Copyright © 2009-2013. All Rights Reserved.