FileDataset

class lsst.daf.butler.FileDataset(path: str | ParseResult | ResourcePath | Path, refs: DatasetRef | list[lsst.daf.butler._dataset_ref.DatasetRef], *, formatter: str | type[lsst.daf.butler._formatter.Formatter] | Formatter | FormatterV2 | type[lsst.daf.butler._formatter.FormatterV2] | None = None)

Bases: object

A struct that represents a dataset exported to a file.

Parameters:

pathlsst.resources.ResourcePath or str

Path to the dataset (lsst.resources.ResourcePath or str).

If the dataset was exported with transfer=None (i.e. in-place), this is relative to the datastore root (only datastores that have a well-defined root in the local filesystem can be expected to support in-place exports). Otherwise this is relative to the directory passed to Datastore.export.

refslist [ DatasetRef ]

Registry information about the dataset.

formatterFormatter or str or None, optional

A Formatter class or fully-qualified name.

Attributes Summary

formatter
path
refs

Attributes Documentation

formatter: str | type[lsst.daf.butler._formatter.Formatter] | Formatter | FormatterV2 | type[lsst.daf.butler._formatter.FormatterV2] | None

path: str | ResourcePath

refs: list[lsst.daf.butler._dataset_ref.DatasetRef]