Parameter

Long

Short

Description

Can Repeat

Notes

--include-band

b

A string specifying the name of a band to include in the output.

The band must contain elevation data.

FALSE

This must be specified explicitly.

--uncertainty

t

A string specifying the name of the uncertainty band in the input.

If not set, no uncertainty values are exported.

FALSE

--compression-level

c

A number specifying the level of compression applied to the output.

The default value is 1. The valid range is 0 to 9, not compressed to highly compressed.

FALSE

--representative

A string specifying the type of value ot use per tile.

• DEEP - The deepest node in the tile is used.

• MEDIAN - The median node in the tile is used.

• SHOAL - The shoalest node in the tile is used.

The default value is MEDIAN.

FALSE

--uncertainty-type

U

A string specifying the source of uncertainty data stored in the input as per the BAG metadata profile. One of:

• STDDEV_RAW: Raw standard deviation

• STDDEV_CUBE: CUBE standard deviation

• PRODUCT_UNCERT: Product uncertainty

• STDDEV_HISTORICAL: Historical standard deviation

• TPE_AVERAGE: Average total propagated error

• UNKNOWN: Unknown

FALSE

This must be specified explicitly.

--abstract

a

A string containing the description of the output as per ISO 19115.

FALSE

This must be specified explicitly.

--status

s

A string specifying the status of the input as per ISO 19115. One of:

• COMPLETED: Complete

• ARCHIVE: Historical archive

• OBSOLETE: Obsolete

• ONGOING: Ongoing

• PLANNED: Planned

• REQUIRED: Required

• UNDER_DEV: Under development

FALSE

This must be specified explicitly.

--vertical-datum

D

A string specifying the vertical datum of the input as per ISO 19115.

FALSE

This must be specified explicitly.

--party-name

M

A string specifying the name of the responsible party as per ISO 19115.

FALSE

--party-position

S

A string specifying the position of the responsible party as per ISO 19115.

FALSE

--party-organization

o

A string specifying the organization of the responsible party as per ISO 19115.

FALSE

--party-role

R

A string specifying the role of the responsible party as per ISO 19115. One of:

• RESOURCE_PROVIDER: Resource provider

• CUSTODIAN: Custodian

• OWNER: Owner

• USER: User

• DISTRIBUTOR: Distributor

• ORIGINATOR: Originator

• POINT_OF_CONTACT: Point of contact

• PRINCIPAL_INVESTIGATOR: Principal investigator

• PROCESSOR: Processor

• PUBLISHER: Publisher

• AUTHOR: Author

FALSE

This must be specified explicitly.

--legal-constraints

L

A string specifying the legal constraints of the output as per ISO 19115. One of:

• COPYRIGHT: Copyright

• PATENT: Patent

• PATENT_PENDING: Patent pending

• TRADEMARK: Trademark

• LICENSE: License

• IP_RIGHTS: Intellectual property rights

• RESTRICTED: Restricted

• OTHER_RESTRICTIONS: Other restrictions

FALSE

This must be specified explicitly.

--other-constraints

C

A string specifying details of the legal constraints.

ISO 19115 requires that this option must be set if LegalConstraints is set to OTHER_RESTRICTIONS. It is optional otherwise.

FALSE

This option is conditional on LegalConstraints.

--security-constraints

A

A string specifying the security constraints of the output. One of:

• UNCLASSIFIED: Unclassified

• RESTRICTED: Restricted

• CONFIDENTIAL: Confidential

• SECRET: Secret

• TOP_SECRET: Top secret

FALSE

This must be specified explicitly.

--notes

N

A string specifying notes about the output as per ISO 19115.

FALSE

This must be specified explicitly.

Example

Objective

You want to export a variable resolution surface to a BAG raster surface, using the shoalest values from the input as the representative points in the BAG raster.

Description

Command Line Syntax

The Depth band is to be included in the output.

--include-band Depth

The shoalest node in the tiles is to be used.

--representative SHOAL

The raw standard deviation uncertainty type is to be used.

--uncertainty-type STDDEV_RAW

The abstract needs to state that the source of the bag was a variable resolution surface.

--abstract "variable resolution surface data"

The status of the source data is completed.

--status COMPLETED

The vertical datum of the surface is Mean Sea Level.

--vertical-datum "Mean Sea Level"

The name of the responsible party is John Doe.

--party-name "John Doe"

The position of the responsible party is Data Analyst.

--party-position "Data Analyst"

The organization of the responsible party is Teledyne CARIS.

--party-organization "Teledyne CARIS"

The role of the responsible party is author.

--party-role AUTHOR

The source data is legally restricted.

--legal-constraints RESTRICTED

The security constraint of the data is unclassified.

--security-constraints UNCLASSIFIED

An extra note is needed stating, "Quality is fundamental".

--notes "Quality is fundamental"

The input VR surface is named VR_Surface.csar and is in the BatchSample directory on the D: drive.

D:\BatchSample\VR_Surface.csar

The output file is to be called BAG_VR.bag and saved to the same directory as the source surface.

D:\BatchSample\BAG_VR.bag

Command Line

carisbatch --run ExportVRSurfaceToBAG --include-band Depth --representative SHOAL --uncertainty-type STDDEV_RAW --abstract "variable resolution surface data" --status COMPLETED --vertical-datum "Mean Sea Level" --party-name "John Doe" --party-position "Data Analyst" --party-organization "Teledyne CARIS" --party-role AUTHOR --legal-constraints RESTRICTED --security-constraints UNCLASSIFIED --notes "Quality is fundamental" D:\BatchSample\VR_Surface.csar D:\BatchSample\BAG_VR.bag

Outcome

A new BAG raster surface is created, with the tiles populated from the shoalest values in the input variable resolution surface.

Extra Notes

N/A