Focal plane visualizer and detector file generator

[yusuke-takase]

I often want to know information about the detector by specifying the FPU's location.
Furthermore, I thought it would be even better if I could create a file with a list of detectors from the visual information, assuming an e2e simulation.
So, I would like to propose this functionality in litebird_sim.

I made plot_fp.py which can be executed by

python -m litebird_sim.plot_fp

Then, this kind of conversation will be happened:

Available IMO versions: ['(1). v2']
Input IMO version's number: 
1
Input telescope's number: ['(1). LFT', '(2). MFT', '(3). HFT']
1
The availavle channels are: ['(1). L1-040', '(2). L2-050', '(3). L1-060', '(4). L3-068', '(5). L2-068', '(6). L4-078', '(7). L1-078', '(8). L3-089', '(9). L2-089', '(10). L4-100', '(11). 
L3-119', '(12). L4-140']
Input the channel's number:
1
Do you want to make a detector list file? (y/n) 
y
Create a detector list file.
Input mission duration to define a scaling factor for NET (unit: yr):
1
Specify the directory to save:
./
Click is available...
The detectors_LFT_L1-040_T+B.txt is generated.
Location: ./detectors_LFT_L1-040_T+B.txt

During this conversation, the function loads IMO which is installed in the local machine, and the FPU which is specified in the conversation will be visualized like this:

By the clicking, the DetectorInfo is shown in right in real time.
Furthermore, detectors that were clicked and ‘starred’ when the plot was closed are saved to a file with the following content:

# Telescope     Channel         IMO_NET         Number_det      Scaled_NET      Detector_name
LFT		L1-040		114.63		6/48		23.4		000_003_004_UA_040_B
LFT		L1-040		114.63		6/48		23.4		000_003_004_UA_040_T
LFT		L1-040		114.63		6/48		23.4		000_003_005_QB_040_B
LFT		L1-040		114.63		6/48		23.4		000_003_005_QB_040_T

It will be the input of the e2e simulation and I hope it is useful for everyone.
How do you guys think this functionality?

[ziotom78]

Hi @yusuke-takase , very lovely, I like it! For me, it is a nice feature. If there are no objections, we can merge it. I would suggest a few things:

• Apart from the usual entry in the CHANGELOG, I think this deserves a mention in the README
• Add a reference to this feature in the documentation. (However, perhaps it is better to wait for Reorganize the User’s manual #342 to be approved and then merge master in this branch before modifying the docs.)

[yusuke-takase]

Thanks a lot, @ziotom78 !
I added info to CHANGELOG though I don't have an imagination about the section in README, do you have any examples?

Add a reference to this feature in the documentation.

I agree with this, and I can do it after #342 merged. Maybe it will be almost same description what we will write in README.

[ziotom78]

I added info to CHANGELOG though I don't have an imagination about the section in README, do you have any examples?

Maybe you could add a short sub-section under the " Usage " section, where you put the description and image you posted in the topmost comment here. (Adding an image is an effective way to advertise things!)

[ziotom78]

Hi @yusuke-takase , #342 has been merged in master. 🥳

[yusuke-takase]

Thanks, @ziotom78
I made this gif animation. I'm not 100% sure though maybe it can be called from README by indicating this place's URL.
Let me try it.

[yusuke-takase]

Hi @ziotom78 ,
I think I could have completed the work. In my local environment, rendering by sphinx is seemed working.