Home

User Documentation

Getting Started
Learn More
Explore in Detail
Get Inspired

Contributor Documentation

Getting Started
Learn More
Explore in Detail
Get Inspired

Quick Links

Software Manual
AstroDiscuss
GitHub
API Reference

Documentation Versions


ISIS 2

Documentation
Tutorials
Technical Documents
USGS

ISIS Application Documentation


cropspecial

Standard View | TOC | Home

Crops specified special pixels from a cube

Description
Categories
Groups
Examples
History


Description

This program automatically crops as many of the special pixels in a cube as possible, without removing any valid data. The user can specify which of the five special pixel types the program should attempt to crop and which should be retained in the output cube. Labels are duplicated from the input to the output cube.

Categories


Related Objects and Documents

Applications


Parameter Groups

Files

Name Description
FROM Input cube
TO Output cropped cube

Crop Pixels

Name Description
NULL Crop NULL pixels
HRS Crop high representation saturation (HRS) pixels
LRS Crop low representation saturation (LRS) pixels
HIS Crop high instrument saturation (HIS) pixels
LIS Crop low instrument saturation (LIS) pixels

Files: FROM

Description

Input cube to be cropped.

Type cube
File Mode input
Filter *.cub

Files: TO

Description

The resultant cropped cube.

Type cube
File Mode output
Filter *.cub

Crop Pixels: NULL

Description

This option will cause the program to consider NULL pixels when cropping pixels for the output cube.

Type boolean
Default TRUE

Crop Pixels: HRS

Description

This option will cause the program to consider high representation saturation (HRS) pixels when cropping pixels for the output cube.

Type boolean
Default FALSE

Crop Pixels: LRS

Description

This option will cause the program to consider low representation saturation (LRS) pixels when cropping pixels for the output cube.

Type boolean
Default FALSE

Crop Pixels: HIS

Description

This option will cause the program to consider high instrument saturation (HIS) pixels when cropping pixels for the output cube.

Type boolean
Default FALSE

Crop Pixels: LIS

Description

This option will cause the program to consider low instrument saturation (LIS) pixels when cropping pixels for the output cube.

Type boolean
Default FALSE

Examples


Example 1

Crop NULL pixels

Description

Cropping the cube with default settings selected.

Command Line

cropspecial from=allspecial.cub+1 to=nonulls.cub
In this example, cropspecial will extract a sub-area from a cube surrounded in special pixels with only the NULL pixel type selected.

GUI Screenshot

cropspecial gui

Example GUI

Screenshot of GUI with the default parameter settings, ready to perform a crop on the NULL pixels contained within the first band of the input cube.

Input Image

Input image

Input image for cropspecial

Parameter Name: FROM

The original, 82x361 image. NULL, HRS, LRS, HIS, and LIS pixels are shown in blue, light green, yellow, pink, and light blue, respectively. NULL SPACE is shown here in black.

Output Image

Output image showing results on the default settings

Output image for cropspecial

Parameter Name: TO

This is the 82x315 output image that results. The NULL pixels at the bottom have been removed, but the NULL pixels surrounded by saturation pixels have not been removed as doing so would result in the loss of pixels not selected for cropping.


Example 2

Crop all special pixels

Description

Cropping the cube with all special pixels selected.

Command Line

cropspecial from=allspecial.cub+1 to=nospecial.cub hrs=yes lrs=yes his=yes lis=yes
In this example, cropspecial will extract a sub-area from a cube surrounded in special pixels with all pixel types selected.

GUI Screenshot

cropspecial gui

Example GUI

Screenshot of GUI with parameters filled in to perform a crop on all special pixels contained within the first band of the input cube.

Input Image

Input image

Input image for cropspecial

Parameter Name: FROM

The original, 82x361 image. NULL, HRS, LRS, HIS, and LIS pixels are shown in blue, light green, yellow, pink, and light blue, respectively. NULL SPACE is shown here in black.

Output Image

Output image showing results of the cropspecial application

Output image for cropspecial

Parameter Name: TO

This is the 22x173 output image that results. Some HRS, HIS, and NULL pixels are still present due to the rectangular dimensions of the cube, but their occurence has been minimized.


History

Travis Addair2009-02-24 Original version
Janet Barrett2009-10-22 Now uses the SubArea class to produce output cube labels with corrected Mapping, Instrument, and AlphaCube groups.
Travis Addair2010-01-06 Changed Progress to tell the user when the program is finding the perimeter and when it is removing special pixels from the image.