Skip to main content
Ctrl+K

lsst-images

  • User Guides
  • Python API
  • Schema versioning
  • Schemas
  • lsst-images v30.0.10 (2026-07-22)
    • Admin CLI
    • Model diagrams
    • Rubin docs
  • GitHub
  • User Guides
  • Python API
  • Schema versioning
  • Schemas
  • lsst-images v30.0.10 (2026-07-22)
  • Admin CLI
  • Model diagrams
  • Rubin docs
  • GitHub

Section Navigation

  • Core API Reference
    • get_legacy_deep_coadd_mask_planes
    • get_legacy_difference_image_mask_planes
    • get_legacy_non_cell_coadd_mask_planes
    • get_legacy_visit_image_mask_planes
    • AbsoluteSliceProxy
    • Background
    • BackgroundMap
    • BackgroundMapSerializationModel
    • Bounds
    • BoundsError
    • Box
    • BoxSliceFactory
    • CameraFrameSet
    • CameraFrameSetSerializationModel
    • ColorImage
    • DetectorFrame
    • DifferenceImage
    • DifferenceImageSerializationModel
    • DifferenceImageTemplateInfo
    • FieldAngleFrame
    • FocalPlaneFrame
    • Frame
    • FrameLookupError
    • FrameSet
    • GeneralFrame
    • GeneralizedImage
    • Image
    • ImageSerializationModel
    • Interval
    • IntervalSliceFactory
    • LocalSliceProxy
    • Mask
    • MaskPlane
    • MaskPlaneBit
    • MaskSchema
    • MaskSerializationModel
    • MaskedImage
    • MaskedImageSerializationModel
    • NoOverlapError
    • NotContainedError
    • ObservationSummaryStats
    • Polygon
    • Region
    • RegionSerializationModel
    • SkyFrame
    • SkyProjection
    • SkyProjectionAstropyView
    • SkyProjectionSerializationModel
    • TractFrame
    • Transform
    • TransformCompositionError
    • TransformSerializationModel
    • VisitImage
    • VisitImageSerializationModel
    • XY
    • YX
  • Cell-Based Coadds
    • CellApertureCorrectionMapSerializationModel
    • CellCoadd
    • CellCoaddSerializationModel
    • CellField
    • CellGrid
    • CellGridBounds
    • CellIJ
    • CellPointSpreadFunction
    • CellPointSpreadFunctionSerializationModel
    • CoaddProvenance
    • CoaddProvenanceSerializationModel
    • PatchDefinition
  • PSF Models
    • GaussianPSFSerializationModel
    • GaussianPointSpreadFunction
    • LegacyPointSpreadFunction
    • PSFExSerializationModel
    • PSFExWrapper
    • PiffSerializationModel
    • PiffWrapper
    • PointSpreadFunction
  • Calculated 2-d Fields
    • field_from_legacy
    • field_from_legacy_background
    • field_from_legacy_photo_calib
    • BaseField
    • ChebyshevField
    • ChebyshevFieldSerializationModel
    • ProductField
    • ProductFieldSerializationModel
    • SplineField
    • SplineFieldSerializationModel
    • SumField
    • SumFieldSerializationModel
  • Camera Descriptions
    • Amplifier
    • AmplifierCalibrations
    • AmplifierRawGeometry
    • Detector
    • DetectorAttributes
    • DetectorSerializationModel
    • DetectorType
    • Orientation
    • ReadoutCorner
  • Convolution Kernels
    • ConvolutionKernel
    • ImageBasisConvolutionKernel
    • ImageBasisConvolutionKernelSerializationModel
  • Aperture Corrections
    • aperture_corrections_from_legacy
    • aperture_corrections_to_legacy
    • ApertureCorrectionMapSerializationModel
  • Serialization
    • available_schema_classes
    • backend_for_name
    • backend_for_path
    • backend_for_stream
    • check_frozen_schemas
    • class_for_schema
    • dump_schema
    • frozen_schema_filename
    • frozen_schema_path
    • is_development_version
    • is_integer
    • no_header_updates
    • open_archive
    • parameterize_tree
    • public_type_for_schema
    • read_archive
    • register_schema_class
    • tree_class_for_info
    • warn_for_development_schemas
    • write_archive
    • write_frozen_schemas
    • ArchiveAccessRequiredError
    • ArchiveInfo
    • ArchiveReadError
    • ArchiveTree
    • ArrayReferenceModel
    • ArrayReferenceQuantityModel
    • Backend
    • ButlerInfo
    • DetachedArchive
    • DevelopmentSchemaWarning
    • FrozenSchemaError
    • InlineArrayModel
    • InlineArrayQuantityModel
    • InputArchive
    • InvalidComponentError
    • InvalidParameterError
    • JsonRef
    • NestedOutputArchive
    • NumberType
    • OpaqueArchiveMetadata
    • OutputArchive
    • QuantityModel
    • Reader
    • TableColumnModel
    • TableModel
    • TimeModel
    • UnsupportedTableError
    • IntegerType
    • MetadataValue
    • SCHEMA_URL_BASE
    • SignedIntegerType
    • UnsignedIntegerType
  • FITS I/O
    • add_offset_wcs
    • read_offset_wcs
    • read_yx0
    • strip_butler_cards
    • strip_legacy_exposure_cards
    • strip_wcs_cards
    • suppress_fits_card_warnings
    • write
    • ExtensionKey
    • FitsCompressionAlgorithm
    • FitsCompressionOptions
    • FitsDitherAlgorithm
    • FitsInputArchive
    • FitsOpaqueMetadata
    • FitsOutputArchive
    • FitsQuantizationOptions
    • InvalidFitsArchiveError
    • PointerModel
    • PrecompressedImage
    • DEFAULT_PAGE_SIZE
    • ExtensionHDU
    • FITS_SOURCE_REGEX
    • JSON_COLUMN
    • JSON_EXTNAME
    • READ_CACHE_MAX_BYTES
  • JSON I/O
    • write
    • JsonInputArchive
    • JsonOutputArchive
  • Starlink NDF I/O
    • archive_path_to_hdf5_path
    • archive_path_to_hdf5_path_components
    • read_starlink
    • write
    • HdsNameShrinker
    • NdfInputArchive
    • NdfOutputArchive
    • NdfPointerModel
  • Test Utilities
    • arrays_to_legacy_points
    • assert_cell_coadds_equal
    • assert_close
    • assert_equal_allow_nan
    • assert_images_equal
    • assert_masked_images_equal
    • assert_masks_equal
    • assert_psfs_equal
    • assert_sky_projections_equal
    • assert_visit_images_equal
    • check_archive_tree_class_invariants
    • check_astropy_wcs_interface
    • check_bounds_contains_broadcasting
    • check_projection
    • check_transform
    • compare_amplifier_to_legacy
    • compare_aperture_corrections_to_legacy
    • compare_cell_coadd_to_legacy
    • compare_detector_to_legacy
    • compare_field_to_legacy
    • compare_image_to_legacy
    • compare_mask_to_legacy
    • compare_masked_image_to_legacy
    • compare_observation_summary_stats_to_legacy
    • compare_photo_calib_to_legacy
    • compare_psf_to_legacy
    • compare_sky_projection_to_legacy_wcs
    • compare_visit_image_to_legacy
    • iter_concrete_archive_tree_subclasses
    • legacy_coords_to_astropy
    • legacy_points_to_xy_array
    • make_random_sky_projection
    • RoundtripFits
    • RoundtripJson
    • RoundtripNdf
    • TemporaryButler
  • Python API

Python API#

  • Core API Reference
  • Cell-Based Coadds
  • PSF Models
  • Calculated 2-d Fields
  • Camera Descriptions
  • Convolution Kernels
  • Aperture Corrections
  • Serialization
  • FITS I/O
  • JSON I/O
  • Starlink NDF I/O
  • Test Utilities

This page was last modified on 2026-07-22.

previous

For lsst.afw Users

next

Core API Reference

Edit on GitHub

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.