| | 1 | '''ossim-preproc''' |
| | 2 | |
| | 3 | Used to create reduced resolution data sets, histograms, and so on. Application does directory walking and is threaded at a file level. |
| | 4 | |
| | 5 | '''Usage:''' |
| | 6 | |
| | 7 | |
| | 8 | |
| | 9 | {{{ |
| | 10 | $ ossim-preproc |
| | 11 | Usage: ossim-preproc [options] <file-or-directory-to-walk> |
| | 12 | Options: |
| | 13 | --ch or --create-histogram Computes full histogram alongside overview. |
| | 14 | --chf or --create-histogram-fast Computes a histogram in fast mode which |
| | 15 | samples partial tiles. |
| | 16 | --compression-quality Compression quality for TIFF JPEG takes |
| | 17 | values from 0 to 100, where 100 is best. |
| | 18 | For J2K plugin, numerically_lossless, |
| | 19 | visually_lossless, lossy |
| | 20 | --compression-type Compression type can be: deflate, jpeg, lzw, |
| | 21 | none or packbits |
| | 22 | --create-histogram-r0 Forces create-histogram code to compute a |
| | 23 | histogram using r0 instead of the starting |
| | 24 | resolution for the overview builder. Can |
| | 25 | require a separate pass of R0 layer if the |
| | 26 | base image has built in overviews. |
| | 27 | --disable-elev Will disable the elevation |
| | 28 | --disable-notify Takes an argument. Arguments are ALL, WARN, |
| | 29 | NOTICE, INFO, FATAL, DEBUG. If you want |
| | 30 | multiple disables then just do multiple |
| | 31 | --disable-notify on the command line. All |
| | 32 | argument are case insensitive. Default is |
| | 33 | all are enabled. |
| | 34 | --disable-plugin Will disable the plugin loader |
| | 35 | --list-entries Lists the entries within the image |
| | 36 | --of or --output-files Output image files we can open, exluding |
| | 37 | overviews. |
| | 38 | --ossim-logfile takes a logfile as an argument. All output |
| | 39 | messages are redirected to the specified log |
| | 40 | file. By default there is no log file and |
| | 41 | all messages are enabled. |
| | 42 | --ot <overview_type> Overview type. see list at |
| | 43 | bottom for valid types. |
| | 44 | (default=ossim_tiff_box) |
| | 45 | --reader-prop Adds a property to send to the reader. |
| | 46 | format is name=value |
| | 47 | --rebuild-histogram Rebuild histogram even if they are already |
| | 48 | present. |
| | 49 | --scanForMinMax Turns on min, max scanning when reading |
| | 50 | tiles. This option assumes the null is |
| | 51 | known. |
| | 52 | --scanForMinMaxNull Turns on min, max, null scanning when |
| | 53 | reading tiles. This option tries to find a |
| | 54 | null value which is useful for float data. |
| | 55 | --threads <threads> The number of threads to use. |
| | 56 | (default=1) Note a default can be set in |
| | 57 | your ossim preferences file by setting the |
| | 58 | key "ossim_threads". |
| | 59 | --tile-size <size> Defines the tile size for overview |
| | 60 | builder. Tiff option only. Must be a |
| | 61 | multiple of 16. Size will be used in both x |
| | 62 | and y directions. Note a default can be set |
| | 63 | in your ossim preferences file by setting |
| | 64 | the key "tile_size". |
| | 65 | --writer-prop Adds a property to send to the writer. |
| | 66 | format is name=value |
| | 67 | -K specify individual keywords to add to the |
| | 68 | preferences keyword list: name=value |
| | 69 | -P specify a preference file to load |
| | 70 | -T specify the classes to trace, ex: |
| | 71 | ossimInit|ossimImage.* |
| | 72 | will trace ossimInit and all ossimImage |
| | 73 | classes |
| | 74 | -V or --version Display version information. |
| | 75 | -a or --include-fullres Copy full res dataset to overview file as |
| | 76 | well as building reduced res sets. Option |
| | 77 | only valid with tiff overview builder. |
| | 78 | Requires -o option. |
| | 79 | -d <output_directory> Write overview to output |
| | 80 | directory specified. |
| | 81 | -h Display this information |
| | 82 | -o Creates overviews. (default=ossim_tiff_box) |
| | 83 | -r or --rebuild-overviews Rebuild overviews even if they are already |
| | 84 | present. |
| | 85 | -s Stop dimension for overviews. This controls |
| | 86 | how |
| | 87 | many layers will be built. If set to 64 then |
| | 88 | the builder will stop when height and width |
| | 89 | for current level are less than or equal to |
| | 90 | 64. Note a default can be set in the ossim |
| | 91 | preferences file by setting the keyword |
| | 92 | "overview_stop_dimension". |
| | 93 | |
| | 94 | |
| | 95 | Valid overview types: |
| | 96 | ossim_tiff_box |
| | 97 | ossim_tiff_nearest |
| | 98 | ossim_kakadu_nitf_j2k |
| | 99 | gdal_tiff_nearest |
| | 100 | gdal_tiff_average |
| | 101 | gdal_hfa_nearest |
| | 102 | gdal_hfa_average |
| | 103 | |
| | 104 | Example commands: |
| | 105 | |
| | 106 | // A single image standard tiff overviews, histogram: |
| | 107 | ossim-preproc -o --ch <file> |
| | 108 | |
| | 109 | // A single image with j2k overviews(requires kakadu plugin), histogram: |
| | 110 | ossim-preproc --ot ossim_kakadu_nitf_j2k --ch <file> |
| | 111 | |
| | 112 | // j2k, histogram, 4 threads |
| | 113 | |
| | 114 | // standard tiff overviews, full histogram, 4 threads: |
| | 115 | ossim-preproc -r -o --ch --threads 4 <directory_to_walk> |
| | 116 | |
| | 117 | // j2k, histogram (fast mode), 4 threads |
| | 118 | ossim-preproc -r --ot ossim_kakadu_nitf_j2k --chf --threads 4 <directory_to_walk> |
| | 119 | |
| | 120 | // tiff, jpeg compression, histogram, 4 threads |
| | 121 | ossim-preproc -r --ch --compression-quality 75 --compression-type jpeg --threads 4 <directory_to_walk> |
| | 122 | |
| | 123 | NOTES: |
| | 124 | |
| | 125 | --ch equals --create-histogram |
| | 126 | --chf equals --create-histogram-fast |
| | 127 | |
| | 128 | }}} |
| | 129 | |
