BlueSpray - Help
© SchoonerTurtles, Inc. 2012-2015

Introduction
Contents
Getting Started
Download
Navigating
Tutorials
Scripting
Advanced
About

Class STSample

Extends STTransformRaster

Given an input raster and an output raster, samples the input raster into
the output raster. This supports the following:

- Cropping an existing raster (same pixel ref dimensions, different bounds)
- Sample/scale and existing raster

Bounds:
- Specified in "TheBounds"
- In OutputRaster
Width and Height in Pixels
- OutputRaster (already allocated)
- Bounds and InputRaster's resolution

The bounds to copy can be specified either in the OutputRaster
or a local property. If a local property is used, the copy may be a subset of the outputRaster,
otherwise, the entire raster output area will try to be copied.

The width and height in pixels of the OutputRaster may be specified in the OutputRaster.
If the OutputRaster has a WIdthInPixels of zero, the output pixel dimensions will
be computed from the available bounds and the Input raster's pixel resolution.


Copyright, SchoonerTurtles LLP, 2009
@author Jim Graham

Static Functions

ReturnsFunctionThrows
STRaster Sample(STRaster TheInput,STBounds TheBounds,
     int WidthInPixels,int HeightInPixels,METHOD TheMethod)
Exception
STRaster Sample2(STRaster TheInput,STBounds TheBounds,
     int WidthInPixels,int HeightInPixels,METHOD TheMethod)
Exception
STRaster Scale(STRaster TheInput,double XScale,double YScale,
     STSample.METHOD
SamplingMethod)
Exception // jjg - SamplingMethod not used

Static Functions


STRaster Sample(STRaster TheInput,STBounds TheBounds,
     int WidthInPixels,int HeightInPixels,METHOD TheMethod) Exception


STRaster Sample2(STRaster TheInput,STBounds TheBounds,
     int WidthInPixels,int HeightInPixels,METHOD TheMethod) Exception


Parameters:
    TheRaster
    TheBounds
    WidthInPixels
    HeightInPixels
    TheMethod
Returns:
Throws: Exception


STRaster Scale(STRaster TheInput,double XScale,double YScale,
     STSample.METHOD SamplingMethod) Exception // jjg - SamplingMethod not used

Scales an existing raster to a new resolution.

Parameters:
    TheInput
    XScale
    YScale
    SamplingMethod - type of resampling to use: NEAREST, BILINEAR, or MATRIX
    TheProcess
Returns: