Skip to main content

Ctrl+K

Getting started with the LSST Science Pipelines
Installing the LSST Science Pipelines
Data access and pipeline middleware
lsst.afw.cameraGeom
lsst.afw.coord

GitHub

GitHub

Section Navigation

Butler v29.1.0 (2025-06-13)

Configuring a Butler
Datastore Configuration
Storage Classes, Storage Class Delegates, and Formatters
Organizing and identifying datasets
Querying datasets
Using the Butler in unit tests

Overview

DataFrame

Specifying Command-Line Options from a File
Controlling Log Output from Command-Line Tooling

Design notes for DataCoordinate
Support Entry Points

The Butler Command

addDimensionForeignKey

DataCoordinateQueryResults
DatasetRefQueryResults
DimensionRecordQueryResults
GeneralQueryResults
GeneralResultTuple
Query
QueryBase
QueryResultsBase

ExpressionFactory
ExpressionProxy
RegionProxy
ScalarExpressionProxy
TimespanProxy

ChainedDatastore

InMemoryDatastore
StoredMemoryItemInfo

FileDatastore

FileFormatter

JsonFormatter

MatplotlibFormatter

add_pandas_index_to_astropy
arrow_schema_to_pandas_index
arrow_to_astropy
arrow_to_numpy
arrow_to_numpy_dict
arrow_to_pandas
astropy_to_arrow
astropy_to_pandas
compute_row_group_size
numpy_dict_to_arrow
numpy_to_arrow
numpy_to_astropy
pandas_to_arrow
pandas_to_astropy

ArrowAstropySchema
ArrowNumpySchema
DataFrameSchema
ParquetFormatter

PickleFormatter

YamlFormatter

addDataIdValue
addDatasetType
expandUniqueId
makeTestCollection
makeTestRepo
registerMetricsExample

BadNoWriteFormatter
BadWriteFormatter
CliCmdTestBase
CliLogTestBase
DatasetTestHelper
DatastoreMock
DatastoreTestHelper
DummyRegistry
ListDelegate
MetricsDelegate
MetricsExample
MetricsExampleDataclass
MetricsExampleModel
MultiDetectorFormatter

DatasetRefURIs
DatastoreConfig
DatastoreOpaqueTable
DatastoreTransaction
DatastoreValidationError
FileTransferRecord
FileTransferSource
NullDatastore

Predicate

ArgumentError
CollectionExpressionError
CollectionSummary
ConflictingDefinitionError
DatasetTypeExpressionError
MissingSpatialOverlapError
NoDefaultCollectionError
OrphanedRecordError
RegistryConfig
RegistryConsistencyError
RegistryDefaults
SerializedCollectionSummary
UnsupportedIdGeneratorError
UserExpressionError
UserExpressionSyntaxError

ButlerAttributeExistsError
ButlerAttributeManager
ChainedCollectionRecord
CollectionManager
CollectionRecord
Database
DatabaseConflictError
DatabaseInsertMode
DatabaseMetadata
DatasetRecordStorageManager
DatastoreRegistryBridge
DatastoreRegistryBridgeManager
DimensionRecordStorageManager
FakeDatasetRef
IncompatibleVersionError
JoinedCollectionsTable
ObsCoreTableManager
OpaqueTableStorage
OpaqueTableStorageManager
ReadOnlyDatabaseError
RunRecord
SchemaAlreadyDefinedError
StaticTablesContext
VersionTuple
VersionedExtension

ChainedDatasetQueryResults
DataCoordinateQueryResults
DatasetQueryResults
DimensionRecordQueryResults
ParentDatasetQueryResults
QueryResultsBase

CategorizedWildcard
CollectionWildcard
DatasetTypeWildcard

SqliteDatabase

PostgresqlDatabase

DateTimeArrowScalar
DateTimeArrowType
RegionArrowScalar
RegionArrowType
TimespanArrowScalar
TimespanArrowType
ToArrow
UUIDArrowScalar
UUIDArrowType

make_tuple_type_adapter

BoolColumnSpec
FloatColumnSpec
HashColumnSpec
IntColumnSpec
RegionColumnSpec
StringColumnSpec
TimespanColumnSpec
UUIDColumnSpec

GUID
AstropyTimeNsecTai
Base64Bytes
Base64Region
FieldSpec
ForeignKeySpec
IndexSpec
TableSpec

from_json_generic
from_json_pydantic
to_json_generic
to_json_pydantic

ButlerLogRecord
ButlerLogRecordHandler
ButlerLogRecords
ButlerMDC
JsonLogFormatter

MappingFactory

NonemptyMapping

PersistenceContextVars

Progress
ProgressBar
ProgressHandler

get_universe_from_context

DeferredValidation

replaceRoot

BUTLER_ROOT_TAG

TimeConverter

TimespanDatabaseRepresentation

stripIfNotNone
transactional

main

ButlerCLI
LoaderCLI

associate
butler_import
certify_calibrations
create
collection_chain
config_dump
config_validate
export_calibs
ingest_files
ingest_zip
prune_datasets
query_collections
query_data_ids
query_dataset_types
query_datasets
query_dimension_records
register_dataset_type
retrieve_artifacts
remove_collections
remove_runs
remove_dataset_type
transfer_datasets

CollectionTypeCallback
query_datasets_options

addArgumentHelp
astropyTablesToStr
catch_and_exit
clickResultMsg
command_test_env
printAstropyTables
sortAstropyTable
split_commas
split_kv
textTypeStr
to_upper
unwrap
yaml_presets

ButlerCommand
LogCliRunner
MWArgument
MWArgumentDecorator
MWCommand
MWCtxObj
MWOption
MWOptionDecorator
MWPath
OptionGroup
OptionSection
option_section

CliLog
PrecisionLogFormatter

ClickProgressHandler

lsst.daf.butler
RegionArrowType

RegionArrowType#

final class lsst.daf.butler.arrow_utils.RegionArrowType#

Bases: ExtensionType

An Arrow extension type for lsst.sphgeom.Region.

previous

RegionArrowScalar

next

TimespanArrowScalar

On this page

RegionArrowType

© Copyright 2015-2022 Association of Universities for Research in Astronomy, Inc. (AURA).

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.