Inheritance diagram for lsst.daf.persistence.butler.RepoData:
Public Member Functions | |
| def | __init__ (self, args, role) |
| def | repoArgs (self) |
| def | repoData (self) |
| def | __repr__ (self) |
| def | setCfg (self, cfg, origin, root, isV1Repository) |
| def | cfgOrigin (self) |
| def | isNewRepository (self) |
| def | role (self) |
| def | role (self, val) |
| def | getParentRepoDatas (self, context=None) |
| def | addParentRepoData (self, parentRepoData) |
| def | addTags (self, tags) |
Public Attributes | |
| cfg | |
| cfgRoot | |
| repo | |
| parentRepoDatas | |
| isV1Repository | |
| tags | |
| role | |
| parentRegistry | |
| cfgOrigin | |
Detailed Description
Container object for repository data used by Butler
Parameters
----------
args : RepositoryArgs
The arguments that are used to find or create the RepositoryCfg.
role : string
"input", "output", or "parent", indicating why Butler loaded this repository.
* input: the Repository was passed as a Butler input.
* output: the Repository was passed as a Butler output.
* parent: the Repository was specified in the RepositoryCfg parents list of a readable repository.
Attributes
----------
cfg: RepositoryCfg
The configuration for the Repository.
_cfgOrigin : string
"new", "existing", or "nested". Indicates the origin of the repository and its RepositoryCfg:
* new: it was created by this instance of Butler, and this instance of Butler will generate the
RepositoryCfg file.
* existing: it was found (via the root or cfgRoot argument)
* nested: the full RepositoryCfg was nested in another RepositoryCfg's parents list (this can happen
if parameters of an input specified by RepositoryArgs or dict does not entirely match an existing
RepositoryCfg).
cfgRoot : string
Path or URI to the location of the RepositoryCfg file.
repo : lsst.daf.persistence.Repository
The Repository class instance.
parentRepoDatas : list of RepoData
The parents of this Repository, as indicated this Repository's RepositoryCfg. If this is a new
Repository then these are the inputs to this Butler (and will be saved in the RepositoryCfg). These
RepoData objects are not owned by this RepoData, these are references to peer RepoData objects in the
Butler's RepoDataContainer.
isV1Repository : bool
True if this is an Old Butler repository. In this case the repository does not have a RepositoryCfg
file. It may have a _mapper file and may have a _parent symlink. It will never be treated as a "new"
repository, i.e. even though there is not a RepositoryCfg file, one will not be generated.
If False, this is a New Butler repository and is specified by RepositoryCfg file.
tags : set
These are values that may be used to restrict the search of input repositories. Details are available
in the RepositoryArgs and DataId classes.
role : string
"input", "output", or "parent", indicating why Butler loaded this repository.
* input: the Repository was passed as a Butler input.
* output: the Repository was passed as a Butler output.
* parent: the Repository was specified in the RepositoryCfg parents list of a readable repository.
_repoArgs : RepositoryArgs
Contains the arguments that were used to specify this Repository.
Constructor & Destructor Documentation
◆ __init__()
| def lsst.daf.persistence.butler.RepoData.__init__ | ( | self, | |
| args, | |||
| role | |||
| ) |
Definition at line 124 of file butler.py.
def __init__(self, minimum, dataRange, Q)
Definition: rgbContinued.py:476
Member Function Documentation
◆ __repr__()
| def lsst.daf.persistence.butler.RepoData.__repr__ | ( | self | ) |
Definition at line 144 of file butler.py.
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:168
◆ addParentRepoData()
| def lsst.daf.persistence.butler.RepoData.addParentRepoData | ( | self, | |
| parentRepoData | |||
| ) |
Definition at line 236 of file butler.py.
std::shared_ptr< FrameSet > append(FrameSet const &first, FrameSet const &second)
Construct a FrameSet that performs two transformations in series.
Definition: functional.cc:33
◆ addTags()
| def lsst.daf.persistence.butler.RepoData.addTags | ( | self, | |
| tags | |||
| ) |
◆ cfgOrigin()
| def lsst.daf.persistence.butler.RepoData.cfgOrigin | ( | self | ) |
◆ getParentRepoDatas()
| def lsst.daf.persistence.butler.RepoData.getParentRepoDatas | ( | self, | |
context = None |
|||
| ) |
Get the parents & grandparents etc of this repo data, in depth-first search order.
Duplicate entries will be removed in cases where the same parent appears more than once in the parent
graph.
Parameters
----------
context : set, optional
Users should typically omit context and accept the default argument. Context is used to keep a set
of known RepoDatas when calling this function recursively, for duplicate elimination.
Returns
-------
list of RepoData
A list of the parents & grandparents etc of a given repo data, in depth-first search order.
◆ isNewRepository()
| def lsst.daf.persistence.butler.RepoData.isNewRepository | ( | self | ) |
◆ repoArgs()
| def lsst.daf.persistence.butler.RepoData.repoArgs | ( | self | ) |
◆ repoData()
| def lsst.daf.persistence.butler.RepoData.repoData | ( | self | ) |
◆ role() [1/2]
| def lsst.daf.persistence.butler.RepoData.role | ( | self | ) |
◆ role() [2/2]
| def lsst.daf.persistence.butler.RepoData.role | ( | self, | |
| val | |||
| ) |
Definition at line 203 of file butler.py.
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:168
◆ setCfg()
| def lsst.daf.persistence.butler.RepoData.setCfg | ( | self, | |
| cfg, | |||
| origin, | |||
| root, | |||
| isV1Repository | |||
| ) |
Set information about the cfg into the RepoData
Parameters
----------
cfg : RepositoryCfg
The RepositoryCfg for the repo.
origin : string
'new', 'existing', or 'nested'
root : string
URI or absolute path to the location of the RepositoryCfg.yaml file.
Returns
-------
None
Definition at line 167 of file butler.py.
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:168
Member Data Documentation
◆ cfg
◆ cfgOrigin
◆ cfgRoot
◆ isV1Repository
◆ parentRegistry
◆ parentRepoDatas
◆ repo
◆ role
◆ tags
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/Linux64/daf_persistence/17.0.1-1-gfc6fb1f+20/python/lsst/daf/persistence/butler.py
