BlueSpray - Help
© SchoonerTurtles, Inc. 2012-2015

Introduction
Contents
Getting Started
Download
Navigating
Tutorials
Scripting
Advanced
About

Class STCalculator

Extends STTransformRasterCombiner

Performs calculations on rasters

Trig functions return a float raster unless the input is a double then they
return a double raster.


Copyright, SchoonerTurtles LLP, 2009
@author Jim Graham

Static Functions

ReturnsFunctionThrows
STRaster Absolute(STRaster TheInput1) Exception
STRaster Add(STRaster TheInput1,STRaster TheInput2) Exception
STRaster Add(STRaster TheInput1,double Value) Exception
STRaster And(STRaster TheInput1,STRaster TheInput2) Exception
STRaster And(STRaster TheInput1,double Value) Exception
STRaster ArcCos(STRaster TheInput1) Exception
STRaster ArcSin(STRaster TheInput1) Exception
STRaster ArcTan(STRaster TheInput1) Exception
STRaster Ceiling(STRaster TheInput1) Exception
STRaster Cos(STRaster TheInput1) Exception
STRaster Divide(STRaster TheInput1,STRaster TheInput2) Exception
STRaster Divide(STRaster TheInput1,double Value) Exception
STRaster Divide(double Value,STRaster TheInput1) Exception
STRaster E(STRaster TheInput1) Exception
STRaster Equal(STRaster TheInput1,STRaster TheInput2) Exception
STRaster Equal(STRaster TheInput1,double Value) Exception
STRaster Equal(double Value,STRaster TheInput1) Exception
STRaster Exp(STRaster TheInput1) Exception
STRaster Floor(STRaster TheInput1) Exception
STRaster GreaterThan(STRaster TheInput1,STRaster TheInput2) Exception
STRaster GreaterThan(STRaster TheInput1,double Value) Exception
STRaster GreaterThan(double Value,STRaster TheInput1) Exception
STRaster GreaterThanOrEqual(STRaster TheInput1,STRaster TheInput2) Exception
STRaster GreaterThanOrEqual(STRaster TheInput1,double Value) Exception
STRaster GreaterThanOrEqual(double Value,STRaster TheInput1) Exception
STRaster LessThan(STRaster TheInput1,STRaster TheInput2) Exception
STRaster LessThan(STRaster TheInput1,double Value) Exception
STRaster LessThan(double Value,STRaster TheInput1) Exception
STRaster LessThanOrEqual(STRaster TheInput1,STRaster TheInput2) Exception
STRaster LessThanOrEqual(STRaster TheInput1,double Value) Exception
STRaster LessThanOrEqual(double Value,STRaster TheInput1) Exception
STRaster Log(STRaster TheInput1) Exception
STRaster Max(STRaster TheInput1,STRaster TheInput2) Exception
STRaster Max(STRaster TheInput1,double Value) Exception
STRaster Max(double Value,STRaster TheInput1) Exception
STRaster Min(STRaster TheInput1,STRaster TheInput2) Exception
STRaster Min(STRaster TheInput1,double Value) Exception
STRaster Min(double Value,STRaster TheInput1) Exception
STRaster Multiply(STRaster TheInput1,STRaster TheInput2) Exception
STRaster Multiply(STRaster TheInput1,double Value) Exception
STRaster Multiply(double Value,STRaster TheInput1) Exception
STRaster NotEqual(STRaster TheInput1,STRaster TheInput2) Exception
STRaster NotEqual(STRaster TheInput1,double Value) Exception
STRaster NotEqual(double Value,STRaster TheInput1) Exception
STRaster Or(STRaster TheInput1,STRaster TheInput2) Exception
STRaster Or(STRaster TheInput1,double Value) Exception
STRaster PI(STRaster TheInput1) Exception
STRaster Power(STRaster TheInput1,STRaster TheInput2) Exception
STRaster Power(STRaster TheInput1,double Value) Exception
STRaster Power(double Value,STRaster TheInput1) Exception
STRaster Round(STRaster TheInput1) Exception
STRaster SetToValue(STRaster TheInput1,double Value) Exception
STRaster Sin(STRaster TheInput1) Exception
STRaster Subtract(STRaster TheInput1,STRaster TheInput2) Exception
STRaster Subtract(STRaster TheInput1,double Value) Exception
STRaster Subtract(double Value,STRaster TheInput1) Exception
STRaster Tan(STRaster TheInput1) Exception
STRaster Xor(STRaster TheInput1,STRaster TheInput2) Exception
STRaster Xor(STRaster TheInput1,double Value) Exception

Static Functions


STRaster Absolute(STRaster TheInput1) Exception


STRaster Add(STRaster TheInput1,STRaster TheInput2) Exception

Adds two rasters together and returns the result.

Parameters:
    TheInput1
    TheInput2
Returns:
Throws: Exception


STRaster Add(STRaster TheInput1,double Value) Exception

Add a value to the pixels in a raster.

Parameters:
    TheInput1 - The raster to add values to. The raster may be any pixel type.
    Value - The value to add to each pixel. The value will be converted to a double.
Returns: A raster that is the same type as the original.
Throws: Exception


STRaster And(STRaster TheInput1,STRaster TheInput2) Exception


STRaster And(STRaster TheInput1,double Value) Exception


STRaster ArcCos(STRaster TheInput1) Exception


STRaster ArcSin(STRaster TheInput1) Exception


STRaster ArcTan(STRaster TheInput1) Exception


STRaster Ceiling(STRaster TheInput1) Exception


STRaster Cos(STRaster TheInput1) Exception


STRaster Divide(STRaster TheInput1,STRaster TheInput2) Exception


STRaster Divide(STRaster TheInput1,double Value) Exception


STRaster Divide(double Value,STRaster TheInput1) Exception


STRaster E(STRaster TheInput1) Exception


STRaster Equal(STRaster TheInput1,STRaster TheInput2) Exception


STRaster Equal(STRaster TheInput1,double Value) Exception


STRaster Equal(double Value,STRaster TheInput1) Exception


STRaster Exp(STRaster TheInput1) Exception


STRaster Floor(STRaster TheInput1) Exception


STRaster GreaterThan(STRaster TheInput1,STRaster TheInput2) Exception


STRaster GreaterThan(STRaster TheInput1,double Value) Exception


STRaster GreaterThan(double Value,STRaster TheInput1) Exception


STRaster GreaterThanOrEqual(STRaster TheInput1,STRaster TheInput2) Exception


STRaster GreaterThanOrEqual(STRaster TheInput1,double Value) Exception


STRaster GreaterThanOrEqual(double Value,STRaster TheInput1) Exception


STRaster LessThan(STRaster TheInput1,STRaster TheInput2) Exception


STRaster LessThan(STRaster TheInput1,double Value) Exception


STRaster LessThan(double Value,STRaster TheInput1) Exception


STRaster LessThanOrEqual(STRaster TheInput1,STRaster TheInput2) Exception


STRaster LessThanOrEqual(STRaster TheInput1,double Value) Exception


STRaster LessThanOrEqual(double Value,STRaster TheInput1) Exception


STRaster Log(STRaster TheInput1) Exception


STRaster Max(STRaster TheInput1,STRaster TheInput2) Exception


STRaster Max(STRaster TheInput1,double Value) Exception


STRaster Max(double Value,STRaster TheInput1) Exception


STRaster Min(STRaster TheInput1,STRaster TheInput2) Exception


STRaster Min(STRaster TheInput1,double Value) Exception


STRaster Min(double Value,STRaster TheInput1) Exception


STRaster Multiply(STRaster TheInput1,STRaster TheInput2) Exception


STRaster Multiply(STRaster TheInput1,double Value) Exception


STRaster Multiply(double Value,STRaster TheInput1) Exception


STRaster NotEqual(STRaster TheInput1,STRaster TheInput2) Exception


STRaster NotEqual(STRaster TheInput1,double Value) Exception


STRaster NotEqual(double Value,STRaster TheInput1) Exception


STRaster Or(STRaster TheInput1,STRaster TheInput2) Exception


STRaster Or(STRaster TheInput1,double Value) Exception


STRaster PI(STRaster TheInput1) Exception


STRaster Power(STRaster TheInput1,STRaster TheInput2) Exception


STRaster Power(STRaster TheInput1,double Value) Exception


STRaster Power(double Value,STRaster TheInput1) Exception


STRaster Round(STRaster TheInput1) Exception


STRaster SetToValue(STRaster TheInput1,double Value) Exception


STRaster Sin(STRaster TheInput1) Exception


STRaster Subtract(STRaster TheInput1,STRaster TheInput2) Exception


STRaster Subtract(STRaster TheInput1,double Value) Exception


STRaster Subtract(double Value,STRaster TheInput1) Exception


STRaster Tan(STRaster TheInput1) Exception


STRaster Xor(STRaster TheInput1,STRaster TheInput2) Exception


STRaster Xor(STRaster TheInput1,double Value) Exception