public class BorderDescriptor
extends javax.media.jai.OperationDescriptorImpl
OperationDescriptor
describing the "Border" operation.
The Border operation adds a border around a rendered image. The size of the border is specified in pixels by the left, right, top, and bottom padding parameters, corresponding to the four sides of the source image. These paddings may not be less than 0.
The pixel values of the added border area will be set according to the algorithm of the BorderExtender
passed as a parameter. The
BorderExtender
s provide the ability to extend the border by:
BorderExtenderZero
);
BorderExtenderConstant
);
BorderExtenderCopy
);
BorderExtenderReflect
); or,
BorderExtenderWrap
).
If No Data are present the user can provide a Range of No Data for handling the No Data values and a Destination No Data value for setting the output No Data value.
Name | Value |
---|---|
GlobalName | Border |
LocalName | Border |
Vendor | it.geosolutions.jaiext |
Description | Operation which adds borders to the input image. |
DocURL | Not Defined |
Version | 1.0 |
arg0Desc | Image's left padding. |
arg1Desc | Image's right padding. |
arg2Desc | Image's top padding. |
arg3Desc | Image's bottom padding. |
arg4Desc | Border Extender used. |
arg5Desc | No Data Range used. |
arg6Desc | Destination No Data value. |
Name | Class Type | Default Value |
---|---|---|
leftPad | java.lang.Integer | 0 |
rightPad | java.lang.Integer | 0 |
topPad | java.lang.Integer | 0 |
bottomPad | java.lang.Integer | 0 |
type | javax.media.jai.BorderExtender | javax.media.jai.BorderExtenderZero |
noData | it.geosolutions.jaiext.range.Range | null |
destNoData | java.lang.Double | 0 |
Constructor and Description |
---|
BorderDescriptor()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static javax.media.jai.RenderedOp |
create(RenderedImage source0,
int leftPad,
int rightPad,
int topPad,
int bottomPad,
javax.media.jai.BorderExtender type,
Range noData,
double destinationNoData,
RenderingHints hints)
Adds a border around an image.
|
Object |
getInvalidRegion(String modeName,
ParameterBlock oldParamBlock,
RenderingHints oldHints,
ParameterBlock newParamBlock,
RenderingHints newHints,
javax.media.jai.OperationNode node)
Calculates the region over which two distinct renderings of the "Border" operation may be expected to differ.
|
arePropertiesSupported, getDefaultSourceClass, getDestClass, getDestClass, 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, validateArguments, validateParameters, validateParameters, validateRenderableArguments, validateRenderableSources, validateSources, validateSources
public Object getInvalidRegion(String modeName, ParameterBlock oldParamBlock, RenderingHints oldHints, ParameterBlock newParamBlock, RenderingHints newHints, javax.media.jai.OperationNode node)
The operation returns a Shape
or null
in the rendered mode and null
in all other modes.
getInvalidRegion
in interface javax.media.jai.OperationDescriptor
getInvalidRegion
in class javax.media.jai.OperationDescriptorImpl
modeName
- The name of the mode.oldParamBlock
- The previous sources and parameters.oldHints
- The previous hints.newParamBlock
- The current sources and parameters.newHints
- The current hints.node
- The affected node in the processing chain (ignored).null
if there is no
common region of validity. A non-null
empty region indicates that the operation would produce identical data over the
bounds of the old rendering although perhaps not over the area occupied by the tiles of the old rendering.IllegalArgumentException
- if modeName
is null
or if the operation requires either sources or parameters and
either oldParamBlock
or newParamBlock
is null
.IllegalArgumentException
- if oldParamBlock
or newParamBlock
do not contain sufficient sources or parameters
for the operation in question.public static javax.media.jai.RenderedOp create(RenderedImage source0, int leftPad, int rightPad, int topPad, int bottomPad, javax.media.jai.BorderExtender type, Range noData, double destinationNoData, RenderingHints hints)
Creates a ParameterBlockJAI
from all supplied arguments except hints
and invokes
JAI.create(String,ParameterBlock,RenderingHints)
.
source0
- RenderedImage
source 0.leftPad
- The image's left padding. May be null
.rightPad
- The image's right padding. May be null
.topPad
- The image's top padding. May be null
.bottomPad
- The image's bottom padding. May be null
.type
- The border type. May be null
.noData
- No Data Range used. May be null
.destinationNoData
- Value for the output No Data.hints
- The RenderingHints
to use. May be null
.RenderedOp
destination.IllegalArgumentException
- if source0
is null
.Copyright © 2006–2015 GeoSolutions. All rights reserved.