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

Methods Summary

from_simple(dataset, *, dataset_type_loader, ...)	Deserialize a SerializedFileDataset into a FileDataset.
to_simple()	Convert this instance to a simplified, JSON-serializable object.

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]

Methods Documentation

static from_simple(dataset: SerializedFileDataset, *, dataset_type_loader: Callable[[str], DatasetType], universe: DimensionUniverse) → FileDataset

Deserialize a SerializedFileDataset into a FileDataset.

Parameters:

datasetSerializedFileDataset

Object to deserialize.

dataset_type_loaderCallable [[ str ], DatasetType ]

Function that takes a string dataset type name as its only parameter, and returns an instance of DatasetType. Used to deserialize the DatasetRef instances contained in the serialized FileDataset.

universeDimensionUniverse

Dimension universe associated with the Butler instance that created the serialized FileDataset instance.

Returns:

file_datasetFileDataset

Deserialized equivalent of the input dataset.

to_simple() → SerializedFileDataset

Convert this instance to a simplified, JSON-serializable object.

Returns:

serializedSerializedFileDataset

Serializable representation of this FileDataset instance.