viewerstretch

Module that contains ViewerStretch and StretchRule classes

class tuiview.viewerstretch.StretchRule(comp, value, ctband, stretch)

Class that represents a ‘rule’ and a stretch to be applied when that rule matches. The rule contains information about number of bands in a dataset and how to compare, plus if a dataset has a colour table in a particular band

static fromString(string)

Create a StretchRule instance from a json encoded string created by toString()

isMatch(gdaldataset)

Does this rule match the given dataset?

toString()

Convert to a JSON encoded string

class tuiview.viewerstretch.ViewerStretch

Class that represents the stretch. Use the methods here to set the type of stretch you want and the bands used

static deleteFromGDAL(gdaldataset)

Remove the stretch entry from this dataset assumed the dataset opened with GA_Update

static fromGDALFileWithLUT(fname)

For reading a GDAL file with stretch and LUT saved. The stretch is read out and setLUTFromGDAL called with this file also

static fromString(string)

Create a ViewerStretch instance from a json encoded string created by toString()

static fromTextFileWithLUT(fname)

For reading a .stretch file. The stretch is read out of the first line and setLUTFromText called with this file also since .stretch files contain both

static readFromGDAL(gdaldataset)

See if there is an entry in the GDAL metadata, and return a ViewerStretch instance, otherwise None

setAttributeTableSize(size)

set with size of attribute table if one exists LUT will then be created with this size set to None for default behaviour

setBackgroundRGBA(rgba)

Set the RGB to display Background areas as

setBands(bands)

Set the bands to use. bands should be a tuple of 1-based ints

setColorTable()

Use the color table in the image

setGreyScale()

Display a single band in greyscale

setHistStretch(minVal=0.025, maxVal=0.01)

Do a histogram stretch

setLUTFromGDAL(fname)

Read LUT from specified GDAL dataset

setLUTFromText(fname)

Read in the LUT from specified text file

setLinearStretch(minVal=None, maxVal=None)

Just stretch linearly between min and max values if None, range of the data used

setNaNRGBA(rgba)

Set the RGB to display NaN areas as

setNoDataRGBA(rgba)

Set the RGBA to display No Data values as

setNoStretch()

Don’t do a stretch - data is already stretched

setPseudoColor(rampName)

Display with given color ramp

setRGB()

Display 3 bands as RGB

setStdDevStretch(stddev=2.0)

Do a standard deviation stretch

toString()

Convert to a JSON encoded string

writeToGDAL(gdaldataset)

Write this stretch into the GDAL file assumed the dataset opened with GA_Update Good idea to reopen any other handles to dataset

• Index

• Module Index

• Search Page