added some docstring (874cfe5f) · Commits · Bo Zhang / csst

csst/core/data.py

+15 −3

Original line number	Diff line number	Diff line
		@@ -20,9 +20,21 @@ class CsstData:
		_l2data = OrderedDict() #
		_auxdata = OrderedDict()

		def __init__(self, primaryHDU, imgHDU, instrument=None, detector=None):
		# print('create CsstData')
		self._primary_hdu = primaryHDU
		def __init__(self, priHDU, imgHDU, instrument=None, detector=None):
		"""

		Parameters
		----------
		priHDU:
		primary HDU
		imgHDU:
		image HDU
		instrument:
		instrument
		detector:
		detector
		"""
		self._primary_hdu = priHDU
		self._l0data = imgHDU
		self.instrument = instrument
		self.detector = detector

csst/core/processor.py

+1 −1

Original line number	Diff line number	Diff line
		@@ -17,7 +17,7 @@ class CsstProcStatus(Enum):
		class CsstProcessor(metaclass=ABCMeta):

		def __init__(self, **kwargs):
		pass
		self._status = CsstProcStatus()

		@abstractmethod
		def prepare(self, **kwargs):

csst/msc/data.py

+22 −1

Original line number	Diff line number	Diff line
		@@ -35,34 +35,44 @@ class CsstMscData(CsstData):
		self._auxdata['flat'] = flat

		def set_bias(self, biasimg):
		""" set bias """
		self._auxdata['bias'] = biasimg

		def set_dark(self, darkimg):
		""" set dark """
		self._auxdata['dark'] = darkimg

		def set_badpixel(self, badpixelimg):
		""" set badpixel """
		self._auxdata['badpixel'] = badpixelimg

		def get_flat(self):
		""" get flat """
		return self._auxdata['flat']

		def get_bias(self):
		""" get bias """
		return self._auxdata['bias']

		def get_dark(self):
		""" get dark """
		return self._auxdata['dark']

		def get_badpixel(self):
		""" get badpixel """
		return self._auxdata['badpixel']

		def init_l0data(self):
		""" initialize L0 data """
		pass

		def set_l1keyword(self, key, value, comment=''):
		""" set L1 keyword """
		print('check out whether ' + key + " is a valid key and " + value + " is valid value")
		self._l1hdr_global.set(key, value, comment)

		def set_l1data(self, imgtype, img):
		""" set L1 data """
		try:
		if self._l1img_types[imgtype]:
		self._l1data[imgtype].data = img.copy()
		@@ -71,6 +81,7 @@ class CsstMscData(CsstData):
		print('save image data to l1data')

		def save_l1data(self, imgtype, filename):
		""" save L1 data """
		print('check ' + imgtype + ' is validate')
		try:
		if self._l1img_types[imgtype]:
		@@ -89,7 +100,7 @@ class CsstMscImgData(CsstMscData):

		@staticmethod
		def read(fp):
		""" read from fits file
		""" read data from fits file

		Parameters
		----------
		@@ -100,6 +111,16 @@ class CsstMscImgData(CsstMscData):
		-------
		CsstMscImgData

		Example
		-------

		>>> fp = "MSC_MS_210527171000_100000279_16_raw.fits"
		>>> from csst.msc import CsstMscImgData
		>>> data = CsstMscImgData.read(fp)
		>>> # print some info
		>>> print("data: ", data)
		>>> print("instrument: ", data.get_l0keyword("pri", "INSTRUME"))
		>>> print("object: ", data.get_l0keyword("pri", "OBJECT"))
		"""

		try: