Isis 3 Application Documentation
Add a graticule or rectangular grid to the input image
Description
Superimpose a user defined grid on an input image. A graticule is defined in
terms of latitude and longitude coordinates (MODE=GROUND), while a simple
rectangular grid is based on line and sample coordinates (MODE=IMAGE).
Example 1: For a basic latitude/longitude graticule with grid lines drawn
every 10 degrees, your parameters would be: Select GROUND mode, BASELAT=0,
BASELON=0, LATINC=10, LONINC=10. Latitude and longitude lines will be drawn
at even 10 degree increments, based on zero. Superimpose a grid on an input
image using input from the user. The grid can be defined in terms of
latitude and longitude or simply lines and samples. For example, if you
wanted to draw a grid that has an intersection at line 23, sample 17, with
vertical lines every 30 pixels and horizontal lines every 40 pixels, your
parameters would be:
BASELINE=23 BASESAMPLE=17 SINC=30 LINC=40
Example 2: For a rectangular grid that has an intersection at line 23,
sample 17, with vertical lines every 30 pixels and horizontal lines every 40
pixels, your parameters would be:
MODE=IMAGE BASELINE=23 BASESAMPLE=17 SINC=30 LINC=40
Example 3: For a latitude/longitude graticule with a grid intersection at
LAT 50 degrees, LON 60 degrees, with latitude lines drawn every two and a half degrees and
longitude lines drawn every three degrees, your parameters would be:
MODE=GROUND BASELAT=50 BASELON=60 LATINC=2.5 LONINC=3
Example 4: If desired, you may draw a latitude/longitude graticule within a
subarea of an image. For example, suppose you have a global image (full
latitude and longitude extent), but would like a 10 degree graticule drawn
only between latitudes -20 degrees and +50 degrees and only between
longitudes 90 degrees and 180 degrees. In this case, your parameters would
be:
MODE=GROUND BASELAT=0 BASELON=0 LATINC=10 LONINC=10 MINLAT=-20 MAXLAT=50 MINLON=90 MAXLON=180
This approach can also be used to produce grid variations as desired through
multiple executions of the grid application.
Categories
History
Sean Crosby | 2007-03-16 |
Original version
|
Steven Lambright | 2007-07-27 |
Added category: Map Projection
|
Steven Lambright | 2008-04-22 |
Fixed problems with mapping outside of the projection space and with
0lat/0lon boundaries.
|
Steven Lambright | 2008-05-12 |
Removed references to CubeInfo
|
Steven Lambright | 2008-06-12 |
Added outline option
|
Steven Lambright | 2009-01-06 |
Changed how mode=ground works
|
Steven Lambright | 2010-05-06 |
Added TICKS options
|
Steven Lambright | 2010-07-22 |
Added LINEWIDTH option
|
Mackenzie Boyd | 2011-01-21 |
Added more line options, to change output to be HRS, LRS, NULL, or a DN.
|
Steven Lambright | 2011-01-25 |
Bug fixes for projections that use PositiveWest or Planetographic
coordinate systems. The BASELAT and BASELON parameters are now expected
to be in the units of the projection (if your cube has a planetographic
latitude system, and baselat=50, then there will be a line at the
planetographic latitude of 50).
|
Steven Lambright | 2011-01-26 |
Added BOUNDARY, MINLAT, MAXLAT, MINLON and MAXLON options.
|
Steven Lambright | 2011-12-08 |
Fixed a bug with the outline option. If the image had a larger number of
samples than number of lines, all of the data at sample > number of lines
would be considered a grid line. This could result in a large portion of
the image losing legitimate DN values for the grid value. Fixes #607.
|
Steven Lambright | 2012-01-04 |
Tested and documented for the January 2012 release. The documentation
updates included were recommended by Chris Isbell.
|
Adam Licht | 2012-12-26 |
Added functionality to choose the source of image background. Pixel Values
for behind the grid can now be the image pixel value, HRS, LRS, NULL, or a DN.
|
Steven Lambright | 2012-12-31 |
Incorporated Adam Licht's changes into Isis. This included re-formatting to match
current Isis 3 coding standards, removal of error checking of conditions that
cannot happen, fixes with running in batch mode/resetting of variable states
between runs, some re-positioning of parameter locations, and creating
tests. These changes shouldn't break any existing scripts that utilize grid. Fixes #917.
|
|
Parameter Groups
Files
Name
|
Description
|
FROM |
Input cube
|
TO |
Output cube
|
Grid Type
Name
|
Description
|
MODE | Grid options |
TICKS | Draw ticks instead of lines |
OUTLINE | Outline the image |
BOUNDARY | Include grid lines at the lat/lon extent of the image or as defined by the ground options |
Image Grid Parameters
Ground Grid Parameters
Ground Grid Limits
Name
|
Description
|
MINLAT | Lowest latitude value to extend grid lines |
MAXLAT | Highest latitude value to extend grid lines |
MINLON | Lowest longitude value to extend grid lines |
MAXLON | Highest longitude value to extend grid lines |
Line Parameters
Background Type
Tick Parameters
Name
|
Description
|
DIAGONALTICKS | Draw tick marks diagonally ('x' instead of '+') |
TICKSIZE | Size (length) of tickmarks (pixels) |
|
Files:
FROM
Description
Use this parameter to select the input file.
Type
| cube |
File Mode
| input |
Filter
|
*.cub
|
Files:
TO
Description
This file will contain the grid.
Type
| cube |
File Mode
| output |
Filter
|
*.cub
|
Grid Type:
MODE
Description
This allows for selection of either IMAGE or GROUND coordinates when drawing the grid.
Type
| string |
Default
| GROUND |
Option List:
|
Option |
Brief |
Description |
IMAGE | Add a rectangular grid in terms of lines and samples |
A grid will be inserted into the image with spacing and position
defined in line and sample coordinates.
Exclusions
- BASELAT
- BASELON
- LATINC
- LONINC
- MINLAT
- MAXLAT
- MINLON
- MAXLON
- BOUNDARY
|
GROUND | Add a grid (graticule) in terms of lat/lon coordinates |
A grid will be inserted into the image with spacing and position
defined in latitude and longitude coordinates.
Exclusions
- LINC
- SINC
- BASELINE
- BASESAMPLE
|
|
Grid Type:
TICKS
Description
Draw ticks at grid intersections (instead of drawing full lines)
Type
| boolean |
Default
| false |
Inclusions
|
|
Grid Type:
OUTLINE
Description
This will draw grid lines at the very edges of the image
Type
| boolean |
Default
| false |
Grid Type:
BOUNDARY
Description
This will draw grid lines (or ticks) at the lat/lon extents of the
image or those extents as provided by user input MINLAT, MAXLAT,
MINLON, and MAXLON.
Type
| boolean |
Default
| false |
Image Grid Parameters:
BASELINE
Description
Starting line of grid. This, along with BASESAMPLE, defines the
starting point (line) for drawing the grid.
Type
| integer |
Default
| 1 |
Minimum
| 1
(inclusive)
|
Image Grid Parameters:
BASESAMPLE
Description
Starting sample of grid. This, along with BASELINE, defines the
starting point (sample) for drawing the grid.
Type
| integer |
Default
| 1 |
Minimum
| 1
(inclusive)
|
Image Grid Parameters:
LINC
Description
This defines the line increment when drawing the grid, starting at
BASELINE. The line increment is the spacing between lines.
Type
| integer |
Default
| 100 |
Minimum
| 1
(inclusive)
|
Ground Grid Parameters:
BASELAT
Description
This is the latitude on which LATINC is mathematically based. That is,
this establishes a starting point for a global 'virtual' grid where
latitude lines are drawn where the input image intersects the virtual
grid. The application assumes user input reflects proper units (e.g.
planetographic, planetocentric latitude) as defined within the image.
Type
| double |
Default
| 0.0 |
Minimum
| -90.0
(inclusive)
|
Ground Grid Parameters:
BASELON
Description
This is the longitude on which LONINC is mathematically based. That
is, this establishes a starting point for a global 'virtual' grid
where longitude lines are drawn where the input image intersects the
virtual grid.
Type
| double |
Default
| 0.0 |
Minimum
| -360.0
(inclusive)
|
Ground Grid Parameters:
LATINC
Description
This defines the latitude increment, based on BASELAT, on which grid
lines are drawn. This establishes a global 'virtual' grid where
latitude lines are drawn only where the input image intersects the
virtual grid.
Type
| double |
Default
| 10.0 |
Minimum
| 0.0
(inclusive)
|
Ground Grid Parameters:
LONINC
Description
This defines the longitude increment, based on BASELON, on which grid
lines are drawn. This establishes a global 'virtual' grid where
longitude lines are drawn only where the input image intersects the
virtual grid.
Type
| double |
Default
| 10.0 |
Minimum
| 0.0
(inclusive)
|
Ground Grid Limits:
MINLAT
Description
This defines the minimum latitude to which longitude grid lines will
extend. If BOUNDARY is selected, a latitude line will be drawn at this
latitude.
Type
| double |
Internal Default
| Automatic |
Minimum
| -90
(inclusive)
|
Maximum
| 90
(inclusive)
|
Ground Grid Limits:
MAXLAT
Description
This defines the maximum latitude to which longitude grid lines will
extend. If BOUNDARY is selected, a latitude line will be drawn at this
latitude.
Type
| double |
Internal Default
| Automatic |
Minimum
| -90
(inclusive)
|
Maximum
| 90
(inclusive)
|
Greater Than
| MINLAT
|
Ground Grid Limits:
MINLON
Description
This defines the minimum longitude to which latitude grid lines will
extend. If BOUNDARY is selected, a longitude line will be drawn at
this longitude.
Type
| double |
Internal Default
| Automatic |
Minimum
| -360
(inclusive)
|
Maximum
| 360
(inclusive)
|
Ground Grid Limits:
MAXLON
Description
This defines the maximum longitude to which latitude grid lines will
extend. If BOUNDARY is selected, a longitude line will be drawn at
this longitude.
Type
| double |
Internal Default
| Automatic |
Minimum
| -360
(inclusive)
|
Maximum
| 360
(inclusive)
|
Greater Than
| MINLON
|
Line Parameters:
LINEWIDTH
Description
This defines the thickness of grid lines in pixels.
Type
| integer |
Default
| 1 |
Minimum
| 1
(inclusive)
|
Odd
|
This value must be an odd number
|
Line Parameters:
LINEVALUE
Description
This option allows for any DN value, or any of three special pixel
values to be chosen as the grid line value.
Type
| string |
Default
| HRS |
Option List:
|
Option |
Brief |
Description |
HRS | Use HRS DN value |
Use the special pixel value HRS (High Representation Saturation)
as the grid line value. This may vary with bittype used.
Exclusions
|
LRS | Use LRS DN value |
Use the special pixel value LRS (Low Representation Saturation)
as the grid line value. This may vary with bittype used.
Exclusions
|
NULL | Use NULL DN value |
Use the special pixel value NULL as the grid line value. This may
vary with bittype used.
Exclusions
|
DN | Use given DN value |
Use the DN value specified in the DNVALUE parameter. It is a good
idea to run the application stats on a cube before selecting a DN
value.
|
|
Line Parameters:
DNVALUE
Description
This is the DN value to be used as the value of the grid lines when
LINEVALUE=DN. It may be beneficial to first run the stats application
in determining image minimum and maximum values.
Background Type:
BKGNDVALUE
Description
This option allows for any DN value, or any of three special pixel
values to be chosen as the background value.
Type
| string |
Default
| IMAGE |
Option List:
|
Option |
Brief |
Description |
IMAGE | Use the input cub value |
Use the input cub pixel value as the background value. This will
superimpose the grid on top of the input image.
Exclusions
|
HRS | Use HRS DN value |
Use the special pixel value HRS (High Representation Saturation)
as the background value. This may vary with bittype used.
Exclusions
|
LRS | Use LRS DN value |
Use the special pixel value LRS (Low Representation Saturation)
as the background value. This may vary with bittype used.
Exclusions
|
NULL | Use NULL DN value |
Use the special pixel value NULL as the background value. This may
vary with bittype used.
Exclusions
|
DN | Use given DN value |
Use the DN value specified in the BKGNDDNVALUE parameter. It is a good
idea to run the application stats on a cube before selecting a DN
value.
Inclusions
|
|
Background Type:
BKGNDDNVALUE
Description
This is the DN value to be used as the value of the background when
BKGNDVALUE=DN. It may be beneficial to first run the stats application
in determining image minimum and maximum values.
Tick Parameters:
DIAGONALTICKS
Description
Draw tick marks diagonally (creating an 'x'), instead of default
vertical/horizontal ('+')
Type
| boolean |
Default
| false |
Tick Parameters:
TICKSIZE
Description
This defines the width and height (which are always equal) of the tick
marks in pixels.
Type
| integer |
Default
| 5 |
Minimum
| 1
(inclusive)
|
Odd
|
This value must be an odd number
|