Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


  >  Docs Center  >  ENVI API  >  Data Control  >  ENVIMirrorRaster

ENVIMirrorRaster

ENVIMirrorRaster

This function constructs an ENVIRaster from a source raster that is reflected (flipped) horizontally, vertically, or both.

The result is a virtual raster, which has some additional considerations with regard to methods and properties. See Virtual Rasters for more information.

Example


; Start the application
e = ENVI()
 
; Open an input file
file = FILEPATH('qb_boulder_msi', ROOT_DIR=e.ROOT_DIR, $
  SUBDIRECTORY = ['data'])
raster = e.OpenRaster(file)
 
; Create a raster that is flipped vertically
mirrorRaster = ENVIMirrorRaster(raster, /VERTICAL)
 
; Display the result
View = e.GetView()
Layer = View.CreateLayer(mirrorRaster)

Syntax


Result = ENVIMirrorRaster(Input_Raster [, Keywords=value])

Return Value


This routine returns a reference to an ENVIRaster.

Arguments


Input_Raster

Specify the input ENVIRaster. If the input raster contains a spatial reference (including GLT), it will not be passed to the mirror raster.

Methods


This virtual raster inherits methods and properties from ENVIRaster; however the following methods will override the ENVIRaster methods:

Dehydrate

Hydrate

Keywords


ERROR (optional)

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

HORIZONTAL (optional)

Specify this keyword to flip the raster in the horizontal direction.

NAME

Specify a string that identifies the raster.

VERTICAL (optional)

Specify this keyword to flip the raster in the vertical direction.

If you specify both the HORIZONAL and VERTICAL keywords, the image is flipped in both directions:

Version History


ENVI 5.4

Introduced

API Version


3.2

See Also


ENVIRaster, ENVITransposeRaster, ENVIHydrate, ENVIHydratable, ENVIMirrorRasterTask, ENVITransposeRaster, ENVITransposeRasterTask



© 2018 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us