Input parameters
Below is the full description for all the parameters controlling inputs that can be modified from a batch file. There are four duplicate entries, one for each input, so it's rather long.
Each input has an entry for each input method, and which input method is active is controlled by which parameters are set:
- If you want to use RGB, make sure to set at least
.rgb.filename
- If you want to use ENVI, make sure to set at least
.envi.filename
- If you want to use PARC, make sure to set at least
.parc.filename
- If you want to use multifile, make sure to set at least at least
.multifile.directory
and add at least one file by adding to.multifile.files
- If you want to use PDS4, make sure to set at least at least
.pds4.directory
and add at least one file by adding to.pds4.files
Example
# input 0 is an RGB file called foo.png
inputs.0.rgb.filename = foo.png
# input 1 is a multifile - the images are in ../test_data/images
# and they
inputs.1.multifile.directory = ../test_data/images
# all .bin files called foo0..foo9 are to be added
.filenames.+ = foo[0-9].bin
# and all .bins called bar0..bar9
.+ = bar[0-9].bin
Parameter table
inputs | 0 | inputs by index | rgb | RGB input method | filename: string (default None) | filename |
envi | ENVI input method | filename: string (default None) | filename (without extension) | |||
multifile | Multifile input method | directory: string (default None) | directory to load from | |||
filenames: list of string (default '[]') | list of filenames or filename patterns to match. All files matching each pattern will be added, sorted by name within each pattern. | |||||
filter_pattern: string (default '.*(?P | pattern for filter identification | |||||
filter_set: string (default 'PANCAM') | name of filter set to use | |||||
bit_depth: integer (default None) | number of bits used in the image (default is all bits) | |||||
preset: string (default None) | preset name for some params (can be overridden by other params) | |||||
raw | parameters for loading raw data | format: string (default 'u16') | integer format (u16 u8 or f32) | |||
width: integer (default 1024) | image width | |||||
height: integer (default 1024) | image height | |||||
bigendian: boolean (default False) | whether the data is big-endian | |||||
offset: integer (default 0) | size of the header in bytes (this is skipped) | |||||
rot: integer (default 0) | counter-clockwise rotation of the image in degrees (must be multiple of 90) | |||||
horzflip: boolean (default False) | whether the image is flipped horizontally (after rotation) | |||||
vertflip: boolean (default False) | whether the image is flipped vertically (after rotation) | |||||
pds4 | PDS4 input method | directory: string (default None) | directory to load from | |||
filenames: list of string (default '[]') | list of filenames or filename patterns to match. All files matching each pattern will be added, sorted by name within each pattern. | |||||
parc | PCOT datum archive input method | filename: string (default None) | filename | |||
itemname: string (default 'main') | name of the item in the archive | |||||
direct | Direct input method | filename: string (default None) | filename | |||
1 | inputs by index | rgb | RGB input method | filename: string (default None) | filename | |
envi | ENVI input method | filename: string (default None) | filename (without extension) | |||
multifile | Multifile input method | directory: string (default None) | directory to load from | |||
filenames: list of string (default '[]') | list of filenames or filename patterns to match. All files matching each pattern will be added, sorted by name within each pattern. | |||||
filter_pattern: string (default '.*(?P | pattern for filter identification | |||||
filter_set: string (default 'PANCAM') | name of filter set to use | |||||
bit_depth: integer (default None) | number of bits used in the image (default is all bits) | |||||
preset: string (default None) | preset name for some params (can be overridden by other params) | |||||
raw | parameters for loading raw data | format: string (default 'u16') | integer format (u16 u8 or f32) | |||
width: integer (default 1024) | image width | |||||
height: integer (default 1024) | image height | |||||
bigendian: boolean (default False) | whether the data is big-endian | |||||
offset: integer (default 0) | size of the header in bytes (this is skipped) | |||||
rot: integer (default 0) | counter-clockwise rotation of the image in degrees (must be multiple of 90) | |||||
horzflip: boolean (default False) | whether the image is flipped horizontally (after rotation) | |||||
vertflip: boolean (default False) | whether the image is flipped vertically (after rotation) | |||||
pds4 | PDS4 input method | directory: string (default None) | directory to load from | |||
filenames: list of string (default '[]') | list of filenames or filename patterns to match. All files matching each pattern will be added, sorted by name within each pattern. | |||||
parc | PCOT datum archive input method | filename: string (default None) | filename | |||
itemname: string (default 'main') | name of the item in the archive | |||||
direct | Direct input method | filename: string (default None) | filename | |||
2 | inputs by index | rgb | RGB input method | filename: string (default None) | filename | |
envi | ENVI input method | filename: string (default None) | filename (without extension) | |||
multifile | Multifile input method | directory: string (default None) | directory to load from | |||
filenames: list of string (default '[]') | list of filenames or filename patterns to match. All files matching each pattern will be added, sorted by name within each pattern. | |||||
filter_pattern: string (default '.*(?P | pattern for filter identification | |||||
filter_set: string (default 'PANCAM') | name of filter set to use | |||||
bit_depth: integer (default None) | number of bits used in the image (default is all bits) | |||||
preset: string (default None) | preset name for some params (can be overridden by other params) | |||||
raw | parameters for loading raw data | format: string (default 'u16') | integer format (u16 u8 or f32) | |||
width: integer (default 1024) | image width | |||||
height: integer (default 1024) | image height | |||||
bigendian: boolean (default False) | whether the data is big-endian | |||||
offset: integer (default 0) | size of the header in bytes (this is skipped) | |||||
rot: integer (default 0) | counter-clockwise rotation of the image in degrees (must be multiple of 90) | |||||
horzflip: boolean (default False) | whether the image is flipped horizontally (after rotation) | |||||
vertflip: boolean (default False) | whether the image is flipped vertically (after rotation) | |||||
pds4 | PDS4 input method | directory: string (default None) | directory to load from | |||
filenames: list of string (default '[]') | list of filenames or filename patterns to match. All files matching each pattern will be added, sorted by name within each pattern. | |||||
parc | PCOT datum archive input method | filename: string (default None) | filename | |||
itemname: string (default 'main') | name of the item in the archive | |||||
direct | Direct input method | filename: string (default None) | filename | |||
3 | inputs by index | rgb | RGB input method | filename: string (default None) | filename | |
envi | ENVI input method | filename: string (default None) | filename (without extension) | |||
multifile | Multifile input method | directory: string (default None) | directory to load from | |||
filenames: list of string (default '[]') | list of filenames or filename patterns to match. All files matching each pattern will be added, sorted by name within each pattern. | |||||
filter_pattern: string (default '.*(?P | pattern for filter identification | |||||
filter_set: string (default 'PANCAM') | name of filter set to use | |||||
bit_depth: integer (default None) | number of bits used in the image (default is all bits) | |||||
preset: string (default None) | preset name for some params (can be overridden by other params) | |||||
raw | parameters for loading raw data | format: string (default 'u16') | integer format (u16 u8 or f32) | |||
width: integer (default 1024) | image width | |||||
height: integer (default 1024) | image height | |||||
bigendian: boolean (default False) | whether the data is big-endian | |||||
offset: integer (default 0) | size of the header in bytes (this is skipped) | |||||
rot: integer (default 0) | counter-clockwise rotation of the image in degrees (must be multiple of 90) | |||||
horzflip: boolean (default False) | whether the image is flipped horizontally (after rotation) | |||||
vertflip: boolean (default False) | whether the image is flipped vertically (after rotation) | |||||
pds4 | PDS4 input method | directory: string (default None) | directory to load from | |||
filenames: list of string (default '[]') | list of filenames or filename patterns to match. All files matching each pattern will be added, sorted by name within each pattern. | |||||
parc | PCOT datum archive input method | filename: string (default None) | filename | |||
itemname: string (default 'main') | name of the item in the archive | |||||
direct | Direct input method | filename: string (default None) | filename |
Automatically generated by generate_autodocs.py
Date: 2025-02-17T16:09:18.986731