lsst.obs.base  20.0.0-45-g887e66a+da5ba8225b
fitsGeneric.py
Go to the documentation of this file.
1 # This file is part of obs_base.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (http://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 
22 __all__ = ("FitsGenericFormatter", )
23 
24 import os.path
25 
26 from lsst.daf.butler.formatters.file import FileFormatter
27 
28 
29 class FitsGenericFormatter(FileFormatter):
30  """Interface for reading and writing objects that support the standard
31  afw I/O readFits/writeFits methods.
32  """
33  supportedExtensions = frozenset({".fits", ".fits.gz", ".fits.fz", ".fz", ".fit"})
34  extension = ".fits"
35 
36  def _readFile(self, path, pytype):
37  """Read a file from the path in FITS format.
38 
39  Parameters
40  ----------
41  path : `str`
42  Path to use to open the file.
43  pytype : `class`
44  Class to use to read the FITS file.
45 
46  Returns
47  -------
48  data : `object`
49  Instance of class `pytype` read from FITS file. None
50  if the file could not be opened.
51  """
52  if not os.path.exists(path):
53  return None
54 
55  return pytype.readFits(path)
56 
57  def _writeFile(self, inMemoryDataset):
58  """Write the in memory dataset to file on disk.
59 
60  Parameters
61  ----------
62  inMemoryDataset : `object`
63  Object to serialize.
64 
65  Raises
66  ------
67  Exception
68  The file could not be written.
69  """
70  inMemoryDataset.writeFits(self.fileDescriptor.location.path)
lsst.obs.base.formatters.fitsGeneric.FitsGenericFormatter
Definition: fitsGeneric.py:29