.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.46.4.
.TH OSSIM-PREPROC "1" "December 2015" "ossim-preproc 1.8.20" "User Commands"
.SH NAME
ossim-preproc \- ossim-preproc
.SH SYNOPSIS
.B ossim-preproc
[\fI\,options\/\fR] \fI\,<file-or-directory-to-walk>\/\fR
.SH OPTIONS
.TP
\fB\-\-ch\fR or \fB\-\-create\-histogram\fR
Computes full histogram alongside overview.
.TP
\fB\-\-chf\fR or \fB\-\-create\-histogram\-fast\fR
Computes a histogram in fast mode which
samples partial tiles.
.TP
\fB\-\-compression\-quality\fR
Compression quality for TIFF JPEG takes
values from 0 to 100, where 100 is best.
For J2K plugin, numerically_lossless,
visually_lossless, lossy
.TP
\fB\-\-compression\-type\fR
Compression type can be: deflate, jpeg, lzw,
none or packbits
.TP
\fB\-\-compute\-min\-max\fR
Turns on min, max scanning when reading
tiles and writes a dot omd file. This option
assumes the null is known.
.TP
\fB\-\-compute\-min\-max\-null\fR
Turns on min, max, null scanning when
reading tiles and write a dot omd file. This
option tries to find a null value which is
useful for float data.
.TP
\fB\-\-create\-histogram\-r0\fR
Forces create\-histogram code to compute a
histogram using r0 instead of the starting
resolution for the overview builder. Can
require a separate pass of R0 layer if the
base image has built in overviews.
.TP
\fB\-\-disable\-elev\fR
Will disable the elevation
.TP
\fB\-\-disable\-notify\fR
Takes an argument. Arguments are ALL, WARN,
NOTICE, INFO, FATAL, DEBUG.  If you want
multiple disables then just do multiple
\fB\-\-disable\-notify\fR on the command line.  All
argument are case insensitive.  Default is
all are enabled.
.TP
\fB\-\-disable\-plugin\fR
Will disable the plugin loader
.TP
\fB\-\-dump\-filtered\-image\-list\fR
Outputs list of filtered images and
extensions.
.TP
\fB\-\-list\-entries\fR
Lists the entries within the image
.TP
\fB\-\-max\fR
Overrides max value for compute\-min\-max
option.
.TP
\fB\-\-min\fR
Overrides min value for compute\-min\-max
option.
.TP
\fB\-\-null\fR
<null_value> Overrides null value for
compute\-min\-max option.  e.g. \fB\-9999\fR.0 for
float data
.TP
\fB\-\-of\fR or \fB\-\-output\-files\fR
Output image files we can open, exluding
overviews.
.TP
\fB\-\-options\fR
<options.kwl>  This can be all or part of
the application options. Also used for
custom prep, per file and post system
commands. To get a template you can turn on
trace to the ossimImageUtil class by adding
"\-T ossimImageUtil" to your command.
.TP
\fB\-\-ossim\-logfile\fR
takes a logfile as an argument.  All output
messages are redirected to the specified log
file.  By default there is no log file and
all messages are enabled.
.TP
\fB\-\-ot\fR
<overview_type> Overview type. see list at
bottom for valid types.
(default=ossim_tiff_box)
.TP
\fB\-\-override\-filtered\-images\fR
Allows processing of file that is in the
filtered image list.
.TP
\fB\-\-reader\-prop\fR
Adds a property to send to the reader.
format is name=value
.TP
\fB\-\-rebuild\-histogram\fR
Rebuild histogram even if they are already
present.
.TP
\fB\-\-threads\fR
<threads> The number of threads to use.
(default=1) Note a default can be set in
your ossim preferences file by setting the
key "ossim_threads".
.TP
\fB\-\-tile\-size\fR
<size> Defines the tile size for overview
builder.  Tiff option only. Must be a
multiple of 16. Size will be used in both x
and y directions. Note a default can be set
in your ossim preferences file by setting
the key "tile_size".
.TP
\fB\-\-writer\-prop\fR
Adds a property to send to the writer.
format is name=value
.TP
\fB\-K\fR
specify individual keywords to add to the
preferences keyword list: name=value
.TP
\fB\-P\fR
specify a preference file to load
.TP
\fB\-T\fR
specify the classes to trace, ex:
ossimInit|ossimImage.*
will trace ossimInit and all ossimImage
classes
.TP
\fB\-a\fR or \fB\-\-include\-fullres\fR
Copy full res dataset to overview file as
well as building reduced res sets. Option
only valid with tiff overview builder.
Requires \fB\-o\fR option.
.TP
\fB\-d\fR
<output_directory> Write overview to output
directory specified.
.TP
\fB\-h\fR
Display this information
.TP
\fB\-i\fR or \fB\-\-internal\-overviews\fR
Builds internal overviews. Requires \fB\-o\fR
option. Option only valid with tiff input
image and tiff overview builder. WARNING:
Modifies source image and cannot be undone!
.TP
\fB\-o\fR
Creates overviews. (default=ossim_tiff_box)
.TP
\fB\-r\fR or \fB\-\-rebuild\-overviews\fR
Rebuild overviews even if they are already
present.
.TP
\fB\-s\fR
Stop dimension for overviews.  This controls
how
many layers will be built. If set to 64 then
the builder will stop when height and width
for current level are less than or equal to
64.  Note a default can be set in the ossim
preferences file by setting the keyword
"overview_stop_dimension".
.PP
Valid overview types:
ossim_tiff_box  
ossim_tiff_nearest      
.PP
Example commands:
.PP
// A single image standard tiff overviews, histogram:
ossim\-preproc \fB\-o\fR \fB\-\-ch\fR <file>
.PP
// A single image with j2k overviews(requires kakadu plugin), histogram:
ossim\-preproc \fB\-\-ot\fR ossim_kakadu_nitf_j2k \fB\-\-ch\fR <file>
.PP
// j2k, histogram, 4 threads
.PP
// standard tiff overviews, full histogram, 4 threads:
ossim\-preproc \fB\-r\fR \fB\-o\fR \fB\-\-ch\fR \fB\-\-threads\fR 4 <directory_to_walk>
.PP
// j2k, histogram (fast mode), 4 threads
ossim\-preproc \fB\-r\fR \fB\-\-ot\fR ossim_kakadu_nitf_j2k \fB\-\-chf\fR \fB\-\-threads\fR 4 <directory_to_walk>
.PP
// tiff, jpeg compression, histogram, 4 threads
ossim\-preproc \fB\-r\fR \fB\-\-ch\fR \fB\-\-compression\-quality\fR 75 \fB\-\-compression\-type\fR jpeg \fB\-\-threads\fR 4 <directory_to_walk>
ossim\-preproc \fB\-r\fR \fB\-\-ch\fR \fB\-\-compression\-quality\fR 75 \fB\-\-compression\-type\fR jpeg \fB\-\-threads\fR 4 <directory_to_walk>
.PP
// Process all the tiffs in a directory feeding "prep", "file", "post" system commands via the \fB\-\-options\fR option which includes indexing file into the omar database via omar\-data\-mgr app:
ossim\-preproc \fB\-\-options\fR preproc\-options.kwl \fB\-r\fR \fB\-o\fR \fB\-\-ch\fR *.tif
.PP
// Contents of preproc\-options.kwl used in above command:
prep.command0: echo start_time: %{date}
prep.command0.strf_time_format: %Y%m%d%H%M%S
prep.command1: mkdir \fB\-p\fR %{date}
file.command0: mv %{file_no_ext}.* %{date}/.
file.command1: omar\-data\-mgr \fB\-u\fR http://localhost:8080/omar add %{date}/%{basename}
post.command0: echo end_time: %{date}
post.command0.strf_time_format: %Y%m%d%H%M%S
.PP
NOTES:
.TP
\fB\-\-ch\fR
equals \fB\-\-create\-histogram\fR
.HP
\fB\-\-chf\fR equals \fB\-\-create\-histogram\-fast\fR
.PP
Expanded command option variables:
.PP
%{basename}        = filename without path
%{basename_no_ext} = filename without path and without extension
%{date}            = Expanded to current zulu time. Default format=yyyymmdd
.IP
output format controlled by command0.strf_time_format key.
.PP
%{dirname}         = path of filename
%{file}            = filename being processed
%{file_no_ext}     = filename with no extension
.SH "SEE ALSO"
The full documentation for
.B ossim-preproc
is maintained as a Texinfo manual.  If the
.B info
and
.B ossim-preproc
programs are properly installed at your site, the command
.IP
.B info ossim-preproc
.PP
should give you access to the complete manual.