Description
The ExportCoverageMetadata process writes metadata to an XML file with a specific profile.
Inputs
A point cloud or raster dataset in CSAR or BAG format. Metadata values supplied as process options are used in the export instead of existing metadata.
Outputs
An XML file containing the exported metadata.
Command Line Syntax
carisbatch --run ExportCoverageMetadata --metadata-profile <value> [options] <input> <output>
User Interface Command
Export Coverage Metadata
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
Common Options | ||||
--profile | p | A string specifying the profile of the output metadata. One of: • BAG: Metadata in the BAG profile. • ISO19115: Metadata in the ISO19115 profile. | FALSE | This must be specified explicitly. |
ExportMetadataTo = BAG | ||||
--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
To use this command refer to the following example.
Example | ||
Objective | You want to export BAG metadata where BAG is the input, BAG metadata is the output, and the metadata in the original BAG file is maintained. | |
Description | Command Line Syntax | |
The profile to save to is BAG. | --metadata-profile BAG | |
The uncertainty data type is unknown. | --uncertainty-type UNKNOWN | |
The status of the source data is ongoing. | --status ONGOING | |
The vertical datum of the surface is Mean Sea Level. | --vertical-datum "Mean Sea Level" | |
The name of the responsible party is John Smith. | --party-name "John Smith" | |
The position of the responsible party is Project Manager. | --party-position "Project Manager" | |
The organization of the responsible party is CARIS. | --party-organization CARIS | |
The role of the responsible party is processor. | --party-role PROCESSOR | |
The source data is legally trademarked. | --legal-constraints TRADEMARK | |
The description of the data is data. | --abstract data | |
Additional notes are included. | --notes "Additional notes" | |
The security constraint of the data is unclassified. | --security-constraints UNCLASSIFIED | |
Metadata is to be exported for the surface, BAG_2Points.bag, located in the D:\BatchSample directory. | D:\BatchSample\BAG_2Points.bag | |
The resulting metadata will be saved as, Source2PointsBAG.xml, in the D:\BatchSample directory. | D:\BatchSample\Source2PointsBAG.xml | |
Command Line |
| |
Outcome | The metadata of the source surface is exported to an XML file. | |
Notes | N/A | |