Commit 2370d206 authored by Fang Yuedong's avatar Fang Yuedong
Browse files

update README and Catalog_example.py

parent ceae9b8a
Pipeline #4561 passed with stage
in 0 seconds
# CSST主巡天仿真软件 # CSST主巡天仿真软件
## 重要更新或问题修复: ## 重要更新或问题修复:
* v3.0版本相关内容:(待补充) * 2024.05.15: 更新至v3.0版本,新功能具体内容见[软件说明文档](https://kdocs.cn/l/cjyiU0SXGyn2)
* 2023.07.29: 更新至v2.1版本,内容包括: * 2023.07.29: 更新至v2.1版本,内容包括:
* 加入杂散光模块,config文件中添加开关:enable_straylight_model: True/False * 加入杂散光模块,config文件中添加开关:enable_straylight_model: True/False
* 调整WCS定义:x:E, y:-N * 调整WCS定义:x:E, y:-N
...@@ -32,11 +32,19 @@ ...@@ -32,11 +32,19 @@
## 相关数据 ## 相关数据
* PSF采样数据下载:[百度云盘](https://pan.baidu.com/s/1_2gbO6-d7x001_FMqZ1tfw),提取码:2awt <!-- * PSF采样数据下载:[百度云盘](https://pan.baidu.com/s/1_2gbO6-d7x001_FMqZ1tfw),提取码:2awt
* 测试用数据,C6星系SED PCA主成分,及恒星SED模板库下载:[百度云盘](https://pan.baidu.com/s/15B5H-r39vbIBIXdpin63Wg),提取码:nxsy * 测试用数据,C6星系SED PCA主成分,及恒星SED模板库下载:[百度云盘](https://pan.baidu.com/s/15B5H-r39vbIBIXdpin63Wg),提取码:nxsy
* 滤光片及无缝光谱相关数据:[百度云盘](https://pan.baidu.com/s/1JROggg8IKf27i1DnwTaPAw),提取码:07v5 * 滤光片及无缝光谱相关数据:[百度云盘](https://pan.baidu.com/s/1JROggg8IKf27i1DnwTaPAw),提取码:07v5 -->
* 数据链接:https://pan.baidu.com/s/1cVHovDs4cMsDWWNkoZDRDA?pwd=y63x
* PSF数据库:
* 多色成像: CSSTSim_C9/PSFCube/set1_dynamic
* 无缝光谱: CSSTSim_C9/PSFCube/SLS_PSF_PCA_fp
* C9星表数据:
* 恒星星表:CSSTSim_C9/starcat_C9
* 星系星表:CSSTSim_C9/galaxycat_C9/cat2CSSTSim_bundle-50sqDeg
* 类星体星表:CSSTSim_C9/galaxycat_C9/qsosed
## 相关会议及workshop ## 相关会议及workshop
......
...@@ -23,7 +23,7 @@ class Catalog(CatalogBase): ...@@ -23,7 +23,7 @@ class Catalog(CatalogBase):
star_SED_path : str star_SED_path : str
path to the star SED data path to the star SED data
objs : list objs : list
a list of ObservationSim.MockObject (Star, Galaxy, or Quasar) a list of observation_sim.mock_objects (Star, Galaxy, or Quasar)
NOTE: must have "obj" list when implement your own Catalog NOTE: must have "obj" list when implement your own Catalog
Methods Methods
...@@ -41,10 +41,10 @@ class Catalog(CatalogBase): ...@@ -41,10 +41,10 @@ class Catalog(CatalogBase):
---------- ----------
config : dict config : dict
configuration dictionary which is parsed from the input YAML file configuration dictionary which is parsed from the input YAML file
chip: ObservationSim.Instrument.Chip chip: observation_sim.instruments.Chip
an ObservationSim.Instrument.Chip instance, can be used to identify the band etc. an observation_sim.instruments.Chip instance, can be used to identify the band etc.
**kwargs : dict **kwargs : dict
other needed input parameters (in key-value pairs), please modify corresponding any other needed input parameters (in key-value pairs), please modify corresponding
initialization call in "ObservationSim.py" as you need. initialization call in "ObservationSim.py" as you need.
Returns Returns
...@@ -70,10 +70,10 @@ class Catalog(CatalogBase): ...@@ -70,10 +70,10 @@ class Catalog(CatalogBase):
"""Read in all objects in from the catalog file(s). """Read in all objects in from the catalog file(s).
This is a must implemented method which is used to read in all objects, and This is a must implemented method which is used to read in all objects, and
then convert them to ObservationSim.MockObject (Star, Galaxy, or Quasar). then convert them to observation_sim.mock_objects (Star, Galaxy, or Quasar).
Currently, Currently,
the model of ObservationSim.MockObject.Star class requires: the model of observation_sim.mock_objects.Star class requires:
param["star"] : int param["star"] : int
specify the object type: 0: galaxy, 1: star, 2: quasar specify the object type: 0: galaxy, 1: star, 2: quasar
param["id"] : int param["id"] : int
...@@ -88,7 +88,7 @@ class Catalog(CatalogBase): ...@@ -88,7 +88,7 @@ class Catalog(CatalogBase):
load_norm_filt(obj) function must be implemented to load the filter load_norm_filt(obj) function must be implemented to load the filter
throughput of that particular photometric system throughput of that particular photometric system
the model of ObservationSim.MockObject.Galaxy class requires: the model of observation_sim.mock_objects.Galaxy class requires:
param["star"] : int param["star"] : int
specify the object type: 0: galaxy, 1: star, 2: quasar specify the object type: 0: galaxy, 1: star, 2: quasar
param["id"] : int param["id"] : int
...@@ -119,7 +119,7 @@ class Catalog(CatalogBase): ...@@ -119,7 +119,7 @@ class Catalog(CatalogBase):
Sersic index for galaxy bulge component Sersic index for galaxy bulge component
param['g1'], param['g2']: float param['g1'], param['g2']: float
Reduced weak lensing shear components (valid for shear type: catalog) Reduced weak lensing shear components (valid for shear type: catalog)
the model of ObservationSim.MockObject.Galaxy class requires: the model of observation_sim.mock_objects.Galaxy class requires:
Currently a Quasar is modeled as a point source, just like a Star. Currently a Quasar is modeled as a point source, just like a Star.
NOTE: To construct an object, according to its type, just call: NOTE: To construct an object, according to its type, just call:
...@@ -133,7 +133,7 @@ class Catalog(CatalogBase): ...@@ -133,7 +133,7 @@ class Catalog(CatalogBase):
Parameters Parameters
---------- ----------
**kwargs : dict **kwargs : dict
other needed input parameters (in key-value pairs), please modify corresponding any other needed input parameters (in key-value pairs), please modify corresponding
initialization call in "ObservationSim.py" as you need. initialization call in "ObservationSim.py" as you need.
Returns Returns
...@@ -161,7 +161,7 @@ class Catalog(CatalogBase): ...@@ -161,7 +161,7 @@ class Catalog(CatalogBase):
Parameters Parameters
---------- ----------
obj : ObservationSim.MockObject obj : instance of a particular class in observation_sim.mock_objects
the object to get SED data for the object to get SED data for
**kwargs : dict **kwargs : dict
other needed input parameters (in key-value pairs), please modify corresponding other needed input parameters (in key-value pairs), please modify corresponding
...@@ -198,7 +198,7 @@ class Catalog(CatalogBase): ...@@ -198,7 +198,7 @@ class Catalog(CatalogBase):
Parameters Parameters
---------- ----------
obj : ObservationSim.MockObject obj : instance of a particular class in observation_sim.mock_objects
the object to get thourghput data for the object to get thourghput data for
Returns Returns
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment