LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | List of all members
lsst.daf.persistence.butlerSubset.ButlerDataRef Class Reference
Inheritance diagram for lsst.daf.persistence.butlerSubset.ButlerDataRef:

Public Member Functions

def __init__
 
def get
 
def put
 
def subLevels
 
def subItems
 
def datasetExists
 
def getButler
 

Public Attributes

 butlerSubset
 
 dataId
 

Detailed Description

A ButlerDataRef is a reference to a potential dataset or group of datasets
that is portable between compatible dataset types.  As such, it can be
used to create or retrieve datasets.

ButlerDataRefs are (conceptually) created as elements of a ButlerSubset by
Butler.subset().  They are initially specific to the dataset type passed
to that call, but they may be used with any other compatible dataset type.
Dataset type compatibility must be determined externally (or by trial and
error).

ButlerDataRefs may be created at any level of a data identifier hierarchy.
If the level is not one at which datasets exist, a ButlerSubset
with lower-level ButlerDataRefs can be created using
ButlerDataRef.subItems().

Public methods:

get(self, datasetType=None, **rest)

put(self, obj, datasetType=None, **rest)

subItems(self, level=None)

datasetExists(self, datasetType=None, **rest)

getButler(self)

Definition at line 132 of file butlerSubset.py.

Constructor & Destructor Documentation

def lsst.daf.persistence.butlerSubset.ButlerDataRef.__init__ (   self,
  butlerSubset,
  dataId 
) 
For internal use only.  ButlerDataRefs should only be created by
ButlerSubset and ButlerSubsetIterator.

Definition at line 162 of file butlerSubset.py.

162 
163  def __init__(self, butlerSubset, dataId):
164  """
165  For internal use only. ButlerDataRefs should only be created by
166  ButlerSubset and ButlerSubsetIterator.
167  """
168 
169  self.butlerSubset = butlerSubset
170  self.dataId = dataId

Member Function Documentation

def lsst.daf.persistence.butlerSubset.ButlerDataRef.datasetExists (   self,
  datasetType = None,
  rest 
) 
Determine if a dataset exists of the given type (or the type used when
creating the ButlerSubset, if None) as specified by the ButlerDataRef.

@param datasetType (str) dataset type to check.
@param **rest            keywords arguments with data identifiers
@returns bool

Definition at line 239 of file butlerSubset.py.

239 
240  def datasetExists(self, datasetType=None, **rest):
241  """
242  Determine if a dataset exists of the given type (or the type used when
243  creating the ButlerSubset, if None) as specified by the ButlerDataRef.
244 
245  @param datasetType (str) dataset type to check.
246  @param **rest keywords arguments with data identifiers
247  @returns bool
248  """
249  if datasetType is None:
250  datasetType = self.butlerSubset.datasetType
251  return self.butlerSubset.butler.datasetExists(
252  datasetType, self.dataId, **rest)
def lsst.daf.persistence.butlerSubset.ButlerDataRef.get (   self,
  datasetType = None,
  rest 
) 
Retrieve a dataset of the given type (or the type used when creating
the ButlerSubset, if None) as specified by the ButlerDataRef.

@param datasetType (str)  dataset type to retrieve.
@param **rest             keyword arguments with data identifiers
@returns object corresponding to the given dataset type.

Definition at line 171 of file butlerSubset.py.

171 
172  def get(self, datasetType=None, **rest):
173  """
174  Retrieve a dataset of the given type (or the type used when creating
175  the ButlerSubset, if None) as specified by the ButlerDataRef.
176 
177  @param datasetType (str) dataset type to retrieve.
178  @param **rest keyword arguments with data identifiers
179  @returns object corresponding to the given dataset type.
180  """
181 
182  if datasetType is None:
183  datasetType = self.butlerSubset.datasetType
184  return self.butlerSubset.butler.get(datasetType, self.dataId, **rest)
def lsst.daf.persistence.butlerSubset.ButlerDataRef.getButler (   self) 
Return the butler associated with this data reference.

