Description
The ImportToHIPS process imports various formats to HIPS and SIPS.
Inputs
Raw sensor data.
Outputs
A track line source.
Command Line Syntax
carisbatch --run ImportToHIPS --input-format <value> [options] <inputs> <output>
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
Common Options | ||||
--input-format | I | A string specifying the format of the data to import. One of: • ATLAS_ASD: Atlas ASD • ATLAS_HYDROSWEEPDS: Atlas Hydrosweep • ATLAS_SURF: Atlas SURF SDA • BATHYSWATH_SXR: Bathyswath raw SXR • BATHYSWATH_SXI: Bathyswath intermediate SXI • BATHYSWATH_SXP: Bathyswath processed SXP • CHIRPSCAN3D: Chirpscan3D BRF • CMAX: CMAX CMX,CM2,CMP • CODA: Coda COD • EDGETECH_260: Edgetech 260 • EDGETECH_JSF: Edgetech JSF • EDGETECH_MIDAS: Edgetech Midas • EIVA: EIVA SBD • ELAC: ELAC XSE • FURUNO: Furuno LOG • GEOACOUSTICS_RDF: GeoAcoustics RDF • GEOACOUSTICS_RFF: GeoAcoustics RFF • GSF: Generic Sensor Format GSF • HAWKEYE: Hawkeye BIN • HYPACK: Hypack RAW, HSX • HYPACK_HS2: Hypack HS2 • IMAGENEX: Imagenex 83p, 83m • KLEIN: Klein SDF • KONGSBERG: Kongsberg ALL • KONGSBERG_EA600: Kongsberg EA600 RAW, DEPTH • KRAKEN: Kraken TIL • LADS: LADS CAF • LAS: LAS • MARINESONICS: Marine Sonics MS TIFF • PROSAS: PROSAS IMG • QMIPS: QMIPS DAT • SCRIPPS: Scripps • SEABEAM: Seabeam • SEGY: SEGY | FALSE | This must be specified explicitly. |
--input-format (Continued) | • SHOALS: SHOALS OUT, HOF, TOF • SPAWAR: SPAWAR DAT • TELEDYNE: Teledyne TDY • TELEDYNE_7K: Teledyne S7K • TELEDYNE_PDS: Teledyne PDS • UNB: UNB MERGED • WINFROG: Winfrog RAW • XTF: Triton XTF | |||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. The default value is LLDG. | FALSE | |
--carry-raw-data-files | c | If set, copies the original data files to the processed data folders. | FALSE | |
--overwrite | If set, specified data will be overwritten. • BATHY: Bathymetry • NAVIGATION: Navigation • MOTION: Motion • BACKSCATTER: Backscatter • SIDE_SCAN: Sidescan | TRUE | ||
--filter-extent-type | Filter the navigation data to a specific geographical extent. • PROJECT: Project - Filter to the extents of the destination project. • CUSTOM: Custom - Manually set coordinates (min X/long), (min Y/lat), (max X/long), (max Y/lat) for the extents of the filter. | FALSE | ||
--extent | E | The extents that define the window. <LowerX> - A number specifying the lower left X origin in the coordinate reference system of the output. <LowerY> - A number specifying the lower left Y origin in the coordinate reference system of the output. <UpperX> - A number specifying the upper right X origin in the coordinate reference system of the output. <UpperY> - A number specifying the upper right Y origin in the coordinate reference system of the output. The unit is assumed to be that of the output's coordinate reference system, unless otherwise specified. When specifying units for un-projected data, an angle type unit is required. The order for un-projected coordinates is longitude followed by latitude. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad. This option is only applicable if FilterExtentType is set to CUSTOM. | FALSE | |
--filter | f | A number specifying the Z values to a min/max range. <FilterMin> - The minimum values for imported data. <FilterMax> - The maximum values for imported data. The valid range is +/- 15000. | FALSE | |
--filter-amplitude-percent | A number specifying how soundings are filtered by amplitude. Soundings that fall below the defined percentage of min/max amplitude values will be rejected. The valid range is 0 to 50. | FALSE | ||
--filter-angle-T1 | Filters transducer 1 data to a min/max angle. <MinAngle> - The minimum angle to filter. <MaxAngle> - The maximum angle to filter. The valid range is -20 to 100. | FALSE | ||
--filter-angle-T2 | Filters transducer 1 data to a min/max angle. <MinAngle> - The minimum angle to filter. <MaxAngle> - The maximum angle to filter. The valid range is -20 to 100. | FALSE | ||
--filter-range | Filters soundings by range from the transducer to the seafloor. <MinRange> - The minimum range to filter. <MaxRange> - The maximum range to filter. The valid range is 0 to 15000. | FALSE | ||
--filter-across-track-distance | Any soundings beyond the specified distance from nadir will be filtered. <Port> - The port side distance from nadir. <Starboard> - The starboard side distance from nadir. If not set, the default is to not filter. The valid range is 0 or greater. Supported units: metres. | FALSE | ||
--filter-depth-multiplier- | A number specifying the depth multiplier applied to nadir depth to determine the Swath distance outside which to filter data. The valid range is 0 to 50. | FALSE | ||
--filter-stat-threshold | A number specifying the statistical threshold by which the standard deviation should be multiplied by in order to get the Confidence Interval. The valid range is 1 to 3. | FALSE | ||
--filter-stat-sector-angle | A number specifying the statistical filter angle. Cannot be used with horizontal bin. The valid range is 0.3 to 9.0. | FALSE | ||
--filter-stat-bin- size | A number specifying the statistical filter bin resolution as distance on the ground. Cannot be used with sector angle. The valid range is 0.03 to 5. This option is only applicable if FilterStatSectorAngle is not used. | FALSE | ||
--filter-stat-thin-factor | A number specifying the thinning factor applied to soundings converted per swath sector. The default value is 4. The thinning factor uses a power of two reduction control (2, 4, 8, etc.) so that one of two, one of four, one of eight, etc. One of: • NONE: None - No thinning is applied • 2 • 4 • 8 • 16 • 32 • 64 • 128 • 256 This option is only applicable with FilterStatSectorAngle or FilterStatBinSize. Used with FilterStatDepthComparator. | FALSE | ||
--filter-stat-depth-comparator | A string specifying the thinning equation to compare filtered values from bin of data against either the mean or median value in the bin and retain the closest. • MEAN: Mean • MEDIAN: Median Only applicable with StatisticalThinningFactor. | FALSE | ||
--filter-keep-thinned-data | If set, converts the filtered data to HDCS. Flags will be set to rejected. | FALSE | ||
InputFormat = Atlas_ASD Options | ||||
--convert-side-scan | s | If set, the specified side scan frequency is imported. • HIGH: High - High frequency • LOW: Low - Low frequency The default is value HIGH. | FALSE | |
InputFormat = Atlas_HydrosweepDS Options | ||||
--survey-year | y | A number specifying the Year of the survey for Hydrosweep data. The default is to use the current year. The format is "YYYY". | FALSE | |
InputFormat = Atlas_SURF Options | ||||
--convert-side-scan | s | If set, converts side scan from SURF data. | FALSE | |
--convert-bathymetry | b | The type of SURF bathymetry to convert. One of: • MULTIBEAM: Multibeam • SINGLEBEAM_LOW: Single Beam (Low Frequency) • SINGLEBEAM_MED: Single Beam (Medium Frequency) • SINGLEBEAM_HIGH: Single Beam (High Frequency) • DUAL_LOW_MED: Dual-Frequency Single Beam (Low/Medium) • DUAL_LOW_HIGH: Dual-Frequency Single Beam (Low/High) • DUAL_MED_HIGH: Dual-Frequency Single Beam (Medium/High) The default is MULTIBEAM. | FALSE | |
--use-higher-frequency | F | If set, higher frequency sounding is the primary sounding for dual beam SURF data. If not set, lower frequency sounding is primary. | FALSE | |
InputFormat = BATHYSWATH_SXR Options | ||||
--sound-velocity | If set, the sound velocity applied to the imported SXR data. The default value is 1500 m/s. Units are m/s. | FALSE | ||
InputFormat = BATHYSWATH_SXI Options | ||||
| N/A | |||
InputFormat = BATHYSWATH_SXP Options | ||||
| N/A | |||
InputFormat = CHIRPSCAN3D Options | ||||
| N/A | |||
InputFormat = CMAX Options | ||||
| N/A | |||
InputFormat = CODA Options | ||||
--cable-out-is-layback | L | If set, omits the sensor depth and treats cable out as layback. | FALSE | |
--sonar-channel | s | A string specifying the sonar channel to convert. One of: • ANALOG: Analog • EDGETECH_DF: Edgetech DF1000 • EDGETECH_FSU: Edgetech FSIU • KLEIN_3000: Klein 3000 • EDGETECH_ACI: Edgetech ACI 272T • RESON_81X: Reson 81xx • BENTHOS_SIS: Benthos SIS • ATLAS: Atlas • EDGETECH_MPX: Edgetech Discover/MPX • KLEIN_5000: Klein 5000 • SES: SES Multilink • EDGETECH_4200: Edgetech 4200 • EDGETECH_4100: Edgetech 4100 • BENTHOS_1600: Benthos 1600 The default value is ANALOG. | FALSE | |
InputFormat = EDGETECH_260 Options | ||||
N/A | ||||
InputFormat = EDGETECH_JSF Options | ||||
--convert-side-scan | s | The frequency channel to convert. Selecting Auto converts low frequency if it exists, otherwise converts high frequency. One of: • NONE: None - No side scan is converted • AUTO: Auto - Converts low frequency if it exists, otherwise converts high. • HIGH: High - High frequency • LOW: Low - Low frequency The default value is NONE. | FALSE | |
--convert-from-cable-out | If set, converts from cable out, otherwise layback is used. | FALSE | ||
--sensor-depth-location | Source location for sensor depth. • SENSOR: Sensor • DISCOVER2: Discover2 The default value is SENSOR. | FALSE | ||
--sensor-altitude-location | Source location for altitude. • SENSOR: Sensor • DISCOVER2: Discover2 The default value is SENSOR. | FALSE | ||
--convert-bathymetry | b | If set, converts JSF bathymetry. | FALSE | |
--output-filtered-data | If set, converts filtered data as Rejected. | FALSE | ||
--echo-strength-percent | A number specifying the percentage value to filter Echo Strength. If not set, acquisition setting is used. The valid range is 0 to 100. | FALSE | ||
--quality-percent | A number specifying the percentage value to filter Quality. All data with a quality percentage below the value set will be filtered. If not set, acquisition setting is used. One of: • 50 • 60 • 70 • 80 • 85 • 90 | FALSE | ||
--snr-db | n | A number specifying the decibel value to filter SNR. Valid values are from 0 to 30. If not set, acquisition setting is used. | FALSE | |
InputFormat = EDGETECH_MIDAS Options | ||||
--convert-side-scan | s | The frequency channel to convert. • LOW: Low - 100 kHz • HIGH: High - 500 kHz The default value is LOW. | FALSE | |
InputFormat = EIVA Options | ||||
--convert-side-scan | s | The type of ASD side scan to convert. • HIGH: High • LOW: Low The default value is HIGH. | FALSE | |
--depth-source | The source of bathymetry. • BINARY: Binary - Default source of bathymetry • XML: XML - XML portion of Atlas ASD data in the side scan datagram The default value is BINARY. | FALSE | ||
--navigation-device | A number specifying the navigation device number. The valid range is 0 to 4. The default value is 0. | FALSE | ||
--heading-device | A number specifying the heading device number. The valid range is 0 to 4. The default value is 0. | FALSE | The default is 0. | |
--motion-device | A number specifying the motion device number. The valid range is 0 to 4. The default value is 0. | FALSE | The default is 0. | |
--convert-vehicle-depth | If set, stores the EIVA sub-packets as HIPS delta draft/subsea depth. | FALSE | ||
--pad-with-null | If set, replaces missing data with NULL (rejected) beams in the case of dual head data where the data from head 1 is missing. | FALSE | ||
--swap-transducers | If set, switches data between heads (in a dual-head setup) on conversion. | FALSE | ||
--separate-dual-head-data | If set, the soundings from dual head transducer data are not combined into a single HIPS profile. | FALSE | ||
InputFormat = ELAC Options | ||||
--attitude-source | The source of the attitude. • NAVIGATION: Navigation - Navigation records • MULTIBEAM: Multibeam - Multibeam records The default value is NAVIGATION. | FALSE | ||
--surface-sound-speed | A number specifying the user defined surface sound speed. If not set, a sound speed is interpolated from the stored sound velocity profile. | FALSE | ||
--convert-side-scan | s | If set, converts side scan data. | FALSE | |
--stbd-to-port-numbering | If set, numbers the beams starboard to port. If not set, numbers the beams port to starboard. | FALSE | ||
--pad-with-null | If set, replaces missing data with NULL (rejected) beams in the case of dual head data where the data from head 1 is missing. | FALSE | ||
InputFormat = FURUNO Options | ||||
--convert-side-scan | s | If set, converts side scan data. | FALSE | |
InputFormat = GeoAcoustics_RDF Options | ||||
--gps-string-type | The navigation string to read. One of: • ANY: Any - Attempts to automatically determine the string type • GGK: GGK - GGK string • GGA: GGA - GGA string • GLL: GLL - GLL string The default value is ANY. | FALSE | ||
--convert-vehicle-depth | If set, converts Aux1 as delta draft/subsea depth. | FALSE | ||
--filter-water-column | If set, data flagged by water column filter during acquisition in GeoSwath Plus GS+ will be converted as rejected. | FALSE | ||
--filter-post-processing | If set, data flagged by specified filter during post-processing in GeoSwath Plus GS+ will be converted as rejected. • AMPLITUDE: Amplitude • LIMITS: Limits • ACROSS_TRACK: Across Track • ALONG_TRACK_CELL: Along Track/Cell | TRUE | ||
InputFormat = GeoAcoustics_RFF Options | ||||
--convert-vehicle-depth | If set, converts Aux1 as delta draft/subsea depth. | FALSE | ||
--filter-acquisition | If set, data flagged by specified filter during acquisition in GeoSwath Plus GS4 will be converted as rejected. • GROUP_BOTTOM_TRACK: Group/Bottom Track • WATER_COLUMN: Water Column | TRUE | ||
--filter-post-processing | If set, data flagged by specified filter during post-processing in GeoSwath Plus GS4 will be converted as rejected. • AMPLITUDE: Amplitude • LIMITS: Limits • ACROSS_TRACK: Across Track • ALONG_TRACK_CELL: Along Track/Cell | TRUE | ||
InputFormat = GSF Options | ||||
--depth-source | The source for depth data. • TRUE: True - True Depth • NOMINAL: Nominal - Nominal Depth The default value is TRUE. | FALSE | The default is TRUE. | |
--include-offline | If set, converts data flagged as offline. | FALSE | ||
--reject-offline | If set, converts the offline data as rejected. Only applicable if IncludeOffline is set to True. | FALSE | ||
InputFormat = Hawkeye Options | ||||
--depth-source | Sets the source for depths. • DEPTH: Depth • POINT: Point Altitude The default value is DEPTH. | FALSE | ||
--import-type | If set, converts all data flagged by specified value. • FOUND: Found • NOT_FOUND: Not Found • INVALID: Invalid • UNCLASSIFIED: Unclassified • LAND: Land • WATER_SURFACE: Water Surface • SHALLOW: Shallow • BOTTOM: Bottom • HIGHLAND: Highland • TARGET: Target | TRUE | ||
--invalid-as-positive-99 | If set, assigns a value of +99m to invalid points rejected during conversion. If not set, points are assigned a depth of -99m. | FALSE | ||
InputFormat = Hypack Options | ||||
--sound-velocity | A number specifying the sound velocity. The default is 1500 m/s. This value is used to compute the original travel time for single and multi-transducer (sweep) data. | FALSE | ||
--convert-bathymetry | b | The type of bathymetry to convert. One of: • NONE: No bathymetry converted • MULTIBEAM: Multibeam • MULTITRANS: Multi-transducer • SINGLEBEAM: Single beam, single frequency • DUAL_PRIM_SEC: Single beam as Primary, Secondary frequency • DUAL_SEC_PRIM: Single beam as Secondary, Primary frequency The default value is MULTIBEAM. | FALSE | |
--convert-side-scan | s | The side scan channel to convert. One of: • NONE: No side scan converted • HIGH: High frequency • LOW: Low frequency The default value is NONE. | FALSE | |
--apply-static-draft | If set, applies the stored static draft value to the depths. | FALSE | ||
--navigation-device | A number specifying the navigation device number to override Hypack default. | FALSE | ||
--heading-device | A number specifying the heading device number to override Hypack default. | FALSE | ||
--motion-device | A number specifying the motion device number to override Hypack default. | FALSE | ||
--port-device | A number specifying the port transducer device number to override Hypack default. | FALSE | ||
--stbd-device | A number specifying the starboard transducer device number to override Hypack default. | FALSE | ||
--sow-device | A number specifying the speed over water device number to override Hypack default. | FALSE | ||
--hours-from-gmt | A number specifying the offset in hours from GMT to apply to all time stamps. Used when acquisition time was not GMT. | FALSE | ||
InputFormat = Hypack_HS2 Options | ||||
--survey-date | y | A string specifying the survey date to override the date in the HS2 file. Set a year and julian day. The format is "YYYY-DDD". | FALSE | |
--depths-in-feet | If set, treats the depths stored in the HS2 file as feet. | FALSE | ||
InputFormat = Imagenex Options | ||||
--gps-string-type | The navigation string to read in. If ANY is used and both are present in the raw data, both strings will be converted. One of: • ANY: Any • GGA: GGA • GGK: GGK The default value is ANY. | FALSE | ||
InputFormat = Klein Options | ||||
--convert-side-scan | s | The side scan channel to convert. One of: • NONE: No side scan is converted • HIGH: High frequency • LOW: Low frequency The default value is LOW. | FALSE | |
--include-hidden | If set, converts data flagged as hidden (redundant data collected during acquisition). | FALSE | ||
--convert-sss-gyro | If set, converts the side scan gyro. | FALSE | ||
--convert-aux-altitude | If set, converts the sonar altitude from the auxiliary altitude field. If not set, converts from Towfish altitude field. | FALSE | ||
--pressure-sensor-psi | The pressure sensor PSI. One of: • 100 • 300 • 1000 • 1500 The default value is 1000. | FALSE | ||
--pressure-sensor-range | The pressure sensor voltage range. • 05: 0 - 5V • 15: 1 - 5V The default value is 05. | FALSE | ||
--cable-out-is-layback | If set, omits the sensor depth and treats cable out as layback | FALSE | ||
--convert-aux-depth | If set, uses the data in the auxiliary depth field, otherwise calculate depth from pressure sensor voltage. Only applicable if CableOutIsLayback is used. | FALSE | ||
--convert-vehicle-depth | Convert depth field as Delta Draft. One of: • NONE: No depths are converted. • AUX_DEPTH: Depth is converted from the Auxiliary depth field. • PRESSURE: Calculate depth from pressure sensor voltage. The default value is AUX_Depth. | FALSE | ||
--convert-bathymetry | b | If set, converts bathymetry data. | FALSE | |
--snr-filter | A number specifying the value above or below the stored SNR value to filter by. If the data has a smaller SNR than specified in the Threshold field, it is then converted and flagged as Rejected. Minimum/maximum threshold settings are -50.0/50.0, respectively. If not set, does not filter. | FALSE | ||
--uncertainty-filter | A number specifying the value above or below the stored uncertainty value to filter by. If the data has a smaller uncertainty than specified in the Threshold field, it is then converted and flagged as Rejected. Minimum/maximum threshold settings are 0.0/1.0 respectively. If not set, does not filter. | FALSE |
| |
--confidence-value | A number specifying the confidence value used to filter the bathymetry. The valid range is 50 to 100. The default value is 70. | FALSE | ||
--output-filtered-data | If set, converts filtered data as rejected. If not set, does not convert. | FALSE | ||
--heave-positive-down | Set if the direction that Heave data is stored in the SDF file when created by the Klein SonarPro® software is positive down. | FALSE | ||
--pitch-positive-bow-up | Set if the direction that Pitch data is stored in the SDF file when created by the Klein SonarPro®software is positive bow up, otherwise it is converted as positive bow down. | FALSE | ||
--roll-positive-port-up | Set if the direction that Roll data is stored in the SDF file when created by the Klein SonarPro®software is positive port up, otherwise it is converted as positive port down. | FALSE | ||
--yaw-ccw-from-north | Set if the direction that Yaw data is stored in the SDF file when created by the Klein SonarPro®software is counter-clockwise from north, otherwise it is converted as positive clockwise from north. | FALSE | ||
InputFormat = Kongsberg Options | ||||
--convert-navigation | N | If set, converts navigation data to HDCS, otherwise reference the file directly. | FALSE | |
--navigation-device | The navigation device number to convert if navigation is converted to HDCS, and the source of GPS height if GGA or GGK is used. One of: • AUTO • NAVIGATION_1 • NAVIGATION_2 • NAVIGATION_3 The default value is AUTO. | FALSE | ||
--gps-height-device | The GPS height device to use. One of: • EM_HEIGHT • GGA • GGK The default value is EM_HEIGHT. | FALSE | ||
--gps-time-stamps | Source for navigation time stamps. One of: • AUTO • SYSTEM • GPS The default value is AUTO. | FALSE | ||
--heading-device | The heading device to use. One of: • AUTO • MRU1 • MRU2 • EM_Height The default value is AUTO. | FALSE | ||
--heave-device | The heave device number to use. One of: • AUTO • MRU1 • MRU2 The default value is AUTO. | FALSE | ||
--pitch-device | The pitch device number to use. One of: • AUTO • MRU1 • MRU2 The default value is AUTO. | FALSE | ||
--roll-device | The roll device number to use. One of: • AUTO • MRU1 • MRU2 The default value is AUTO. | FALSE | ||
--convert-vehicle-depth | If set, converts depth field as Delta Draft. Ignored/automatic for newer sonar models. | FALSE | ||
--time-shift | A number specifying the seconds to add to each datagram time. | FALSE | ||
InputFormat = Kongsberg_EA600 Options | ||||
--convert-bathymetry | b | The EA400/EA600 single beam to convert. • SINGLEBEAM_P: Single beam as primary • SINGLEBEAM_S: Single beam as secondary The default value is SINGLEBEAM_P. | FALSE | |
--port-device | P | The EA400/EA600 side scan port device number. Valid values from 1 to 9. One of: • NONE: No Port device number. • 1: Device 1 • 2: Device 2 • 3: Device 3 • 4: Device 4 • 5: Device 5 • 6: Device 6 • 7: Device 7 • 8: Device 8 • 9: Device 9 The default value is 1. | FALSE | |
--stbd-device | S | The EA400/EA600 side scan starboard device number. One of: • NONE: No Starboard device number. • 1: Device 1 • 2: Device 2 • 3: Device 3 • 4: Device 4 • 5: Device 5 • 6: Device 6 • 7: Device 7 • 8: Device 8 • 9: Device 9 The default value is NONE. | FALSE | |
InputFormat = Kraken Options | ||||
N/A | ||||
InputFormat = LADS Options | ||||
N/A | ||||
InputFormat = LAS Options | ||||
--invert-elevation | If set, inverts the height convention of the incoming depths. | FALSE | ||
--override-date | If set, overrides the date stored in the file header. | FALSE | ||
--survey-date | y | A string specifying the reference date if Override is used. Set a year and julian day. [YYYY-DDD] | FALSE | |
InputFormat = MarineSonics Options | ||||
N/A | ||||
InputFormat = ProSAS Options | ||||
--convert-q0-data | q | If set, converts quality 0 data. | FALSE | |
InputFormat = QMIPS Options | ||||
--use-alt-channel | If set, uses side scan from channels 3 and 4, instead of channels 1 and 2. | FALSE | ||
InputFormat = Scripps Options | ||||
N/A | ||||
InputFormat = Seabeam Options | ||||
--convert-side-scan | s | If set, converts side scan. | FALSE | |
--convert-vehicle-depth | If set, converts vehicle depth and delta draft/subsea depth. | FALSE | ||
InputFormat = SEGY Options | ||||
N/A | ||||
InputFormat = SHOALS Options | ||||
--confidence-value | A number specifying the confidence value flagged during acquisition and used to filter the data. Valid values from 50 to 100. The default value is 70. | FALSE | ||
--tof-convert | Convert the first (top of vegetation canopy) or second pulse (return from the ground). • FIRST: First pulse • SECOND: Second pulse The default value is SECOND. | FALSE | ||
InputFormat = SPAWAR Options | ||||
N/A | ||||
InputFormat = TeledyneTDY Options | ||||
N/A | ||||
InputFormat = Teledyne7K Options | ||||
--separate-dual | If set, soundings from a dual head transducer are not combined into a single HIPS profile. | FALSE | ||
--reject-quality | Rejects bathymetry with the numbered quality flag. Quality 0 is lowest quality and 3 is highest. • 0: Quality 0 • 1: Quality 1 • 2: Quality 2 • 3: Quality 3 | TRUE | ||
--navigation-device | The navigation device. One of: • AUTO: Auto - Use 1003 if it exists • NAVIGATION: Navigation Record (1015) • POSITION: Position Record (1003) The default value is AUTO if it exists, otherwise 1015 is used. | FALSE | ||
--heading-device | The heading device. One of: • AUTO: Auto - Use 1013 if it exists • ATTITUDE: Attitude Record (1016) • HEADING: Heading Record (1013) • NAVIGATION: Navigation Record (1015) The default value is AUTO if it exists, other 1016 is used. If that is not available, 1015 is used. | FALSE | ||
--motion-device | The motion device. One of: • AUTO: Auto - Use 1012 if it exists • ATTITUDE: Attitude Record (1016) • RPH: Motion Record (1012) The default value is AUTO. | FALSE | ||
--swath-device | The swath device. One of: • AUTO: Auto - Use 7027 if it exists • BATHYMETRY: Bathymetry Records (7004/7006) • RAWDETECTION: Raw Detection Record (7027) The default value is AUTO, 7004/7006 otherwise. | FALSE | ||
--convert-vehicle-depth | If set, converts depth field as Delta Draft/Subsea depth. | FALSE | ||
InputFormat = TeledynePDS Options | ||||
--convert-bathymetry | b | The type of bathymetry to convert. One of: • MULTIBEAM: Multibeam bathymetry (default) • SINGLEBEAM: Singlebeam bathymetry • SINGLEBEAMDUAL: Dual frequency singlebeam The default value is MULTIBEAM. | FALSE | |
--include-offline | If set, converts data flagged as offline. | FALSE | ||
--reject-quality | Rejects bathymetry with the numbered quality flag. Quality 0 is lowest quality and 3 is highest. • 0: Quality 0 • 1: Quality 1 • 2: Quality 2 • 3: Quality 3 | TRUE | ||
--navigation-device | A number specifying the navigation device number. Valid values are from 1 to 5. Default is 1. | FALSE | ||
--heading-device | A number specifying the heading device number. Valid values are from 1 to 5. Default is 1. | FALSE | ||
--motion-device | A number specifying the motion device number. Valid values are from 1 to 5. Default is 1. | FALSE | ||
--source-type | T | The type of singlebeam data to convert. • ECHO_ID: Raw Data • CF_DEPTH: Processed The default value is ECHO_ID. Applies only when SINGLEBEAM is used. Dual frequency singlebeam can only be converted from the Raw Data (ECHO_ID) Source Type. Data from both a primary (P) and a secondary (S) device, with one of four channels for each device can be converted. | FALSE | |
--device-number | d | The singlebeam device number to convert. • 1 • 2 The default value is 1. Applies only when SINGLEBEAM or SINGLEBEAMDUAL is used. Setting a device that is not present will cause no depth data to be converted. | FALSE | |
--primary-channel | P | The primary singlebeam device and channel to assign. One of: • 1:1 • 1:2 • 1:3 • 1:4 • 2:1 • 2:2 • 2:3 • 2:4 The default value is 1:1. Applies only when SINGLEBEAM or SINGLEBEAMDUAL is used, and source type is ECHO_ID. Setting a device that is not present, or in which the selected depth channel is not available, will cause no depth data to be converted. | FALSE | |
--secondary-channel | S | The secondary singlebeam device and channel to assign. One of: • 1:1 • 1:2 • 1:3 • 1:4 • 2:1 • 2:2 • 2:3 • 2:4 The default value is 2:1. Applies only when SINGLEBEAMDUAL is used, and source type is ECHO_ID. Setting a device that is not present, or in which the selected depth channel is not available, will cause no depth data to be converted. | FALSE | |
InputFormat = UNB Options | ||||
--is-dual-head | If set, determines the number of transducers to convert. This is for Teledyne Reson sonars only. | FALSE | ||
--convert-backscatter | s | If set, converts backscatter data. | FALSE | |
InputFormat = Winfrog Options | ||||
--convert-bathymetry | b | Import single or dual frequency single beam. • SINGLEBEAM: Single beam, single frequency • SINGLEBEAM_DUAL: Single beam, dual frequency The default value is SINGLE. | FALSE | |
--navigation-device | The navigation device. One of: • 303: 303 records • 351: 351 records The default value is 303. | FALSE | ||
--motion-device | The motion device. One of: • 413: 413 records • 888: 888 records The default value is 413. | FALSE | ||
--sound-velocity | A number specifying sound velocity to use to generate slant range data. If not set, 1500 m/s is used. | FALSE | ||
InputFormat = XTF Options | ||||
--navigation-device | The navigation device name to use during bathymetry conversion. One of: • RAW: Raw navigation records • POSITION: Position data records • PING_SHIP: Ping header, ship • PING_SENSOR: Ping header, sensor • HEADER_NAV: Header navigation records The default value is PING_SHIP. | FALSE | ||
--gps-height-device | The GPS height device name to use during bathymetry conversion. • RTK: RTK packets • TIDE: Ocean tide The default value is RTK. | FALSE | ||
--motion-device | The motion device name used with Raw Navigation during bathymetry conversion. • RAW: Raw navigation datagram • ATTITUDE: Attitude datagram The default value is ATTITUDE. | FALSE | ||
--convert-bathymetry | b | The type of bathymetry to convert. One of: • NONE: (None) - No bathymetry converted • MULTIBEAM: Multibeam • MULTITRANS: Multi-transducer • SINGLEBEAM_0: Single beam records, primary = 0 • SINGLEBEAM_1: Single beam records, primary = 1 • SINGLEBEAM_2: Single beam records, primary = 2 • SINGLEBEAM_AUX1: Single beam from Aux 1 • SINGLEBEAM_AUX2: Single beam from Aux 2 • SINGLEBEAM_AUX3: Single beam from Aux 3 • SINGLEBEAM_AUX4: Single beam from Aux 4 The default value is NONE. | FALSE | |
--heading-device | The heading device name to use during bathymetry conversion. One of: • PING_SHIP: Ping header, ship (default) • PING_SENSOR: Ping header, sensor • ATTITUDE: Attitude packets • CMG_NAV: CMG from navigation • CMG_SSSNAV: CMG from SSS navigation • HEADER_GYRO: Header gyro records The default value is PING_SHIP. | FALSE | ||
--reject-quality | Rejects bathymetry with the numbered quality flag. • 0: Quality 0 • 1: Quality 1 • 2: Quality 2 • 3: Quality 3 | TRUE | ||
--convert-side-scan | s | The side scan channel to convert. One of: • NONE: (None) - No side scan converted • 12: Channels 1 and 2 • 34: Channels 3 and 4 • 14: Channels 1 and 4 • 23: Channels 2 and 3 The default value is NONE. | FALSE | |
ss-navigation-device | The side scan navigation device name. One of: • RAW: Raw navigation records • POSITION: Position data records • PING_SHIP: Ping header, ship • PING_SENSOR: Ping header, sensor • HEADER_NAV: Header navigation records The default value is HEADER_NAV. | FALSE | ||
ss-heading-device | The heading device name for side scan. One of: • PING_SHIP: Ping header, ship • PING_SENSOR: Ping header, sensor • ATTITUDE: Attitude packets • RAW: Raw navigation records • CMG_NAV: CMG from navigation • CMG_SSSNAV: CMG from SSS navigation • HEADER_GYRO: Header gyro records The default value is PING_SENSOR. | FALSE | ||
--include-offline | If set, converts side scan data flagged as offline. | FALSE | ||
--convert-layback-cable-out | Convert layback or cableout data. One of: • NONE: No layback or cableout converted • LAYBACK: Convert layback • CABLEOUT: Convert cableout The default value is NONE. | FALSE | ||
--layback-multiplier | Multiplier to compute the layback value, if cableout is converted. The default value is 1.0. | FALSE | ||
--use-aux-value | Calculate the sensor depth from this auxiliary field minus the sensor height, if cableout is converted. The valid range is 1 to 6. | FALSE | ||
--convert-vehicle-depth | Convert the vehicle depth as delta draft/subsea depth. One of: • NONE: No vehicle depth converted • SENSORDEPTH: Sensor depth field • AUX1: Auxiliary field number 1 • AUX2: Auxiliary field number 2 • AUX3: Auxiliary field number 3 • AUX4: Auxiliary field number 4 • AUX5: Auxiliary field number 5 • AUX6: Auxiliary field number 6 The default value is NONE. | FALSE | ||
--use-time-sync | If set, synchronizes time stamps for all files in the same folder. | FALSE | ||
Example
To use this command, refer to the following example.
Example | ||
Objective | To convert data from specific acquisition formats into HIPS file format for processing. | |
Description | Command Line Syntax | |
The format of the data being converted is Edgetech JSF. | --input-format EDGETECH_JSF | |
Data is filtered to the extents of the project Demo_Project. | --filter-extent-type project | |
Only data between -200m and 10 m will be converted. | --filter -200m 10m | |
Low frequency side scan data will be converted, if it exists. Otherwise high frequency side scan. | --convert-side-scan auto | |
Any JSF bathymetry in the data will be converted. | --convert-bathymetry | |
Data with quality percentage below 70% will not be converted. | --quality-percent 70 | |
The input file is named Raw_Data.jsf and located at c:\temp\inputfiles\. | c:\temp\inputfiles\Raw_Data.jsf | |
The output file is named Demo_Project and is located at D:\Data\HDCS_Data\. | D:/Data/HDCS_Data/Demo_Project/Vessel.hips?Vessel=Voyager;Day=2015-044 | |
Command Line |
| |
Outcome | Data in specified format is imported to HIPS and SIPS. | |
Extra Notes | From the above command line example:
| |