carta-python: a scripting wrapper for CARTA

Contents:

• Introduction
• CARTA scripting quick start
  • Installation
  • Connecting to an existing interactive session
  • Creating a new interactive session
  • Creating a new non-interactive session
  • Opening and appending images
  • Changing image properties
  • Changing session properties
  • Saving or displaying an image
  • Closing images
  • Closing the session
• carta package
  • carta.backend module
    • Backend
      • Backend.FRONTEND_URL
      • Backend.SESSION_ID
      • Backend.start()
      • Backend.stop()
  • carta.browser module
    • Browser
      • Browser.close()
      • Browser.exit()
      • Browser.new_session_from_url()
      • Browser.new_session_with_backend()
    • Chrome
  • carta.constants module
    • Auto
      • Auto.AUTO
    • BeamType
      • BeamType.OPEN
      • BeamType.SOLID
    • ColorbarPosition
      • ColorbarPosition.BOTTOM
      • ColorbarPosition.RIGHT
      • ColorbarPosition.TOP
    • Colormap
      • Colormap.ACCENT
      • Colormap.AFMHOT
      • Colormap.AUTUMN
      • Colormap.BINARY
      • Colormap.BLUES
      • Colormap.BONE
      • Colormap.BRBG
      • Colormap.BRG
      • Colormap.BUGN
      • Colormap.BUPU
      • Colormap.BWR
      • Colormap.CMRMAP
      • Colormap.COOL
      • Colormap.COOLWARM
      • Colormap.COPPER
      • Colormap.CUBEHELIX
      • Colormap.DARK2
      • Colormap.FLAG
      • Colormap.GIST_EARTH
      • Colormap.GIST_GRAY
      • Colormap.GIST_HEAT
      • Colormap.GIST_NCAR
      • Colormap.GIST_RAINBOW
      • Colormap.GIST_STERN
      • Colormap.GIST_YARG
      • Colormap.GNBU
      • Colormap.GNUPLOT
      • Colormap.GNUPLOT2
      • Colormap.GRAY
      • Colormap.GREENS
      • Colormap.GREYS
      • Colormap.HOT
      • Colormap.HSV
      • Colormap.INFERNO
      • Colormap.JET
      • Colormap.MAGMA
      • Colormap.NIPY_SPECTRAL
      • Colormap.OCEAN
      • Colormap.ORANGES
      • Colormap.ORRD
      • Colormap.PAIRED
      • Colormap.PASTEL1
      • Colormap.PASTEL2
      • Colormap.PINK
      • Colormap.PIYG
      • Colormap.PLASMA
      • Colormap.PRGN
      • Colormap.PRISM
      • Colormap.PUBU
      • Colormap.PUBUGN
      • Colormap.PUOR
      • Colormap.PURD
      • Colormap.PURPLES
      • Colormap.RAINBOW
      • Colormap.RDBU
      • Colormap.RDGY
      • Colormap.RDPU
      • Colormap.RDYLBU
      • Colormap.RDYLGN
      • Colormap.REDS
      • Colormap.SEISMIC
      • Colormap.SET1
      • Colormap.SET2
      • Colormap.SET3
      • Colormap.SPECTRAL
      • Colormap.SPRING
      • Colormap.SUMMER
      • Colormap.TAB10
      • Colormap.TAB20
      • Colormap.TAB20B
      • Colormap.TAB20C
      • Colormap.TERRAIN
      • Colormap.VIRIDIS
      • Colormap.WINTER
      • Colormap.WISTIA
      • Colormap.YLGN
      • Colormap.YLGNBU
      • Colormap.YLORBR
      • Colormap.YLORRD
    • ComplexComponent
      • ComplexComponent.AMPLITUDE
      • ComplexComponent.IMAG
      • ComplexComponent.PHASE
      • ComplexComponent.REAL
    • ContourDashMode
      • ContourDashMode.DASHED
      • ContourDashMode.NEGATIVE_ONLY
      • ContourDashMode.NONE
    • CoordinateSystem
      • CoordinateSystem.AUTO
      • CoordinateSystem.ECLIPTIC
      • CoordinateSystem.FK4
      • CoordinateSystem.FK5
      • CoordinateSystem.GALACTIC
      • CoordinateSystem.ICRS
    • FontFamily
      • FontFamily.ARIAL
      • FontFamily.COURIER_NEW
      • FontFamily.PALATINO
      • FontFamily.SANS_SERIF
      • FontFamily.TIMES
    • FontStyle
      • FontStyle.BOLD
      • FontStyle.BOLD_ITALIC
      • FontStyle.ITALIC
      • FontStyle.NORMAL
    • GridMode
      • GridMode.DYNAMIC
      • GridMode.FIXED
    • LabelType
      • LabelType.EXTERIOR
      • LabelType.INTERIOR
    • NumberFormat
      • NumberFormat.DEGREES
      • NumberFormat.DMS
      • NumberFormat.HMS
    • Overlay
      • Overlay.AXES
      • Overlay.BEAM
      • Overlay.BORDER
      • Overlay.COLORBAR
      • Overlay.GLOBAL
      • Overlay.GRID
      • Overlay.LABELS
      • Overlay.NUMBERS
      • Overlay.TICKS
      • Overlay.TITLE
    • PaletteColor
      • PaletteColor.BLACK
      • PaletteColor.BLUE
      • PaletteColor.COBALT
      • PaletteColor.DARK_GRAY
      • PaletteColor.FOREST
      • PaletteColor.GOLD
      • PaletteColor.GRAY
      • PaletteColor.GREEN
      • PaletteColor.INDIGO
      • PaletteColor.LIGHT_GRAY
      • PaletteColor.LIME
      • PaletteColor.ORANGE
      • PaletteColor.RED
      • PaletteColor.ROSE
      • PaletteColor.SEPIA
      • PaletteColor.TURQUOISE
      • PaletteColor.VERMILION
      • PaletteColor.VIOLET
      • PaletteColor.WHITE
    • PanelMode
      • PanelMode.MULTIPLE
      • PanelMode.SINGLE
    • Polarization
      • Polarization.I
      • Polarization.LL
      • Polarization.LR
      • Polarization.PANGLE
      • Polarization.PFLINEAR
      • Polarization.PFTOTAL
      • Polarization.PLINEAR
      • Polarization.PTOTAL
      • Polarization.Q
      • Polarization.RL
      • Polarization.RR
      • Polarization.U
      • Polarization.V
      • Polarization.XX
      • Polarization.XY
      • Polarization.YX
      • Polarization.YY
    • Scaling
      • Scaling.GAMMA
      • Scaling.LINEAR
      • Scaling.LOG
      • Scaling.POWER
      • Scaling.SQRT
      • Scaling.SQUARE
    • SmoothingMode
      • SmoothingMode.BLOCK_AVERAGE
      • SmoothingMode.GAUSSIAN_BLUR
      • SmoothingMode.NO_SMOOTHING
    • SpatialAxis
      • SpatialAxis.X
      • SpatialAxis.Y
    • SpectralSystem
      • SpectralSystem.BARY
      • SpectralSystem.LSRD
      • SpectralSystem.LSRK
      • SpectralSystem.TOPO
    • SpectralType
      • SpectralType.AWAV
      • SpectralType.FREQ
      • SpectralType.VOPT
      • SpectralType.VRAD
      • SpectralType.WAVE
    • SpectralUnit
      • SpectralUnit.ANGSTROM
      • SpectralUnit.GHZ
      • SpectralUnit.HZ
      • SpectralUnit.KHZ
      • SpectralUnit.KMS
      • SpectralUnit.M
      • SpectralUnit.MHZ
      • SpectralUnit.MM
      • SpectralUnit.MS
      • SpectralUnit.NM
      • SpectralUnit.UM
    • VectorOverlaySource
      • VectorOverlaySource.COMPUTED
      • VectorOverlaySource.CURRENT
      • VectorOverlaySource.NONE
  • carta.contours module
    • Contours
      • Contours.apply()
      • Contours.clear()
      • Contours.configure()
      • Contours.hide()
      • Contours.plot()
      • Contours.set_bias_and_contrast()
      • Contours.set_color()
      • Contours.set_colormap()
      • Contours.set_dash_mode()
      • Contours.set_thickness()
      • Contours.set_visible()
      • Contours.show()
  • carta.image module
    • Image
      • Image.close()
      • Image.depth
      • Image.directory
      • Image.file_name
      • Image.from_list()
      • Image.header
      • Image.height
      • Image.is_pv
      • Image.make_active()
      • Image.make_raster_scaling_reference()
      • Image.make_spatial_reference()
      • Image.make_spectral_reference()
      • Image.ndim
      • Image.new()
      • Image.num_polarizations
      • Image.polarizations
      • Image.set_center()
      • Image.set_channel()
      • Image.set_cube_matching()
      • Image.set_polarization()
      • Image.set_raster_scaling_matching()
      • Image.set_spatial_matching()
      • Image.set_spectral_coordinate()
      • Image.set_spectral_matching()
      • Image.set_spectral_system()
      • Image.set_zoom_level()
      • Image.shape
      • Image.spectral_coordinate_types_supported
      • Image.spectral_systems_supported
      • Image.valid_wcs
      • Image.width
      • Image.zoom_to_size()
  • carta.metadata module
    • parse_header()
  • carta.preferences module
    • Preferences
      • Preferences.get()
      • Preferences.set()
  • carta.protocol module
    • AuthType
      • AuthType.BACKEND
      • AuthType.CONTROLLER
      • AuthType.NONE
    • Protocol
      • Protocol.ACTION_PATH
      • Protocol.REFRESH_TOKEN_PATH
      • Protocol.SCRIPTING_TOKEN_PATH
      • Protocol.backend_auth
      • Protocol.check_refresh_token()
      • Protocol.controller_auth
      • Protocol.cookie()
      • Protocol.domain
      • Protocol.no_auth
      • Protocol.request_refresh_token()
      • Protocol.request_scripting_action()
      • Protocol.request_scripting_token()
  • carta.raster module
    • Raster
      • Raster.hide()
      • Raster.set_bias_and_contrast()
      • Raster.set_clip()
      • Raster.set_colormap()
      • Raster.set_scaling()
      • Raster.set_visible()
      • Raster.show()
    • SessionRaster
      • SessionRaster.hide_pixel_grid()
      • SessionRaster.pixel_grid_color
      • SessionRaster.pixel_grid_visible
      • SessionRaster.set_pixel_grid()
      • SessionRaster.set_pixel_grid_color()
      • SessionRaster.set_pixel_grid_visible()
      • SessionRaster.show_pixel_grid()
  • carta.session module
    • Session
      • Session.active_frame()
      • Session.call_action()
      • Session.cd()
      • Session.clear_raster_scaling_reference()
      • Session.clear_spatial_reference()
      • Session.clear_spectral_reference()
      • Session.close()
      • Session.create()
      • Session.get_value()
      • Session.image_by_id()
      • Session.image_list()
      • Session.interact()
      • Session.ls()
      • Session.next_page()
      • Session.open_LEL_image()
      • Session.open_complex_image()
      • Session.open_hypercube()
      • Session.open_image()
      • Session.open_images()
      • Session.previous_page()
      • Session.pwd()
      • Session.rendered_view_data()
      • Session.rendered_view_url()
      • Session.resolve_file_path()
      • Session.save_rendered_view()
      • Session.set_cursor()
      • Session.set_viewer_grid()
      • Session.set_viewer_mode()
      • Session.start_and_create()
      • Session.start_and_interact()
  • carta.token module
    • BackendToken
      • BackendToken.split_token_from_url()
    • ControllerToken
      • ControllerToken.as_cookie()
      • ControllerToken.expires
      • ControllerToken.from_file()
      • ControllerToken.refresh
      • ControllerToken.save()
      • ControllerToken.scripting
      • ControllerToken.username
      • ControllerToken.valid()
    • Token
  • carta.units module
    • AngularSize
      • AngularSize.FORMATS
      • AngularSize.NAME
      • AngularSize.SYMBOL_UNIT_REGEX
      • AngularSize.WORD_UNIT_REGEX
      • AngularSize.from_string()
      • AngularSize.valid()
    • ArcminSize
      • ArcminSize.FACTOR
      • ArcminSize.INPUT_UNITS
      • ArcminSize.NAME
      • ArcminSize.OUTPUT_UNIT
      • ArcminSize.SYMBOL_UNIT_REGEX
      • ArcminSize.WORD_UNIT_REGEX
    • ArcsecSize
      • ArcsecSize.FACTOR
      • ArcsecSize.INPUT_UNITS
      • ArcsecSize.NAME
      • ArcsecSize.OUTPUT_UNIT
      • ArcsecSize.SYMBOL_UNIT_REGEX
      • ArcsecSize.WORD_UNIT_REGEX
    • DMSCoordinate
      • DMSCoordinate.FMT
      • DMSCoordinate.REGEX
      • DMSCoordinate.from_string()
    • DegreesCoordinate
      • DegreesCoordinate.DEGREE_UNITS
      • DegreesCoordinate.FMT
      • DegreesCoordinate.REGEX
      • DegreesCoordinate.from_string()
    • DegreesSize
      • DegreesSize.FACTOR
      • DegreesSize.INPUT_UNITS
      • DegreesSize.NAME
      • DegreesSize.OUTPUT_UNIT
      • DegreesSize.SYMBOL_UNIT_REGEX
      • DegreesSize.WORD_UNIT_REGEX
    • HMSCoordinate
      • HMSCoordinate.FMT
      • HMSCoordinate.REGEX
      • HMSCoordinate.from_string()
    • MicroarcsecSize
      • MicroarcsecSize.FACTOR
      • MicroarcsecSize.INPUT_UNITS
      • MicroarcsecSize.NAME
      • MicroarcsecSize.OUTPUT_UNIT
      • MicroarcsecSize.SYMBOL_UNIT_REGEX
      • MicroarcsecSize.WORD_UNIT_REGEX
    • MilliarcsecSize
      • MilliarcsecSize.FACTOR
      • MilliarcsecSize.INPUT_UNITS
      • MilliarcsecSize.NAME
      • MilliarcsecSize.OUTPUT_UNIT
      • MilliarcsecSize.SYMBOL_UNIT_REGEX
      • MilliarcsecSize.WORD_UNIT_REGEX
    • SexagesimalCoordinate
      • SexagesimalCoordinate.as_tuple()
      • SexagesimalCoordinate.from_string()
    • WorldCoordinate
      • WorldCoordinate.FMT
      • WorldCoordinate.FORMATS
      • WorldCoordinate.from_string()
      • WorldCoordinate.valid()
      • WorldCoordinate.with_format()
  • carta.util module
    • BasePathMixin
      • BasePathMixin.call_action()
      • BasePathMixin.get_value()
      • BasePathMixin.macro()
    • CartaActionFailed
    • CartaBadID
    • CartaBadRequest
    • CartaBadResponse
    • CartaBadSession
    • CartaBadToken
    • CartaBadUrl
    • CartaEncoder
      • CartaEncoder.default()
    • CartaRequestFailed
    • CartaScriptingException
    • CartaValidationFailed
    • Macro
      • Macro.UNDEFINED
      • Macro.json()
    • cached()
    • camel()
    • snake()
    • split_action_path()
  • carta.validation module
    • Any
      • Any.description
      • Any.validate()
    • Attr
    • Attrs
    • Boolean
      • Boolean.description
      • Boolean.validate()
    • Color
    • Constant
      • Constant.description
    • Coordinate
      • Coordinate.WorldCoordinate
    • Evaluate
      • Evaluate.description
      • Evaluate.validate()
    • InstanceOf
      • InstanceOf.description
      • InstanceOf.validate()
    • IterableOf
      • IterableOf.description
      • IterableOf.validate()
    • MapOf
      • MapOf.description
      • MapOf.validate()
    • NoneOr
    • NoneParameter
      • NoneParameter.description
      • NoneParameter.validate()
    • Number
      • Number.EXCLUDE
      • Number.ID
      • Number.INCLUDE
      • Number.INCLUDE_MAX
      • Number.INCLUDE_MIN
      • Number.PERCENTAGE
      • Number.POSITIVE
      • Number.description
      • Number.validate()
    • OneOf
      • OneOf.description
      • OneOf.validate()
    • Parameter
      • Parameter.description
      • Parameter.validate()
    • Size
      • Size.AngularSize
    • String
      • String.description
      • String.validate()
    • TupleColor
      • TupleColor.description
      • TupleColor.validate()
    • Union
      • Union.description
      • Union.validate()
    • all_optional()
    • validate()
    • vargs()
  • carta.vector_overlay module
    • VectorOverlay
      • VectorOverlay.apply()
      • VectorOverlay.clear()
      • VectorOverlay.configure()
      • VectorOverlay.hide()
      • VectorOverlay.plot()
      • VectorOverlay.set_bias_and_contrast()
      • VectorOverlay.set_color()
      • VectorOverlay.set_colormap()
      • VectorOverlay.set_intensity_range()
      • VectorOverlay.set_length_range()
      • VectorOverlay.set_rotation_offset()
      • VectorOverlay.set_thickness()
      • VectorOverlay.set_visible()
      • VectorOverlay.show()
  • carta.wcs_overlay module
    • Axes
      • Axes.COMPONENT
    • Beam
      • Beam.COMPONENT
      • Beam.color()
      • Beam.hide()
      • Beam.position()
      • Beam.set_color()
      • Beam.set_position()
      • Beam.set_type()
      • Beam.set_visible()
      • Beam.set_width()
      • Beam.show()
      • Beam.type()
      • Beam.visible()
      • Beam.width()
    • Border
      • Border.COMPONENT
    • Colorbar
      • Colorbar.COMPONENT
      • Colorbar.interactive
      • Colorbar.offset
      • Colorbar.position
      • Colorbar.set_interactive()
      • Colorbar.set_offset()
      • Colorbar.set_position()
    • ColorbarBorder
      • ColorbarBorder.PREFIX
    • ColorbarComponent
      • ColorbarComponent.call_action()
      • ColorbarComponent.get_value()
    • ColorbarGradient
      • ColorbarGradient.PREFIX
    • ColorbarLabel
      • ColorbarLabel.PREFIX
      • ColorbarLabel.set_text()
      • ColorbarLabel.text()
    • ColorbarNumbers
      • ColorbarNumbers.PREFIX
    • ColorbarTicks
      • ColorbarTicks.PREFIX
      • ColorbarTicks.density
      • ColorbarTicks.length
      • ColorbarTicks.set_density()
      • ColorbarTicks.set_length()
    • Global
      • Global.COMPONENT
      • Global.coordinate_system
      • Global.labelling
      • Global.set_coordinate_system()
      • Global.set_labelling()
      • Global.set_tolerance()
      • Global.tolerance
    • Grid
      • Grid.COMPONENT
      • Grid.custom_gap
      • Grid.gap
      • Grid.set_custom_gap()
      • Grid.set_gap()
    • HasColor
      • HasColor.color
      • HasColor.set_color()
    • HasCustomColor
      • HasCustomColor.custom_color
      • HasCustomColor.set_color()
      • HasCustomColor.set_custom_color()
    • HasCustomPrecision
      • HasCustomPrecision.custom_precision
      • HasCustomPrecision.precision
      • HasCustomPrecision.set_custom_precision()
      • HasCustomPrecision.set_precision()
    • HasCustomText
      • HasCustomText.custom_text
      • HasCustomText.set_custom_text()
    • HasFont
      • HasFont.font
      • HasFont.font_size
      • HasFont.set_font()
      • HasFont.set_font_size()
    • HasRotation
      • HasRotation.rotation
      • HasRotation.set_rotation()
    • HasVisibility
      • HasVisibility.hide()
      • HasVisibility.set_visible()
      • HasVisibility.show()
      • HasVisibility.visible
    • HasWidth
      • HasWidth.set_width()
      • HasWidth.width
    • ImageWCSConnector
      • ImageWCSConnector.ANY_IDS
    • ImageWCSOverlay
      • ImageWCSOverlay.ImageBeam
      • ImageWCSOverlay.ImageColorbar
      • ImageWCSOverlay.ImageTitle
    • Labels
      • Labels.COMPONENT
      • Labels.set_text()
      • Labels.text
    • Numbers
      • Numbers.COMPONENT
      • Numbers.custom_format
      • Numbers.format
      • Numbers.set_custom_format()
      • Numbers.set_format()
    • OverlayComponent
      • OverlayComponent.CLASS
    • SessionWCSOverlay
      • SessionWCSOverlay.get()
      • SessionWCSOverlay.palette_to_rgb()
      • SessionWCSOverlay.set_view_area()
    • Ticks
      • Ticks.COMPONENT
      • Ticks.custom_density
      • Ticks.density
      • Ticks.draw_on_all_edges
      • Ticks.major_length
      • Ticks.minor_length
      • Ticks.set_custom_density()
      • Ticks.set_density()
      • Ticks.set_draw_on_all_edges()
      • Ticks.set_major_length()
      • Ticks.set_minor_length()
    • Title
      • Title.COMPONENT
      • Title.set_text()
      • Title.text()