Image format translation for planetary science data

What it does

Install

VICARIO 2.7.2 is published to Maven Central. It is built for Java 8 and tested on Java 17.

<dependency>
  <groupId>gov.nasa.jpl.ammos.ids</groupId>
  <artifactId>vicario</artifactId>
  <version>2.7.2</version>
</dependency>

implementation("gov.nasa.jpl.ammos.ids:vicario:2.7.2")

git clone https://github.com/NASA-AMMOS/vicario.git
cd vicario
mvn -U -Pshade clean install   # target/vicario-2.7.2-FAT.jar for the command line

Command line: jConvertIIO

The FAT jar runs the converter. Arguments are KEYWORD=value pairs; keyword names are not case-sensitive, and a true/false keyword given alone means true.

java -jar vicario-2.7.2-FAT.jar inp=<input> out=<output> format=<format> [KEYWORD=value ...]
java -jar vicario-2.7.2-FAT.jar HELP        # every keyword

VICAR to PNG

java -jar vicario-2.7.2-FAT.jar inp=image.vic out=image.png format=png

Floating-point image to an 8-bit PNG (stretched to 0..255)

java -jar vicario-2.7.2-FAT.jar inp=real.vic out=real.png format=png OFORM=BYTE

VICAR to PDS3 with an attached label

java -jar vicario-2.7.2-FAT.jar inp=image.vic out=image.img format=pds

PDS3 or PDS4 product to VICAR

java -jar vicario-2.7.2-FAT.jar inp=product.xml out=image.vic format=vicar

Cut out a region (x, y, width, height)

java -jar vicario-2.7.2-FAT.jar inp=image.vic out=region.vic format=vicar SOURCE_REGION=(10,10,200,100)

Quarter-size preview (every 4th sample and line)

java -jar vicario-2.7.2-FAT.jar inp=image.vic out=thumb.png format=png SUBSAMPLING=(4,4,0,0)

Batch: one conversion per line of jobs.txt, 4 at a time

java -jar vicario-2.7.2-FAT.jar ARGFILE=jobs.txt PARALLEL_BATCH=4

On recent JDKs, JAI prints a "Could not find mediaLib accelerator" warning; add -Dcom.sun.media.jai.disableMediaLib=true before -jar to silence it.

Keywords

The most used keywords. HELP prints the full list, including tiling and cache settings.

PDS4 tables

java -cp vicario-2.7.2-FAT.jar jpl.mipl.io.util.ExtractTableJPL -c -o table.csv product.xml   # -w for fixed-width text

Java library

With VICARIO on the classpath, the VICAR, PDS3, ISIS and FITS readers are found through the standard ImageIO plugin lookup:

import java.awt.image.BufferedImage;
import java.io.File;
import javax.imageio.ImageIO;

BufferedImage img = ImageIO.read(new File("image.vic"));   // VICAR, PDS3, ISIS, FITS
ImageIO.write(img, "png", new File("image.png"));

The source has the full API, including the label (metadata) classes and the PDS4 readers.

Formats

Testing

Every change runs a feature test suite: the real jConvertIIO command against synthetic images and public mission products from the PDS, with each output decoded and compared pixel for pixel. The full suite runs on every merge to main and nightly, and publishes the report linked here.

Capabilities

Each capability is a feature in the test suite. Click one to read its test procedures: what each test does and what makes it pass. The tags count tests by the kind of testing (nominal, off-nominal, malformed input, lossless, mission data, ...). Passed excludes tests that document a known bug.