Teledyne Logo | Teledyne CARISSoftware

Account
  • Home
  • Products

    • Hydrographic Survey

      • CARIS Collect
      • CARIS Onboard
      • HIPS and SIPS
      • Bathy DataBASE
      • Sonar Noise Classifier
      • ADMIRALTY GAM

      Free Data Viewer

      • CARIS Easy View

      Chart Production

      • BASE Editor
      • HPD
      • S-57 Composer
      • S-100 Composer
      • Paper Chart Composer
      • CARIS AutoChart
      • LOTS Limits and Boundaries

      Educational

      • Academic Software
      • Online Learning

      Spatial Data Analysis

      • BASE Editor
      • Engineering Analysis Module

      CARIS Cloud

      • CARIS Cloud Overview
      • CARIS Bathy Data Service
      • CARIS S-57 ENC Service
      • CARIS Chart Data Service

      CARIS Mira AI

      • CARIS Mira AI Overview
      • Sonar Noise Classifier
      • ADMIRALTY GAM
  • Support
    • Product Support & Downloads
    • CARIS Python API
    • Academic Partnering Program
    • Training
  • News
    • Newsroom
    • Media Kit
    • Events & Tradeshows
    • Recorded Webinars
    • Subscribe to Mailing List
    • Calendar Images
  • Company
    • Company Profile
    • Corporate Background
    • Careers
    • Quality & Certifications
    • Terms and Conditions
    • Privacy Policy
    • Cookies Policy
    • Website Terms of Use
    • Teledyne Technologies
  • Contact
    • Contact Sales
    • Office Locations
    • Find a Distributor
    • Request for Credit Account
  • Terms and Conditions

Python API 5.6

Documentation

Teledyne CARIS provides bindings for scripting with the Python programming language. These bindings provide a simple, consistent model to automate and integrate data and operations with external functions and software.

Navigation

  • index
  • modules |
  • next |
  • previous |
  • CARIS API 5.6.10 documentation »
  • Coverage Module »
  • Variable Resolution Surface API

Variable Resolution Surface API¶

  • Tutorial
    • Introduction
      • Checking the type of a dataset
      • Opening a VRS
        • Opening from BDB Server
      • Listing Bands
      • Reading from a VRS
      • Querying a VRS
      • Copying a VRS
      • Updating VRS data
      • Updating bounding polygon
  • Classes
    • VRS
      • VRS
        • VRS.add_band()
        • VRS.begin_transaction()
        • VRS.commit_transaction()
        • VRS.create_copy()
        • VRS.find_closest_point()
        • VRS.query()
        • VRS.query_box()
        • VRS.query_tile()
        • VRS.remove_band()
        • VRS.tiles()
        • VRS.band_info
        • VRS.bounding_polygon
        • VRS.extents
        • VRS.uri
    • VRSTile
      • VRSTile
    • VRSGridder
      • VRSGridder
    • BandInfo
      • Category
      • ColorFormat
      • DataType
      • Direction
      • BandInfo
        • BandInfo.__init__()
        • BandInfo.category
        • BandInfo.color_format
        • BandInfo.direction
        • BandInfo.follow_band_name
        • BandInfo.is_hidden
        • BandInfo.level_policy
        • BandInfo.maximum
        • BandInfo.minimum
        • BandInfo.name
        • BandInfo.ndv
        • BandInfo.numpy_dtype
        • BandInfo.string_table
        • BandInfo.true_pos_band_name
        • BandInfo.tuple_length
        • BandInfo.type
        • BandInfo.units
    • DatasetType
      • DatasetType
    • BinBias
      • BinBias
    • Options
      • OpenType
      • Options
        • Options.__init__()
        • Options.band_info
        • Options.bounding_polygon
        • Options.dims
        • Options.elevation_band_name
        • Options.extents
        • Options.iso19139_xml
        • Options.iterator
        • Options.log_callback_func
        • Options.log_callback_user_data
        • Options.open_type
        • Options.pixel_type
        • Options.position_band_name
        • Options.raster2geo_matrix
        • Options.raster_read_callback_func
        • Options.wkt_cosys
    • BlockIterator
      • BlockIterator
        • BlockIterator.__next__()

CARIS API

Navigation

  • Configuration
  • Changes List
  • Coverage Module
    • Cloud API
    • Raster API
    • Variable Resolution Surface API
    • Functions
    • Indices and tables
  • CARIS Module
  • BDB Server Module
  • BDB Server 6 Module
  • HPD
  • Application User Interface Module

Related Topics

  • Documentation overview
    • Coverage Module
      • Previous: PixelType
      • Next: Tutorial

Quick search

Back to top

Teledyne CARIS is the leading developer of marine mapping software, headquartered in Fredericton, NB, Canada.

Company
  • Company Profile
  • Careers
  • News
  • Distributors
  • Contact Sales
  • Teledyne Technologies
Downloads
  • CARIS Easy View
  • Media Kit
Support
  • Software Support & Downloads
  • Training
  • Academic Partnering
Connect With Us

A Teledyne Technologies company. © 2025 Teledyne CARIS.

Privacy Policy | Cookies Policy | Website Terms of Use

HIPS and SIPS product
CARIS HIPS & SIPS Professional

HIPS and SIPS
BASE Editor
Engineering Analysis Module
S-57 Composer
Paper Chart Composer