@@ -312,29 +312,31 @@ def get_field_names(self, structure):
312
312
return None
313
313
314
314
def orig_field (self , structure , client_name ):
315
- """Get original field name as provided in Data Release .
315
+ """Get original field name as provided in Data Set .
316
316
317
- :param structure: Name of data set Structure
317
+ :param structure: Name of Data Set
318
318
:param client_name: Field name used in Client methods.
319
319
:returns: Original field name
320
320
:rtype: string
321
321
322
322
Example:
323
323
>>> client.orig_field('BOSS-DR16', 'flux')
324
+ 'spectra.coadd.FLUX'
324
325
325
326
"""
326
327
return self .new2origLUT [structure ][client_name ]
327
328
328
329
def client_field (self , structure , orig_name ):
329
330
"""Get field name used in Client methods
330
331
331
- :param structure: Name of data set Structure
332
- :param orig_name: Original field name as provided in Data Release .
332
+ :param structure: Name of Data Set
333
+ :param orig_name: Original field name as provided in Data Set .
333
334
:returns: Client field name
334
335
:rtype: string
335
336
336
337
Example:
337
- >>> client.orig_field('BOSS-DR16', 'spectra.coadd.FLUX')
338
+ >>> client.client_field('BOSS-DR16', 'spectra.coadd.FLUX')
339
+ 'flux'
338
340
339
341
"""
340
342
return self .orig2newLUT [structure ][orig_name ]
@@ -472,7 +474,7 @@ def retrieve(self,
472
474
List of paths to include in each record. (default: 'DEFAULT')
473
475
rtype (str, optional): Data-type to use for spectra data. One of:
474
476
json, numpy, pandas, spectrum1d. (default: None)
475
- structure (str): The data structure (DS) name associated with
477
+ structure (str): The Data Set (DS) name associated with
476
478
the specids. Or None to retrieve from any DS that contains the
477
479
specid. (default: None)
478
480
verbose (boolean, optional): (default: False)
0 commit comments