Definition at line 253 of file butlerSubset.py.

253 
254  def getButler(self):
255  """
256  Return the butler associated with this data reference.
257  """
258  return self.butlerSubset.butler
def lsst.daf.persistence.butlerSubset.ButlerDataRef.put (   self,
  obj,
  datasetType = None,
  doBackup = False,
  rest 
) 
Persist a dataset of the given type (or the type used when creating
the ButlerSubset, if None) as specified by the ButlerDataRef.

@param obj                object to persist.
@param datasetType (str)  dataset type to persist.
@param doBackup           if True, rename existing instead of overwriting
@param **rest             keyword arguments with data identifiers

WARNING: Setting doBackup=True is not safe for parallel processing, as it
may be subject to race conditions.

Definition at line 185 of file butlerSubset.py.

185 
186  def put(self, obj, datasetType=None, doBackup=False, **rest):
187  """
188  Persist a dataset of the given type (or the type used when creating
189  the ButlerSubset, if None) as specified by the ButlerDataRef.
190 
191  @param obj object to persist.
192  @param datasetType (str) dataset type to persist.
193  @param doBackup if True, rename existing instead of overwriting
194  @param **rest keyword arguments with data identifiers
195 
196  WARNING: Setting doBackup=True is not safe for parallel processing, as it
197  may be subject to race conditions.
198  """
199 
200  if datasetType is None:
201  datasetType = self.butlerSubset.datasetType
202  self.butlerSubset.butler.put(obj, datasetType, self.dataId, doBackup=doBackup, **rest)
def lsst.daf.persistence.butlerSubset.ButlerDataRef.subItems (   self,
  level = None 
) 
Generate a ButlerSubset at a lower level of the hierarchy than this
ButlerDataRef, using it as a partial data id.  If level is None, a
default lower level for the original ButlerSubset level and dataset
type is used.

@param level (str)   the hierarchy level to descend to.
@returns (ButlerSubset) resulting from the lower-level query or () if
                there is no lower level.

Definition at line 219 of file butlerSubset.py.

219 
220  def subItems(self, level=None):
221  """
222  Generate a ButlerSubset at a lower level of the hierarchy than this
223  ButlerDataRef, using it as a partial data id. If level is None, a
224  default lower level for the original ButlerSubset level and dataset
225  type is used.
226 
227  @param level (str) the hierarchy level to descend to.
228  @returns (ButlerSubset) resulting from the lower-level query or () if
229  there is no lower level.
230  """
231 
232  if level is None:
233  level = self.butlerSubset.butler.mapper.getDefaultSubLevel(
234  self.butlerSubset.level)
235  if level is None:
236  return ()
237  return self.butlerSubset.butler.subset(self.butlerSubset.datasetType,
238  level, self.dataId)
def lsst.daf.persistence.butlerSubset.ButlerDataRef.subLevels (   self) 
Return a list of the lower levels of the hierarchy than this
ButlerDataRef.

@returns (iterable)  list of strings with level keys.

Definition at line 203 of file butlerSubset.py.

203 
204  def subLevels(self):
205  """
206  Return a list of the lower levels of the hierarchy than this
207  ButlerDataRef.
208 
209  @returns (iterable) list of strings with level keys."""
210 
211  return set(
212  self.butlerSubset.butler.getKeys(
213  self.butlerSubset.datasetType).keys()
214  ) - set(
215  self.butlerSubset.butler.getKeys(
216  self.butlerSubset.datasetType,
217  self.butlerSubset.level).keys()
218  )

Member Data Documentation

lsst.daf.persistence.butlerSubset.ButlerDataRef.butlerSubset

Definition at line 168 of file butlerSubset.py.

lsst.daf.persistence.butlerSubset.ButlerDataRef.dataId

Definition at line 169 of file butlerSubset.py.

The documentation for this class was generated from the following file:
Generated on Thu Sep 24 2015 02:29:35 for LSSTApplications by   doxygen 1.8.5